FormsManager

Index

Constructors

constructor

new FormsManager(configuration): FormsManager
Parameters
- configuration: Configuration
Returns FormsManager
Inherited from BaseAPI.constructor
- Defined in src/lib/runtime.ts:24

Properties

`Protected` configuration

configuration: Configuration

Methods

create

create(bodyParameters, initOverrides?): Promise<ApiResponse<PostForms201Response>>
Create a form

Throws
Parameters
- bodyParameters: PostFormsRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<PostForms201Response>>
- Defined in src/management/__generated/managers/forms-manager.ts:162

delete

delete(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Delete a form

Throws
Parameters
- requestParameters: DeleteFormsByIdRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<void>>
- Defined in src/management/__generated/managers/forms-manager.ts:27

get

get(requestParameters, initOverrides?): Promise<ApiResponse<PostForms201Response>>
Get a form

Throws
Parameters
- requestParameters: GetFormsByIdRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<PostForms201Response>>
- Defined in src/management/__generated/managers/forms-manager.ts:100

getAll

getAll(requestParameters, initOverrides?): Promise<ApiResponse<GetForms200ResponseOneOf>>
Get forms

Throws
Parameters
- requestParameters: GetFormsRequest & {
  include_totals: true;
  }
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<GetForms200ResponseOneOf>>
- Defined in src/management/__generated/managers/forms-manager.ts:49
getAll(requestParameters?, initOverrides?): Promise<ApiResponse<GetForms200ResponseOneOfInner[]>>
Parameters
- Optional requestParameters: GetFormsRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<GetForms200ResponseOneOfInner[]>>
- Defined in src/management/__generated/managers/forms-manager.ts:53

`Protected` request

request(context, initOverrides?): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in src/lib/runtime.ts:40

update

update(requestParameters, bodyParameters, initOverrides?): Promise<ApiResponse<PostForms201Response>>
Update a form

Throws
Parameters
- requestParameters: PatchFormsByIdOperationRequest
- bodyParameters: PatchFormsByIdRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<PostForms201Response>>
- Defined in src/management/__generated/managers/forms-manager.ts:133

Class FormsManager

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration

Returns FormsManager

Properties

Protected configuration

Methods

create

Throws

Parameters

bodyParameters: PostFormsRequest

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<PostForms201Response>>

delete

Throws

Parameters

requestParameters: DeleteFormsByIdRequest

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<void>>

get

Throws

Parameters

requestParameters: GetFormsByIdRequest

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<PostForms201Response>>

getAll

Throws

Parameters

requestParameters: GetFormsRequest & { include_totals: true; }

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<GetForms200ResponseOneOf>>

Parameters

Optional requestParameters: GetFormsRequest

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<GetForms200ResponseOneOfInner[]>>

Protected request

Parameters

context: RequestOpts

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<Response>

update

Throws

Parameters

requestParameters: PatchFormsByIdOperationRequest

bodyParameters: PatchFormsByIdRequest

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<PostForms201Response>>

Settings

Member Visibility

Theme

On This Page

`Protected` configuration

`Optional` initOverrides: InitOverride

`Optional` initOverrides: InitOverride

`Optional` initOverrides: InitOverride

requestParameters: GetFormsRequest & {
include_totals: true;
}

`Optional` initOverrides: InitOverride

`Optional` requestParameters: GetFormsRequest

`Optional` initOverrides: InitOverride

`Protected` request

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: InitOverride