Class ExportsApi

ExportsApi - object-oriented interface

export

Hierarchy

BaseAPI
- ExportsApi

Index

Constructors

constructor

Methods

Constructors

constructor

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

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

Methods

createExport

createExport(requestParameters: ExportsApiCreateExportRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<QueuedJob, any>>

- Defined in api.ts:8123
Create an export. This API is asynchronous, returning the location of a queued-export. Check the status via the getQueuedExport API.

throws
{RequiredError}

memberof
ExportsApi

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

getExport

getExport(requestParameters: ExportsApiGetExportRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<Export, any>>

- Defined in api.ts:8139
Get an export by ID.

throws
{RequiredError}

memberof
ExportsApi

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

getQueuedExport

getQueuedExport(requestParameters: ExportsApiGetQueuedExportRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<QueuedJob, any>>

- Defined in api.ts:8155
Get a queued-export. The response is either the status if running or error or, upon completion, redirects to the created export.

throws
{RequiredError}

memberof
ExportsApi

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