Class BatchesApi

BatchesApi - object-oriented interface

export

Hierarchy

BaseAPI
- BatchesApi

Index

Constructors

constructor

Methods

Constructors

constructor

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

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

Methods

createBatch

createBatch(requestParameters: BatchesApiCreateBatchRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<QueuedJob, any>>

- Defined in api.ts:7715
Create a batch. This API is asynchronous, returning the location of a queued-batch. Check the status via the getQueuedBatch API.

throws
{RequiredError}

memberof
BatchesApi

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

getBatch

getBatch(requestParameters: BatchesApiGetBatchRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<Batch, any>>

- Defined in api.ts:7731
Get a batch by ID.

throws
{RequiredError}

memberof
BatchesApi

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

getQueuedBatch

getQueuedBatch(requestParameters: BatchesApiGetQueuedBatchRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<QueuedJob, any>>

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

throws
{RequiredError}

memberof
BatchesApi

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