Class ExtractApi

Index

Constructors

Methods

doAsync doAsyncWithHttpInfo getAsyncStatus getAsyncStatusWithHttpInfo

Constructors

constructor

new ExtractApi(configuration, requestFactory?, responseProcessor?): ExtractApi
Parameters
- configuration: Configuration<ObservableMiddleware>
- OptionalrequestFactory: ExtractApiRequestFactory
- OptionalresponseProcessor: ExtractApiResponseProcessor
Returns ExtractApi
- Defined in codegen/cms/source_code/types/PromiseAPI.ts:222

Methods

doAsync

doAsync(fileExtractRequest, _options?): Promise<TaskLocator>
Extract a zip file in the developer file system. Extraction status can be checked with the /extract/async/tasks/taskId/status endpoint below. Extract a zip file
Parameters
- fileExtractRequest: FileExtractRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<TaskLocator>
- Defined in codegen/cms/source_code/types/PromiseAPI.ts:257

doAsyncWithHttpInfo

doAsyncWithHttpInfo(fileExtractRequest, _options?): Promise<HttpInfo<TaskLocator>>
Extract a zip file in the developer file system. Extraction status can be checked with the /extract/async/tasks/taskId/status endpoint below. Extract a zip file
Parameters
- fileExtractRequest: FileExtractRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<TaskLocator>>
- Defined in codegen/cms/source_code/types/PromiseAPI.ts:235

getAsyncStatus

getAsyncStatus(taskId, _options?): Promise<ActionResponse>
Get the status of an extraction by the taskId returned from the initial extract/async request. Get extraction status
Parameters
- taskId: number
  The extraction task ID returned by the initial `extract/async` request.
- Optional_options: PromiseConfigurationOptions
Returns Promise<ActionResponse>
- Defined in codegen/cms/source_code/types/PromiseAPI.ts:301

getAsyncStatusWithHttpInfo

getAsyncStatusWithHttpInfo(taskId, _options?): Promise<HttpInfo<ActionResponse>>
Get the status of an extraction by the taskId returned from the initial extract/async request. Get extraction status
Parameters
- taskId: number
  The extraction task ID returned by the initial `extract/async` request.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<ActionResponse>>
- Defined in codegen/cms/source_code/types/PromiseAPI.ts:279