Class PublicExportsApi

Index

Constructors

Methods

getStatus getStatusWithHttpInfo start startWithHttpInfo

Constructors

constructor

new PublicExportsApi(configuration, requestFactory?, responseProcessor?): PublicExportsApi
Parameters
- configuration: Configuration<ObservableMiddleware>
- OptionalrequestFactory: PublicExportsApiRequestFactory
- OptionalresponseProcessor: PublicExportsApiResponseProcessor
Returns PublicExportsApi
- Defined in codegen/crm/exports/types/PromiseAPI.ts:14

Methods

getStatus

getStatus(taskId, _options?): Promise<ActionResponseWithSingleResultURI>
Returns the status of the export with taskId, including the URL of the resulting file if the export status is COMPLETE Get the status of the export including the URL to download the file
Parameters
- taskId: number
- Optional_options: PromiseConfigurationOptions
Returns Promise<ActionResponseWithSingleResultURI>
- Defined in codegen/crm/exports/types/PromiseAPI.ts:49

getStatusWithHttpInfo

getStatusWithHttpInfo(taskId, _options?): Promise<HttpInfo<ActionResponseWithSingleResultURI>>
Returns the status of the export with taskId, including the URL of the resulting file if the export status is COMPLETE Get the status of the export including the URL to download the file
Parameters
- taskId: number
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<ActionResponseWithSingleResultURI>>
- Defined in codegen/crm/exports/types/PromiseAPI.ts:27

start

start(publicExportRequest, _options?): Promise<TaskLocator>
Begins exporting CRM data for the portal as specified in the request body Start an export
Parameters
- publicExportRequest: PublicExportRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<TaskLocator>
- Defined in codegen/crm/exports/types/PromiseAPI.ts:93

startWithHttpInfo

startWithHttpInfo(publicExportRequest, _options?): Promise<HttpInfo<TaskLocator>>
Begins exporting CRM data for the portal as specified in the request body Start an export
Parameters
- publicExportRequest: PublicExportRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<TaskLocator>>
- Defined in codegen/crm/exports/types/PromiseAPI.ts:71