Class Forms

Index

Constructors

constructor

new Forms(_options: Forms.Options): Forms
Parameters
- _options: Forms.Options
Returns Forms

Methods

list

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

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.forms.list()
```

create

create(
request: Management.CreateFormRequestContent,
requestOptions?: Forms.RequestOptions,
): HttpResponsePromise<CreateFormResponseContent>
Parameters
- request: Management.CreateFormRequestContent
- OptionalrequestOptions: Forms.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?: Management.GetFormRequestParameters,
    requestOptions?: Forms.RequestOptions,
): HttpResponsePromise<GetFormResponseContent>
Parameters
- id: string
  The ID of the form to retrieve.
- request: Management.GetFormRequestParameters = {}
- OptionalrequestOptions: Forms.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")
```

delete

delete(
id: string,
requestOptions?: Forms.RequestOptions,
): HttpResponsePromise<void>
Parameters
- id: string
  The ID of the form to delete.
- OptionalrequestOptions: Forms.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?: Management.UpdateFormRequestContent,
    requestOptions?: Forms.RequestOptions,
): HttpResponsePromise<UpdateFormResponseContent>
Parameters
- id: string
  The ID of the form to update.
- request: Management.UpdateFormRequestContent = {}
- OptionalrequestOptions: Forms.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<UpdateFormResponseContent>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

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

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: Forms.Options

Class Forms

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns Forms

Methods

list

Parameters

Returns Promise<Page<FormSummary>>

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

Example

Protected_getAuthorizationHeader

Returns Promise<string>

Properties

Protected Readonly_options

Settings

On This Page

`Protected`_getAuthorizationHeader

`Protected` `Readonly`_options