Class FormsClient

Index

Constructors

constructor

new FormsClient(options: BaseClientOptions): FormsClient
Parameters
- options: BaseClientOptions
Returns FormsClient

Methods

list

list(
request?: ListFormsRequestParameters,
requestOptions?: FormsClient.RequestOptions,
): Promise<Page<FormSummary, ListFormsOffsetPaginatedResponseContent>>
Parameters
- request: ListFormsRequestParameters = {}
- OptionalrequestOptions: FormsClient.RequestOptions
  Request-specific configuration.
Returns Promise<Page<FormSummary, ListFormsOffsetPaginatedResponseContent>>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.forms.list({
        page: 1,
        per_page: 1,
        include_totals: true,
        hydrate: ["flow_count"]
    })
```

create

create(
request: CreateFormRequestContent,
requestOptions?: FormsClient.RequestOptions,
): HttpResponsePromise<CreateFormResponseContent>
Parameters
- request: CreateFormRequestContent
- OptionalrequestOptions: FormsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<CreateFormResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.forms.create({
        name: "name"
    })
```

get

get(
    id: string,
    request?: GetFormRequestParameters,
    requestOptions?: FormsClient.RequestOptions,
): HttpResponsePromise<GetFormResponseContent>
Parameters
- id: string
  The ID of the form to retrieve.
- request: GetFormRequestParameters = {}
- OptionalrequestOptions: FormsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetFormResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.forms.get("id", {
        hydrate: ["flow_count"]
    })
```

delete

delete(
id: string,
requestOptions?: FormsClient.RequestOptions,
): HttpResponsePromise<void>
Parameters
- id: string
  The ID of the form to delete.
- OptionalrequestOptions: FormsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.forms.delete("id")
```

update

update(
    id: string,
    request?: UpdateFormRequestContent,
    requestOptions?: FormsClient.RequestOptions,
): HttpResponsePromise<UpdateFormResponseContent>
Parameters
- id: string
  The ID of the form to update.
- request: UpdateFormRequestContent = {}
- OptionalrequestOptions: FormsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<UpdateFormResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.forms.update("id")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Class FormsClient

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns FormsClient

Methods

list

Parameters

Returns Promise<Page<FormSummary, ListFormsOffsetPaginatedResponseContent>>

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateFormResponseContent>

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetFormResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateFormResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

Properties

Protected Readonly_options

Settings

On This Page

`Protected` `Readonly`_options