@emilgroup/commission-sdk-node 1.0.0-beta.3 → 1.0.0-beta.31

package/api/commission-agreements-api.ts

@@ -192,11 +192,11 @@ export const CommissionAgreementsApiAxiosParamCreator = function (configuration?
          * @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, createdAt</i>
-         * @param {string} [search] To search the list by any field, pass search=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.<br/>           <br/>           <i>Allowed values: createdAt</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/>       
-         * @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, createdAt</i>
+         * @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, createdAt, partnerCode, productSlug, endDate</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, commissionAgreementNumber, name, description</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: commissionAgreementNumber, status, createdAt, billingFrequency</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: versions, products<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, createdAt, partnerCode, productSlug, endDate</i>
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -265,15 +265,19 @@ export const CommissionAgreementsApiAxiosParamCreator = function (configuration?
         /**
          * This will update commission agreement.
          * @summary Update the commission agreement
+         * @param {string} code 
          * @param {UpdateCommissionAgreementRequestDto} updateCommissionAgreementRequestDto 
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        updateCommissionAgreement: async (updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        updateCommissionAgreement: async (code: string, updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('updateCommissionAgreement', 'code', code)
             // verify required parameter 'updateCommissionAgreementRequestDto' is not null or undefined
             assertParamExists('updateCommissionAgreement', 'updateCommissionAgreementRequestDto', updateCommissionAgreementRequestDto)
-            const localVarPath = `/commissionservice/v1/agreements`;
+            const localVarPath = `/commissionservice/v1/agreements/{code}`
+                .replace(`{${"code"}}`, encodeURIComponent(String(code)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;
@@ -362,11 +366,11 @@ export const CommissionAgreementsApiFp = function(configuration?: Configuration)
          * @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, createdAt&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: createdAt&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, createdAt&lt;/i&gt;
+         * @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, createdAt, partnerCode, productSlug, endDate&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, commissionAgreementNumber, name, description&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: commissionAgreementNumber, status, createdAt, billingFrequency&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: versions, products&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, createdAt, partnerCode, productSlug, endDate&lt;/i&gt;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -377,13 +381,14 @@ export const CommissionAgreementsApiFp = function(configuration?: Configuration)
         /**
          * This will update commission agreement.
          * @summary Update the commission agreement
+         * @param {string} code 
          * @param {UpdateCommissionAgreementRequestDto} updateCommissionAgreementRequestDto 
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async updateCommissionAgreement(updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCommissionAgreementResponseClass>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.updateCommissionAgreement(updateCommissionAgreementRequestDto, authorization, options);
+        async updateCommissionAgreement(code: string, updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCommissionAgreementResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.updateCommissionAgreement(code, updateCommissionAgreementRequestDto, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
     }
@@ -436,11 +441,11 @@ export const CommissionAgreementsApiFactory = function (configuration?: Configur
          * @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, createdAt&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: createdAt&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, createdAt&lt;/i&gt;
+         * @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, createdAt, partnerCode, productSlug, endDate&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, commissionAgreementNumber, name, description&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: commissionAgreementNumber, status, createdAt, billingFrequency&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: versions, products&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, createdAt, partnerCode, productSlug, endDate&lt;/i&gt;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -450,13 +455,14 @@ export const CommissionAgreementsApiFactory = function (configuration?: Configur
         /**
          * This will update commission agreement.
          * @summary Update the commission agreement
+         * @param {string} code 
          * @param {UpdateCommissionAgreementRequestDto} updateCommissionAgreementRequestDto 
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        updateCommissionAgreement(updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCommissionAgreementResponseClass> {
-            return localVarFp.updateCommissionAgreement(updateCommissionAgreementRequestDto, authorization, options).then((request) => request(axios, basePath));
+        updateCommissionAgreement(code: string, updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCommissionAgreementResponseClass> {
+            return localVarFp.updateCommissionAgreement(code, updateCommissionAgreementRequestDto, authorization, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -559,35 +565,35 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
     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, createdAt&lt;/i&gt;
+     * 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, createdAt, partnerCode, productSlug, endDate&lt;/i&gt;
      * @type {string}
      * @memberof CommissionAgreementsApiListCommissionAgreements
      */
     readonly filter?: string
 
     /**
-     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * 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, commissionAgreementNumber, name, description&lt;/i&gt;
      * @type {string}
      * @memberof CommissionAgreementsApiListCommissionAgreements
      */
     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&lt;/i&gt;
+     * 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: commissionAgreementNumber, status, createdAt, billingFrequency&lt;/i&gt;
      * @type {string}
      * @memberof CommissionAgreementsApiListCommissionAgreements
      */
     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;       
+     * 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: versions, products&lt;i&gt;
      * @type {string}
      * @memberof CommissionAgreementsApiListCommissionAgreements
      */
     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, createdAt&lt;/i&gt;
+     * 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, createdAt, partnerCode, productSlug, endDate&lt;/i&gt;
      * @type {string}
      * @memberof CommissionAgreementsApiListCommissionAgreements
      */
@@ -600,6 +606,13 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
  * @interface CommissionAgreementsApiUpdateCommissionAgreementRequest
  */
 export interface CommissionAgreementsApiUpdateCommissionAgreementRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof CommissionAgreementsApiUpdateCommissionAgreement
+     */
+    readonly code: string
+
     /**
      * 
      * @type {UpdateCommissionAgreementRequestDto}
@@ -679,6 +692,6 @@ export class CommissionAgreementsApi extends BaseAPI {
      * @memberof CommissionAgreementsApi
      */
     public updateCommissionAgreement(requestParameters: CommissionAgreementsApiUpdateCommissionAgreementRequest, options?: AxiosRequestConfig) {
-        return CommissionAgreementsApiFp(this.configuration).updateCommissionAgreement(requestParameters.updateCommissionAgreementRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+        return CommissionAgreementsApiFp(this.configuration).updateCommissionAgreement(requestParameters.code, requestParameters.updateCommissionAgreementRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
     }
 }