docs/classes/management.SDK.FormsClient.html
new FormsClient(options: BaseClientOptions): FormsClient
list(
request?: ListFormsRequestParameters,
requestOptions?: FormsClient.RequestOptions,
): Promise<Page<FormSummary, ListFormsOffsetPaginatedResponseContent>>
OptionalrequestOptions: FormsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.forms.list({ page: 1, per_page: 1, include_totals: true, hydrate: ["flow_count"] })Copy
create(
request: CreateFormRequestContent,
requestOptions?: FormsClient.RequestOptions,
): HttpResponsePromise<CreateFormResponseContent>
OptionalrequestOptions: FormsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.forms.create({ name: "name" })Copy
get(
id: string,
request?: GetFormRequestParameters,
requestOptions?: FormsClient.RequestOptions,
): HttpResponsePromise<GetFormResponseContent>
The ID of the form to retrieve.
OptionalrequestOptions: FormsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.forms.get("id", { hydrate: ["flow_count"] })Copy
delete(
id: string,
requestOptions?: FormsClient.RequestOptions,
): HttpResponsePromise<void>
The ID of the form to delete.
OptionalrequestOptions: FormsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.forms.delete("id")Copy
update(
id: string,
request?: UpdateFormRequestContent,
requestOptions?: FormsClient.RequestOptions,
): HttpResponsePromise<UpdateFormResponseContent>
The ID of the form to update.
OptionalrequestOptions: FormsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.forms.update("id")Copy
Protected Readonly_options_options: NormalizedClientOptionsWithAuth<BaseClientOptions>
Member Visibility
ThemeOSLightDark
Constructors constructor Methods listcreategetdeleteupdate Properties _options