Class SceneAlterationsApi

SceneAlterationsApi - object-oriented interface

export

Hierarchy

BaseAPI
- SceneAlterationsApi

Index

Constructors

constructor

Methods

Constructors

constructor

new SceneAlterationsApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): SceneAlterationsApi

Inherited from BaseAPI.constructor
- Defined in base.ts:51
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns SceneAlterationsApi

Methods

createSceneAlteration

createSceneAlteration(requestParameters: SceneAlterationsApiCreateSceneAlterationRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<QueuedJob, any>>

- Defined in api.ts:12748
Create a scene-alteration for a scene-view.

throws
{RequiredError}

memberof
SceneAlterationsApi

Parameters
- requestParameters: SceneAlterationsApiCreateSceneAlterationRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<QueuedJob, any>>

getQueuedSceneAlteration

getQueuedSceneAlteration(requestParameters: SceneAlterationsApiGetQueuedSceneAlterationRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<QueuedJob, any>>

- Defined in api.ts:12768
Get a queued-scene-alteration by ID.

throws
{RequiredError}

memberof
SceneAlterationsApi

Parameters
- requestParameters: SceneAlterationsApiGetQueuedSceneAlterationRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<QueuedJob, any>>

getSceneAlteration

getSceneAlteration(requestParameters: SceneAlterationsApiGetSceneAlterationRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<SceneAlteration, any>>

- Defined in api.ts:12784
Get a scene-alteration by ID.

throws
{RequiredError}

memberof
SceneAlterationsApi

Parameters
- requestParameters: SceneAlterationsApiGetSceneAlterationRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<SceneAlteration, any>>

getSceneAlterations

getSceneAlterations(requestParameters: SceneAlterationsApiGetSceneAlterationsRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<SceneAlterationList, any>>

- Defined in api.ts:12800
Get scene-alterations for a scene-view.

throws
{RequiredError}

memberof
SceneAlterationsApi

Parameters
- requestParameters: SceneAlterationsApiGetSceneAlterationsRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<SceneAlterationList, any>>