Class PropertiesTableTemplateApi

Hierarchy

BaseAPI
- PropertiesTableTemplateApi

Index

Constructors

Properties

Methods

createTableTemplate createTableTemplateRaw deleteTableTemplate deleteTableTemplateRaw getByCompanyId getByCompanyIdRaw getByDocumentId getByDocumentIdRaw getTableTemplate getTableTemplateRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new PropertiesTableTemplateApi(configuration?: Configuration): PropertiesTableTemplateApi
Parameters
- configuration: Configuration = DefaultConfig
Returns PropertiesTableTemplateApi
Inherited from BaseAPI.constructor
- Defined in runtime.ts:96

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

createTableTemplate

createTableTemplate(requestParameters: CreateTableTemplateRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTPropertiesTableTemplateInfo>
Create a new properties table template.
Parameters
- requestParameters: CreateTableTemplateRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTPropertiesTableTemplateInfo>
- Defined in apis/PropertiesTableTemplateApi.ts:103

createTableTemplateRaw

createTableTemplateRaw(requestParameters: CreateTableTemplateRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTPropertiesTableTemplateInfo>>
Create a new properties table template.
Parameters
- requestParameters: CreateTableTemplateRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTPropertiesTableTemplateInfo>>
- Defined in apis/PropertiesTableTemplateApi.ts:66

deleteTableTemplate

deleteTableTemplate(requestParameters: DeleteTableTemplateRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Delete a properties table template by template ID.
Parameters
- requestParameters: DeleteTableTemplateRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/PropertiesTableTemplateApi.ts:141

deleteTableTemplateRaw

deleteTableTemplateRaw(requestParameters: DeleteTableTemplateRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Delete a properties table template by template ID.
Parameters
- requestParameters: DeleteTableTemplateRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/PropertiesTableTemplateApi.ts:111

getByCompanyId

getByCompanyId(requestParameters: GetByCompanyIdRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTPropertiesTableTemplateInfo[]>
Retrieve the properties table templates by company ID.
Parameters
- requestParameters: GetByCompanyIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTPropertiesTableTemplateInfo[]>
- Defined in apis/PropertiesTableTemplateApi.ts:191

getByCompanyIdRaw

getByCompanyIdRaw(requestParameters: GetByCompanyIdRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTPropertiesTableTemplateInfo[]>>
Retrieve the properties table templates by company ID.
Parameters
- requestParameters: GetByCompanyIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTPropertiesTableTemplateInfo[]>>
- Defined in apis/PropertiesTableTemplateApi.ts:149

getByDocumentId

getByDocumentId(requestParameters: GetByDocumentIdRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTPropertiesTableTemplateInfo[]>
Retrieve the properties table templates by document ID.
Parameters
- requestParameters: GetByDocumentIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTPropertiesTableTemplateInfo[]>
- Defined in apis/PropertiesTableTemplateApi.ts:241

getByDocumentIdRaw

getByDocumentIdRaw(requestParameters: GetByDocumentIdRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTPropertiesTableTemplateInfo[]>>
Retrieve the properties table templates by document ID.
Parameters
- requestParameters: GetByDocumentIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTPropertiesTableTemplateInfo[]>>
- Defined in apis/PropertiesTableTemplateApi.ts:199

getTableTemplate

getTableTemplate(requestParameters: GetTableTemplateRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTPropertiesTableTemplateInfo>
Retrieve a properties table template by template ID.
Parameters
- requestParameters: GetTableTemplateRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTPropertiesTableTemplateInfo>
- Defined in apis/PropertiesTableTemplateApi.ts:279

getTableTemplateRaw

getTableTemplateRaw(requestParameters: GetTableTemplateRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTPropertiesTableTemplateInfo>>
Retrieve a properties table template by template ID.
Parameters
- requestParameters: GetTableTemplateRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTPropertiesTableTemplateInfo>>
- Defined in apis/PropertiesTableTemplateApi.ts:249

`Protected` request

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

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in runtime.ts:100

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in runtime.ts:111

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in runtime.ts:106

Class PropertiesTableTemplateApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = DefaultConfig

Returns PropertiesTableTemplateApi

Properties

Protected configuration

Methods

createTableTemplate

Parameters

requestParameters: CreateTableTemplateRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTPropertiesTableTemplateInfo>

createTableTemplateRaw

Parameters

requestParameters: CreateTableTemplateRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTPropertiesTableTemplateInfo>>

deleteTableTemplate

Parameters

requestParameters: DeleteTableTemplateRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<object>

deleteTableTemplateRaw

Parameters

requestParameters: DeleteTableTemplateRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<object>>

getByCompanyId

Parameters

requestParameters: GetByCompanyIdRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTPropertiesTableTemplateInfo[]>

getByCompanyIdRaw

Parameters

requestParameters: GetByCompanyIdRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTPropertiesTableTemplateInfo[]>>

getByDocumentId

Parameters

requestParameters: GetByDocumentIdRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTPropertiesTableTemplateInfo[]>

getByDocumentIdRaw

Parameters

requestParameters: GetByDocumentIdRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTPropertiesTableTemplateInfo[]>>

getTableTemplate

Parameters

requestParameters: GetTableTemplateRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTPropertiesTableTemplateInfo>

getTableTemplateRaw

Parameters

requestParameters: GetTableTemplateRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTPropertiesTableTemplateInfo>>

Protected request

Parameters

context: RequestOpts

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<Response>

withMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

Rest ...middlewares: Middleware[]

Returns T

withPostMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

`Protected` configuration

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Protected` request

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Rest` ...middlewares: Middleware[]

`Rest` ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

`Rest` ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]