@emilgroup/commission-sdk-node 2.9.1-beta.2 → 2.9.1-beta.20

package/dist/api/commissions-api.d.ts

@@ -12,12 +12,17 @@
 import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
 import { Configuration } from '../configuration';
 import { RequestArgs, BaseAPI } from '../base';
+import { CreateCommissionClawbackRequestDto } from '../models';
+import { CreateCommissionClawbackResponseClass } from '../models';
 import { CreateCommissionRequestDto } from '../models';
 import { CreateCommissionResponseClass } from '../models';
 import { EstimateCommissionsRequestDto } from '../models';
 import { EstimateCommissionsResponseClass } from '../models';
 import { GetCommissionResponseClass } from '../models';
 import { ListCommissionsResponseClass } from '../models';
+import { ListScheduledCommissionClawbackTriggersResponseClass } from '../models';
+import { TriggerDueCommissionClawbacksRequestDto } from '../models';
+import { TriggerDueCommissionClawbacksResponseClass } from '../models';
 import { UpdateCommissionRequestDto } from '../models';
 import { UpdateCommissionResponseClass } from '../models';
 /**
@@ -34,6 +39,16 @@ export declare const CommissionsApiAxiosParamCreator: (configuration?: Configura
      * @throws {RequiredError}
      */
     createCommission: (createCommissionRequestDto: CreateCommissionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Creates a manual clawback for one commission.
+     * @summary Create the commission clawback
+     * @param {string} code Unique identifier for the object.
+     * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCommissionClawback: (code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * This will delete commission.
      * @summary Delete the commission
@@ -77,6 +92,30 @@ export declare const CommissionsApiAxiosParamCreator: (configuration?: Configura
      * @throws {RequiredError}
      */
     listCommissions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
+     * @summary List scheduled commission clawback triggers
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {string} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;             &lt;br/&gt;             &lt;i&gt;Allowed values: id, code, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, effectiveDate, queuedAt, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listScheduledCommissionClawbackTriggers: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
+     * @summary Create the due commission clawbacks trigger
+     * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    triggerDueCommissionClawbacks: (triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * This will update commission.
      * @summary Update the commission
@@ -102,6 +141,16 @@ export declare const CommissionsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     createCommission(createCommissionRequestDto: CreateCommissionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionResponseClass>>;
+    /**
+     * Creates a manual clawback for one commission.
+     * @summary Create the commission clawback
+     * @param {string} code Unique identifier for the object.
+     * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCommissionClawback(code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionClawbackResponseClass>>;
     /**
      * This will delete commission.
      * @summary Delete the commission
@@ -145,6 +194,30 @@ export declare const CommissionsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>>;
+    /**
+     * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
+     * @summary List scheduled commission clawback triggers
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {string} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;             &lt;br/&gt;             &lt;i&gt;Allowed values: id, code, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, effectiveDate, queuedAt, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listScheduledCommissionClawbackTriggers(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListScheduledCommissionClawbackTriggersResponseClass>>;
+    /**
+     * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
+     * @summary Create the due commission clawbacks trigger
+     * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TriggerDueCommissionClawbacksResponseClass>>;
     /**
      * This will update commission.
      * @summary Update the commission
@@ -170,6 +243,16 @@ export declare const CommissionsApiFactory: (configuration?: Configuration, base
      * @throws {RequiredError}
      */
     createCommission(createCommissionRequestDto: CreateCommissionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionResponseClass>;
+    /**
+     * Creates a manual clawback for one commission.
+     * @summary Create the commission clawback
+     * @param {string} code Unique identifier for the object.
+     * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCommissionClawback(code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionClawbackResponseClass>;
     /**
      * This will delete commission.
      * @summary Delete the commission
@@ -213,6 +296,30 @@ export declare const CommissionsApiFactory: (configuration?: Configuration, base
      * @throws {RequiredError}
      */
     listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass>;
+    /**
+     * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
+     * @summary List scheduled commission clawback triggers
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {string} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;             &lt;br/&gt;             &lt;i&gt;Allowed values: id, code, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, effectiveDate, queuedAt, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listScheduledCommissionClawbackTriggers(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListScheduledCommissionClawbackTriggersResponseClass>;
+    /**
+     * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
+     * @summary Create the due commission clawbacks trigger
+     * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options?: any): AxiosPromise<TriggerDueCommissionClawbacksResponseClass>;
     /**
      * This will update commission.
      * @summary Update the commission
@@ -243,6 +350,31 @@ export interface CommissionsApiCreateCommissionRequest {
      */
     readonly authorization?: string;
 }
+/**
+ * Request parameters for createCommissionClawback operation in CommissionsApi.
+ * @export
+ * @interface CommissionsApiCreateCommissionClawbackRequest
+ */
+export interface CommissionsApiCreateCommissionClawbackRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof CommissionsApiCreateCommissionClawback
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {CreateCommissionClawbackRequestDto}
+     * @memberof CommissionsApiCreateCommissionClawback
+     */
+    readonly createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionsApiCreateCommissionClawback
+     */
+    readonly authorization?: string;
+}
 /**
  * Request parameters for deleteCommission operation in CommissionsApi.
  * @export
@@ -361,6 +493,80 @@ export interface CommissionsApiListCommissionsRequest {
      */
     readonly filters?: string;
 }
+/**
+ * Request parameters for listScheduledCommissionClawbackTriggers operation in CommissionsApi.
+ * @export
+ * @interface CommissionsApiListScheduledCommissionClawbackTriggersRequest
+ */
+export interface CommissionsApiListScheduledCommissionClawbackTriggersRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
+     */
+    readonly pageSize?: number;
+    /**
+     * A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @type {string}
+     * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
+     */
+    readonly pageToken?: string;
+    /**
+     * Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;             &lt;br/&gt;             &lt;i&gt;Allowed values: id, code, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
+     * @type {string}
+     * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
+     */
+    readonly filter?: string;
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {string}
+     * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
+     */
+    readonly search?: string;
+    /**
+     * Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, effectiveDate, queuedAt, createdAt, updatedAt&lt;/i&gt;
+     * @type {string}
+     * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
+     */
+    readonly order?: string;
+    /**
+     * Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;
+     * @type {string}
+     * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
+     */
+    readonly expand?: string;
+    /**
+     * Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
+     * @type {string}
+     * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
+     */
+    readonly filters?: string;
+}
+/**
+ * Request parameters for triggerDueCommissionClawbacks operation in CommissionsApi.
+ * @export
+ * @interface CommissionsApiTriggerDueCommissionClawbacksRequest
+ */
+export interface CommissionsApiTriggerDueCommissionClawbacksRequest {
+    /**
+     *
+     * @type {TriggerDueCommissionClawbacksRequestDto}
+     * @memberof CommissionsApiTriggerDueCommissionClawbacks
+     */
+    readonly triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionsApiTriggerDueCommissionClawbacks
+     */
+    readonly authorization?: string;
+}
 /**
  * Request parameters for updateCommission operation in CommissionsApi.
  * @export
@@ -402,6 +608,15 @@ export declare class CommissionsApi extends BaseAPI {
      * @memberof CommissionsApi
      */
     createCommission(requestParameters: CommissionsApiCreateCommissionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCommissionResponseClass, any, {}>>;
+    /**
+     * Creates a manual clawback for one commission.
+     * @summary Create the commission clawback
+     * @param {CommissionsApiCreateCommissionClawbackRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionsApi
+     */
+    createCommissionClawback(requestParameters: CommissionsApiCreateCommissionClawbackRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCommissionClawbackResponseClass, any, {}>>;
     /**
      * This will delete commission.
      * @summary Delete the commission
@@ -438,6 +653,24 @@ export declare class CommissionsApi extends BaseAPI {
      * @memberof CommissionsApi
      */
     listCommissions(requestParameters?: CommissionsApiListCommissionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCommissionsResponseClass, any, {}>>;
+    /**
+     * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
+     * @summary List scheduled commission clawback triggers
+     * @param {CommissionsApiListScheduledCommissionClawbackTriggersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionsApi
+     */
+    listScheduledCommissionClawbackTriggers(requestParameters?: CommissionsApiListScheduledCommissionClawbackTriggersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListScheduledCommissionClawbackTriggersResponseClass, any, {}>>;
+    /**
+     * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
+     * @summary Create the due commission clawbacks trigger
+     * @param {CommissionsApiTriggerDueCommissionClawbacksRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionsApi
+     */
+    triggerDueCommissionClawbacks(requestParameters: CommissionsApiTriggerDueCommissionClawbacksRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TriggerDueCommissionClawbacksResponseClass, any, {}>>;
     /**
      * This will update commission.
      * @summary Update the commission