Class: ExportControllerApi
Hierarchy
-
↳
ExportControllerApi
Table of contents
Constructors
Properties
Methods
- exportEntities
- exportEntitiesRaw
- getExportLink
- getExportLinkRaw
- request
- withMiddleware
- withPostMiddleware
- withPreMiddleware
Constructors
constructor
• new ExportControllerApi(configuration?
)
Parameters
Name | Type |
---|---|
configuration | Configuration |
Inherited from
Properties
configuration
• Protected
configuration: Configuration
Inherited from
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
▸ 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
withMiddleware
▸ withMiddleware<T
>(...middlewares
): T
Type parameters
Name | Type |
---|---|
T | extends BaseAPI <T > |
Parameters
Name | Type |
---|---|
...middlewares | Middleware [] |
Returns
T
Inherited from
withPostMiddleware
▸ withPostMiddleware<T
>(...postMiddlewares
): T
Type parameters
Name | Type |
---|---|
T | extends BaseAPI <T > |
Parameters
Name | Type |
---|---|
...postMiddlewares | (context : ResponseContext ) => Promise <void |
Returns
T
Inherited from
withPreMiddleware
▸ withPreMiddleware<T
>(...preMiddlewares
): T
Type parameters
Name | Type |
---|---|
T | extends BaseAPI <T > |
Parameters
Name | Type |
---|---|
...preMiddlewares | (context : RequestContext ) => Promise <void |
Returns
T