Class ExportControllerApi

Hierarchy

BaseAPI
- ExportControllerApi

Index

Constructors

Properties

Methods

exportEntities exportEntitiesRaw getExportLink getExportLinkRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new ExportControllerApi(configuration?: Configuration): ExportControllerApi
Parameters
- configuration: Configuration = ...
Returns ExportControllerApi

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

exportEntities

exportEntities(requestParameters: ExportEntitiesRequest, initOverrides?: RequestInit): Promise<string>
Export inboxes link callable via browser
Parameters
- requestParameters: ExportEntitiesRequest
- Optional initOverrides: RequestInit
Returns Promise<string>

exportEntitiesRaw

exportEntitiesRaw(requestParameters: ExportEntitiesRequest, initOverrides?: RequestInit): Promise<ApiResponse<string>>
Export inboxes link callable via browser
Parameters
- requestParameters: ExportEntitiesRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<string>>

getExportLink

getExportLink(requestParameters: GetExportLinkRequest, initOverrides?: RequestInit): Promise<ExportLink>
Get export link
Parameters
- requestParameters: GetExportLinkRequest
- Optional initOverrides: RequestInit
Returns Promise<ExportLink>

getExportLinkRaw

getExportLinkRaw(requestParameters: GetExportLinkRequest, initOverrides?: RequestInit): Promise<ApiResponse<ExportLink>>
Get export link
Parameters
- requestParameters: GetExportLinkRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ExportLink>>

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>

Inherited from BaseAPI.request

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T

Inherited from BaseAPI.withMiddleware

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T

Inherited from BaseAPI.withPostMiddleware

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T

Inherited from BaseAPI.withPreMiddleware