Skip to content

Class: ExportControllerApi

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new ExportControllerApi(configuration?)

Parameters

Name Type
configuration Configuration

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

Name Type
requestParameters ExportEntitiesRequest
initOverrides? RequestInit

Returns

Promise<string[]>


exportEntitiesRaw

exportEntitiesRaw(requestParameters, initOverrides?): Promise<ApiResponse<string[]>>

Export inboxes link callable via browser

Parameters

Name Type
requestParameters ExportEntitiesRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<string[]>>


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

Get export link

Parameters

Name Type
requestParameters GetExportLinkRequest
initOverrides? RequestInit

Returns

Promise<ExportLink>


getExportLinkRaw

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

Get export link

Parameters

Name Type
requestParameters GetExportLinkRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<ExportLink>>


request

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

Parameters

Name Type
context RequestOpts
initOverrides? RequestInit

Returns

Promise<Response>

Inherited from

BaseAPI.request


withMiddleware

withMiddleware<T>(this, ...middlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...middlewares Middleware[]

Returns

T

Inherited from

BaseAPI.withMiddleware


withPostMiddleware

withPostMiddleware<T>(this, ...postMiddlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...postMiddlewares (context: ResponseContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPostMiddleware


withPreMiddleware

withPreMiddleware<T>(this, ...preMiddlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...preMiddlewares (context: RequestContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPreMiddleware