Class: ExportControllerApi

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new ExportControllerApi(configuration?)

Parameters

NameType
configurationConfiguration

Inherited from

BaseAPI.constructor

Properties

configuration

Protected configuration: Configuration

Inherited from

BaseAPI.configuration

Methods

exportEntities

exportEntities(requestParameters, initOverrides?): Promise<string>

Export inboxes link callable via browser

Parameters

NameType
requestParametersExportEntitiesRequest
initOverrides?RequestInit

Returns

Promise<string>


exportEntitiesRaw

exportEntitiesRaw(requestParameters, initOverrides?): Promise<ApiResponse<string»

Export inboxes link callable via browser

Parameters

NameType
requestParametersExportEntitiesRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<string»


getExportLink(requestParameters, initOverrides?): Promise<ExportLink>

Get export link

Parameters

NameType
requestParametersGetExportLinkRequest
initOverrides?RequestInit

Returns

Promise<ExportLink>


getExportLinkRaw

getExportLinkRaw(requestParameters, initOverrides?): Promise<ApiResponse<ExportLink»

Get export link

Parameters

NameType
requestParametersGetExportLinkRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<ExportLink»


request

Protected request(context, initOverrides?): Promise<Response>

Parameters

NameType
contextRequestOpts
initOverrides?RequestInit

Returns

Promise<Response>

Inherited from

BaseAPI.request


withMiddleware

withMiddleware<T>(…middlewares): T

Type parameters

NameType
Textends BaseAPI<T>

Parameters

NameType
...middlewaresMiddleware[]

Returns

T

Inherited from

BaseAPI.withMiddleware


withPostMiddleware

withPostMiddleware<T>(…postMiddlewares): T

Type parameters

NameType
Textends BaseAPI<T>

Parameters

NameType
...postMiddlewares(context: ResponseContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPostMiddleware


withPreMiddleware

withPreMiddleware<T>(…preMiddlewares): T

Type parameters

NameType
Textends BaseAPI<T>

Parameters

NameType
...preMiddlewares(context: RequestContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPreMiddleware