Class VariablesApi

Hierarchy

BaseAPI
- VariablesApi

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

createVariableStudio

createVariableStudio(requestParameters: CreateVariableStudioRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTDocumentElementInfo>
Create a Variable studio Create a variable studio
Parameters
- requestParameters: CreateVariableStudioRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTDocumentElementInfo>
- Defined in apis/VariablesApi.ts:152

createVariableStudioRaw

createVariableStudioRaw(requestParameters: CreateVariableStudioRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTDocumentElementInfo>>
Create a Variable studio Create a variable studio
Parameters
- requestParameters: CreateVariableStudioRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTDocumentElementInfo>>
- Defined in apis/VariablesApi.ts:106

getVariableStudioReferences

getVariableStudioReferences(requestParameters: GetVariableStudioReferencesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTVariableStudioReferenceListInfo>
Get an element's variable studio references Retrieve the variable studio references from an element
Parameters
- requestParameters: GetVariableStudioReferencesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTVariableStudioReferenceListInfo>
- Defined in apis/VariablesApi.ts:208

getVariableStudioReferencesRaw

getVariableStudioReferencesRaw(requestParameters: GetVariableStudioReferencesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTVariableStudioReferenceListInfo>>
Get an element's variable studio references Retrieve the variable studio references from an element
Parameters
- requestParameters: GetVariableStudioReferencesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTVariableStudioReferenceListInfo>>
- Defined in apis/VariablesApi.ts:161

getVariableStudioScope

getVariableStudioScope(requestParameters: GetVariableStudioScopeRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTVariableStudioScopeInfo>
Get the scope of a variable studio Get the scope of a variable studio
Parameters
- requestParameters: GetVariableStudioScopeRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTVariableStudioScopeInfo>
- Defined in apis/VariablesApi.ts:264

getVariableStudioScopeRaw

getVariableStudioScopeRaw(requestParameters: GetVariableStudioScopeRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTVariableStudioScopeInfo>>
Get the scope of a variable studio Get the scope of a variable studio
Parameters
- requestParameters: GetVariableStudioScopeRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTVariableStudioScopeInfo>>
- Defined in apis/VariablesApi.ts:217

getVariables

getVariables(requestParameters: GetVariablesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTVariableTableInfo>
Gets contents of variable tables Retrieve the variables from a variable table
Parameters
- requestParameters: GetVariablesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTVariableTableInfo>
- Defined in apis/VariablesApi.ts:328

getVariablesRaw

getVariablesRaw(requestParameters: GetVariablesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTVariableTableInfo>>
Gets contents of variable tables Retrieve the variables from a variable table
Parameters
- requestParameters: GetVariablesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTVariableTableInfo>>
- Defined in apis/VariablesApi.ts:273

`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

setVariableStudioReferences

setVariableStudioReferences(requestParameters: SetVariableStudioReferencesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Set an element's variable studio references Set the variable studio references for an element
Parameters
- requestParameters: SetVariableStudioReferencesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/VariablesApi.ts:387

setVariableStudioReferencesRaw

setVariableStudioReferencesRaw(requestParameters: SetVariableStudioReferencesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Set an element's variable studio references Set the variable studio references for an element
Parameters
- requestParameters: SetVariableStudioReferencesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/VariablesApi.ts:337

setVariableStudioScope

setVariableStudioScope(requestParameters: SetVariableStudioScopeRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Set the scope of a variable studio Set the scope of a variable studio
Parameters
- requestParameters: SetVariableStudioScopeRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/VariablesApi.ts:446

setVariableStudioScopeRaw

setVariableStudioScopeRaw(requestParameters: SetVariableStudioScopeRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Set the scope of a variable studio Set the scope of a variable studio
Parameters
- requestParameters: SetVariableStudioScopeRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/VariablesApi.ts:396

setVariables

setVariables(requestParameters: SetVariablesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Assign variables to a variable studio Assign variables to a variable studio
Parameters
- requestParameters: SetVariablesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/VariablesApi.ts:505

setVariablesRaw

setVariablesRaw(requestParameters: SetVariablesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Assign variables to a variable studio Assign variables to a variable studio
Parameters
- requestParameters: SetVariablesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/VariablesApi.ts:455

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 VariablesApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = DefaultConfig

Returns VariablesApi

Properties

Protected configuration

Methods

createVariableStudio

Parameters

requestParameters: CreateVariableStudioRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTDocumentElementInfo>

createVariableStudioRaw

Parameters

requestParameters: CreateVariableStudioRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTDocumentElementInfo>>

getVariableStudioReferences

Parameters

requestParameters: GetVariableStudioReferencesRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTVariableStudioReferenceListInfo>

getVariableStudioReferencesRaw

Parameters

requestParameters: GetVariableStudioReferencesRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTVariableStudioReferenceListInfo>>

getVariableStudioScope

Parameters

requestParameters: GetVariableStudioScopeRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTVariableStudioScopeInfo>

getVariableStudioScopeRaw

Parameters

requestParameters: GetVariableStudioScopeRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTVariableStudioScopeInfo>>

getVariables

Parameters

requestParameters: GetVariablesRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTVariableTableInfo>

getVariablesRaw

Parameters

requestParameters: GetVariablesRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTVariableTableInfo>>

Protected request

Parameters

context: RequestOpts

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<Response>

setVariableStudioReferences

Parameters

requestParameters: SetVariableStudioReferencesRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<object>

setVariableStudioReferencesRaw

Parameters

requestParameters: SetVariableStudioReferencesRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<object>>

setVariableStudioScope

Parameters

requestParameters: SetVariableStudioScopeRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<object>

setVariableStudioScopeRaw

Parameters

requestParameters: SetVariableStudioScopeRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<object>>

setVariables

`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

`Protected` request

`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

`Rest` ...middlewares: Middleware[]

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

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