Class UserControllerApi

Hierarchy

BaseAPI
- UserControllerApi

Constructors

constructor

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

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

createInboxRetentionPolicyRun

createInboxRetentionPolicyRun(initOverrides?: RequestInit): Promise<InboxRetentionPolicyRunDto>
Start an asynchronous inbox retention policy run for your account
Parameters
- Optional initOverrides: RequestInit
Returns Promise<InboxRetentionPolicyRunDto>

createInboxRetentionPolicyRunRaw

createInboxRetentionPolicyRunRaw(initOverrides?: RequestInit): Promise<ApiResponse<InboxRetentionPolicyRunDto>>
Start an asynchronous inbox retention policy run for your account
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxRetentionPolicyRunDto>>

createOrUpdateInboxRetentionPolicyForAccount

createOrUpdateInboxRetentionPolicyForAccount(requestParameters: CreateOrUpdateInboxRetentionPolicyForAccountRequest, initOverrides?: RequestInit): Promise<InboxRetentionPolicyDto>
Create inbox retention policy for your global account
Parameters
- requestParameters: CreateOrUpdateInboxRetentionPolicyForAccountRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxRetentionPolicyDto>

createOrUpdateInboxRetentionPolicyForAccountRaw

createOrUpdateInboxRetentionPolicyForAccountRaw(requestParameters: CreateOrUpdateInboxRetentionPolicyForAccountRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxRetentionPolicyDto>>
Create inbox retention policy for your global account
Parameters
- requestParameters: CreateOrUpdateInboxRetentionPolicyForAccountRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxRetentionPolicyDto>>

deleteInboxRetentionPolicyForAccount

deleteInboxRetentionPolicyForAccount(initOverrides?: RequestInit): Promise<EmptyResponseDto>
Delete inbox retention policy for your global account
Parameters
- Optional initOverrides: RequestInit
Returns Promise<EmptyResponseDto>

deleteInboxRetentionPolicyForAccountRaw

deleteInboxRetentionPolicyForAccountRaw(initOverrides?: RequestInit): Promise<ApiResponse<EmptyResponseDto>>
Delete inbox retention policy for your global account
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<EmptyResponseDto>>

getEntityAutomations

getEntityAutomations(requestParameters: GetEntityAutomationsRequest, initOverrides?: RequestInit): Promise<PageEntityAutomationItems>
Parameters
- requestParameters: GetEntityAutomationsRequest
- Optional initOverrides: RequestInit
Returns Promise<PageEntityAutomationItems>

getEntityAutomationsRaw

getEntityAutomationsRaw(requestParameters: GetEntityAutomationsRequest, initOverrides?: RequestInit): Promise<ApiResponse<PageEntityAutomationItems>>
Parameters
- requestParameters: GetEntityAutomationsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PageEntityAutomationItems>>

getEntityEvents

getEntityEvents(requestParameters: GetEntityEventsRequest, initOverrides?: RequestInit): Promise<PageEntityEventItems>
Parameters
- requestParameters: GetEntityEventsRequest
- Optional initOverrides: RequestInit
Returns Promise<PageEntityEventItems>

getEntityEventsRaw

getEntityEventsRaw(requestParameters: GetEntityEventsRequest, initOverrides?: RequestInit): Promise<ApiResponse<PageEntityEventItems>>
Parameters
- requestParameters: GetEntityEventsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PageEntityEventItems>>

getEntityFavorites

getEntityFavorites(requestParameters: GetEntityFavoritesRequest, initOverrides?: RequestInit): Promise<PageEntityFavouriteItems>
Parameters
- requestParameters: GetEntityFavoritesRequest
- Optional initOverrides: RequestInit
Returns Promise<PageEntityFavouriteItems>

getEntityFavoritesRaw

getEntityFavoritesRaw(requestParameters: GetEntityFavoritesRequest, initOverrides?: RequestInit): Promise<ApiResponse<PageEntityFavouriteItems>>
Parameters
- requestParameters: GetEntityFavoritesRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PageEntityFavouriteItems>>

getInboxRetentionPolicyForAccount

getInboxRetentionPolicyForAccount(initOverrides?: RequestInit): Promise<InboxRetentionPolicyOptionalDto>
Get inbox retention policy for your global account
Parameters
- Optional initOverrides: RequestInit
Returns Promise<InboxRetentionPolicyOptionalDto>

getInboxRetentionPolicyForAccountRaw

getInboxRetentionPolicyForAccountRaw(initOverrides?: RequestInit): Promise<ApiResponse<InboxRetentionPolicyOptionalDto>>
Get inbox retention policy for your global account
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxRetentionPolicyOptionalDto>>

getInboxRetentionPolicyRun

getInboxRetentionPolicyRun(requestParameters: GetInboxRetentionPolicyRunRequest, initOverrides?: RequestInit): Promise<InboxRetentionPolicyRunDto>
Get a previously submitted inbox retention policy run for your account
Parameters
- requestParameters: GetInboxRetentionPolicyRunRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxRetentionPolicyRunDto>

getInboxRetentionPolicyRunRaw

getInboxRetentionPolicyRunRaw(requestParameters: GetInboxRetentionPolicyRunRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxRetentionPolicyRunDto>>
Get a previously submitted inbox retention policy run for your account
Parameters
- requestParameters: GetInboxRetentionPolicyRunRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxRetentionPolicyRunDto>>

getInboxRetentionPolicyRuns

getInboxRetentionPolicyRuns(requestParameters: GetInboxRetentionPolicyRunsRequest, initOverrides?: RequestInit): Promise<PageInboxRetentionPolicyRunProjection>
List recent inbox retention policy runs for your account
Parameters
- requestParameters: GetInboxRetentionPolicyRunsRequest
- Optional initOverrides: RequestInit
Returns Promise<PageInboxRetentionPolicyRunProjection>

getInboxRetentionPolicyRunsRaw

getInboxRetentionPolicyRunsRaw(requestParameters: GetInboxRetentionPolicyRunsRequest, initOverrides?: RequestInit): Promise<ApiResponse<PageInboxRetentionPolicyRunProjection>>
List recent inbox retention policy runs for your account
Parameters
- requestParameters: GetInboxRetentionPolicyRunsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PageInboxRetentionPolicyRunProjection>>

getJsonPropertyAsString

getJsonPropertyAsString(requestParameters: GetJsonPropertyAsStringRequest, initOverrides?: RequestInit): Promise<string>
Utility function to extract properties from JSON objects in language where this is cumbersome.
Parameters
- requestParameters: GetJsonPropertyAsStringRequest
- Optional initOverrides: RequestInit
Returns Promise<string>

getJsonPropertyAsStringRaw

getJsonPropertyAsStringRaw(requestParameters: GetJsonPropertyAsStringRequest, initOverrides?: RequestInit): Promise<ApiResponse<string>>
Utility function to extract properties from JSON objects in language where this is cumbersome.
Parameters
- requestParameters: GetJsonPropertyAsStringRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<string>>

getUserInfo

getUserInfo(initOverrides?: RequestInit): Promise<UserInfoDto>
Get account information for your user
Parameters
- Optional initOverrides: RequestInit
Returns Promise<UserInfoDto>

getUserInfoRaw

getUserInfoRaw(initOverrides?: RequestInit): Promise<ApiResponse<UserInfoDto>>
Get account information for your user
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<UserInfoDto>>

`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