FormiumClient

class FormiumClient

Formium Client

method deleteSubmit@formium/client

Returns
`Promise<void>`	Delete a Submission

Parameters	Description
`submitId`	`string` The id of the Submission Required
`fetchOptions`	`RequestInit` Additional request options

method deleteSubmits@formium/client

Returns
`Promise<void>`	Delete mulitple Submissions

Parameters	Description
`query`	`DeleteSubmitsQuery` Query parameters Required
`fetchOptions`	`RequestInit` Additional request options

method findForms@formium/client

Returns
`Promise<Results<Form>>`	Return Forms in a project

Parameters	Description
`query`	`FindFormsQuery` Query parameters
`fetchOptions`	`RequestInit` Additional request options

method findSubmits@formium/client

Returns
`Promise<Results<Project>>`	Find Submissions of a given form

Parameters	Description
`query`	`FindSubmitsQuery` Query parameters Required
`fetchOptions`	`RequestInit` Additional request options

method getFormById@formium/client

Returns
`Promise<Form>`	Return a Form given its id

Parameters	Description
`id`	`string` Required
`query`	`GetFormQuery` Query parameters
`fetchOptions`	`RequestInit` Additional request options

method getFormBySlug@formium/client

Returns
`Promise<Form>`	Return a Form based on its slug

Parameters	Description
`formSlug`	`string` form slug Required
`query`	`GetFormQuery` Query parameters
`fetchOptions`	`RequestInit` Additional request options

Returns
`Promise<User>`	Return the current User (based on the token)

Parameters	Description
`fetchOptions`	`RequestInit`

method getMyProjects@formium/client

Returns
`Promise<Results<Project>>`	Retrieve the Projects the user belongs to

Parameters	Description
`fetchOptions`	`RequestInit`

method getProject@formium/client

Returns
`Promise<Project>`	Return a Project by id

Parameters	Description
`id`	`string` Project id Required
`fetchOptions`	`RequestInit` fetch overrides

method getProjectBySlug@formium/client

Returns
`Promise<Project>`	Return a Project by slug

Parameters	Description
`projectSlug`	`string` A Project slug Required
`fetchOptions`	`RequestInit`

method getSubmit@formium/client

Returns
`Promise<Submit>`	Return a Submission

Parameters	Description
`submitId`	`string` The id of the submission Required
`fetchOptions`	`RequestInit` Additional request options

Returns
`Promise<any>`	Delete the current Oauth2 bearer token (for signout)

Parameters	Description
`fetchOptions`	`RequestInit`

method submitForm@formium/client

Returns
`Promise<void>`	Submit data to a Form

Parameters	Description
`formSlug`	`string` Slug of the Form Required
`data`	`SubmitData` An object or FormData instance containing submission data. Required

method uploadFile@formium/client

Returns
`Promise<string \| null>`	Upload a file to Formium. All uploads are private by default.

Parameters	Description
`formSlug`	`string` Slug of the Form Required
`file`	`File` File to be uploaded Required

Build forms, without the tears.