@emilgroup/commission-sdk 1.0.0-beta.9 → 1.1.1-beta.0

package/.openapi-generator/FILES

@@ -4,9 +4,12 @@
 README.md
 api.ts
 api/commission-agreement-products-api.ts
+api/commission-agreement-rules-api.ts
 api/commission-agreement-versions-api.ts
 api/commission-agreements-api.ts
+api/commission-candidates-api.ts
 api/commission-recipients-api.ts
+api/commission-settlements-api.ts
 api/commissions-api.ts
 api/default-api.ts
 base.ts
@@ -15,42 +18,79 @@ configuration.ts
 git_push.sh
 index.ts
 models/commission-agreement-class.ts
+models/commission-agreement-metadata-dto.ts
+models/commission-agreement-metadata-partner-dto.ts
 models/commission-agreement-product-class.ts
+models/commission-agreement-rule-class.ts
+models/commission-agreement-rule-config-dto.ts
+models/commission-agreement-rule-evaluation-class.ts
 models/commission-agreement-version-class.ts
+models/commission-candidate-class.ts
 models/commission-class.ts
+models/commission-conditions-dto.ts
+models/commission-config-dto.ts
+models/commission-estimate-class.ts
 models/commission-item-class.ts
 models/commission-recipient-class.ts
+models/commission-settlement-class.ts
 models/create-commission-agreement-product-request-dto.ts
 models/create-commission-agreement-product-response-class.ts
 models/create-commission-agreement-request-dto.ts
 models/create-commission-agreement-response-class.ts
+models/create-commission-agreement-rule-request-dto.ts
+models/create-commission-agreement-rule-response-class.ts
 models/create-commission-agreement-version-request-dto.ts
 models/create-commission-agreement-version-response-class.ts
+models/create-commission-candidate-request-dto.ts
+models/create-commission-candidate-response-class.ts
 models/create-commission-item-request-dto.ts
 models/create-commission-recipient-request-dto.ts
 models/create-commission-recipient-response-class.ts
 models/create-commission-request-dto.ts
 models/create-commission-response-class.ts
+models/create-commission-settlement-request-dto.ts
+models/create-commission-settlement-response-class.ts
+models/estimate-commissions-request-dto.ts
+models/estimate-commissions-response-class.ts
+models/evaluate-commission-agreement-rule-request-dto.ts
+models/evaluate-commission-agreement-rule-response-class.ts
+models/evaluated-commission-class.ts
 models/get-commission-agreement-product-response-class.ts
 models/get-commission-agreement-response-class.ts
+models/get-commission-agreement-rule-response-class.ts
 models/get-commission-agreement-version-response-class.ts
+models/get-commission-candidate-response-class.ts
 models/get-commission-recipient-response-class.ts
 models/get-commission-response-class.ts
+models/get-commission-settlement-response-class.ts
 models/index.ts
 models/inline-response200.ts
 models/inline-response503.ts
 models/list-commission-agreement-products-response-class.ts
+models/list-commission-agreement-rules-response-class.ts
 models/list-commission-agreement-versions-response-class.ts
 models/list-commission-agreements-response-class.ts
+models/list-commission-candidates-response-class.ts
 models/list-commission-recipients-response-class.ts
+models/list-commission-settlements-response-class.ts
 models/list-commissions-response-class.ts
+models/patch-commission-agreement-status-request-dto.ts
+models/patch-commission-agreement-status-response-class.ts
+models/publish-commission-settlements-request-dto.ts
+models/publish-commission-settlements-response-class.ts
 models/update-commission-agreement-product-request-dto.ts
 models/update-commission-agreement-product-response-class.ts
 models/update-commission-agreement-request-dto.ts
 models/update-commission-agreement-response-class.ts
+models/update-commission-agreement-rule-request-dto.ts
+models/update-commission-agreement-rule-response-class.ts
+models/update-commission-candidate-request-dto.ts
+models/update-commission-candidate-response-class.ts
 models/update-commission-recipient-request-dto.ts
 models/update-commission-recipient-response-class.ts
 models/update-commission-request-dto.ts
 models/update-commission-response-class.ts
+models/update-commission-settlement-request-dto.ts
+models/update-commission-settlement-response-class.ts
 package.json
 tsconfig.json

package/README.md

@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
 Navigate to the folder of your consuming project and run one of the following commands:
 
 ```
-npm install @emilgroup/commission-sdk@1.0.0-beta.9 --save
+npm install @emilgroup/commission-sdk@1.1.1-beta.0 --save
 ```
 or 
 ```
-yarn add @emilgroup/commission-sdk@1.0.0-beta.9
+yarn add @emilgroup/commission-sdk@1.1.1-beta.0
 ```
 
 And then you can import `CommissionApi`.

package/api/commission-agreement-products-api.ts

@@ -186,14 +186,17 @@ export const CommissionAgreementProductsApiAxiosParamCreator = function (configu
          * Retrieves a list of commission agreement products.
          * @summary List commission agreement products
          * @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=1, your subsequent call can include pageToken=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.<br/>           <br/>           <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
-         * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
+         * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.<br/>           <br/>           <i>Searchable fields: code, productSlug</i>
          * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: createdAt, updatedAt, productSlug, status</i>
          * @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.<br/>       <br/>       <i>Allowed values: version<i>
+         * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listCommissionAgreementProducts: async (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        listCommissionAgreementProducts: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             const localVarPath = `/commissionservice/v1/agreement-products`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -212,12 +215,20 @@ export const CommissionAgreementProductsApiAxiosParamCreator = function (configu
             // http bearer authentication required
             await setBearerAuthToObject(localVarHeaderParameter, configuration)
 
+            if (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+
+            if (pageToken !== undefined) {
+                localVarQueryParameter['pageToken'] = pageToken;
+            }
+
             if (filter !== undefined) {
                 localVarQueryParameter['filter'] = filter;
             }
 
-            if (filters !== undefined) {
-                localVarQueryParameter['filters'] = filters;
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
             }
 
             if (order !== undefined) {
@@ -228,6 +239,10 @@ export const CommissionAgreementProductsApiAxiosParamCreator = function (configu
                 localVarQueryParameter['expand'] = expand;
             }
 
+            if (filters !== undefined) {
+                localVarQueryParameter['filters'] = filters;
+            }
+
             if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
                 localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
             }
@@ -345,15 +360,18 @@ export const CommissionAgreementProductsApiFp = function(configuration?: Configu
          * Retrieves a list of commission agreement products.
          * @summary List commission agreement products
          * @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, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&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, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
+         * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: code, productSlug&lt;/i&gt;
          * @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: createdAt, updatedAt, productSlug, status&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;       &lt;i&gt;Allowed values: version&lt;i&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, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listCommissionAgreementProducts(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionAgreementProductsResponseClass>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionAgreementProducts(authorization, filter, filters, order, expand, options);
+        async listCommissionAgreementProducts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionAgreementProductsResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionAgreementProducts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
@@ -417,15 +435,18 @@ export const CommissionAgreementProductsApiFactory = function (configuration?: C
          * Retrieves a list of commission agreement products.
          * @summary List commission agreement products
          * @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, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&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, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
+         * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: code, productSlug&lt;/i&gt;
          * @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: createdAt, updatedAt, productSlug, status&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;       &lt;i&gt;Allowed values: version&lt;i&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, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listCommissionAgreementProducts(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListCommissionAgreementProductsResponseClass> {
-            return localVarFp.listCommissionAgreementProducts(authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
+        listCommissionAgreementProducts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionAgreementProductsResponseClass> {
+            return localVarFp.listCommissionAgreementProducts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
         },
         /**
          * This will update commission agreement product.
@@ -525,6 +546,20 @@ export interface CommissionAgreementProductsApiListCommissionAgreementProductsRe
      */
     readonly authorization?: string
 
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
+     */
+    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 CommissionAgreementProductsApiListCommissionAgreementProducts
+     */
+    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, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
      * @type {string}
@@ -533,11 +568,11 @@ export interface CommissionAgreementProductsApiListCommissionAgreementProductsRe
     readonly filter?: 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, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
+     * Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: code, productSlug&lt;/i&gt;
      * @type {string}
      * @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
      */
-    readonly filters?: string
+    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: createdAt, updatedAt, productSlug, status&lt;/i&gt;
@@ -552,6 +587,13 @@ export interface CommissionAgreementProductsApiListCommissionAgreementProductsRe
      * @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
      */
     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, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
+     * @type {string}
+     * @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
+     */
+    readonly filters?: string
 }
 
 /**
@@ -634,7 +676,7 @@ export class CommissionAgreementProductsApi extends BaseAPI {
      * @memberof CommissionAgreementProductsApi
      */
     public listCommissionAgreementProducts(requestParameters: CommissionAgreementProductsApiListCommissionAgreementProductsRequest = {}, options?: AxiosRequestConfig) {
-        return CommissionAgreementProductsApiFp(this.configuration).listCommissionAgreementProducts(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
+        return CommissionAgreementProductsApiFp(this.configuration).listCommissionAgreementProducts(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**