@emilgroup/settlement-sdk 0.3.1-beta.6 → 0.3.1-beta.8

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

@@ -12,6 +12,7 @@
 import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
 import { Configuration } from '../configuration';
 import { RequestArgs, BaseAPI } from '../base';
+import { AddSettlementEntryRequestBodyDto } from '../models';
 import { AddSettlementEntryResponseClass } from '../models';
 import { CreateSettlementRequestDto } from '../models';
 import { CreateSettlementResponseClass } from '../models';
@@ -23,16 +24,17 @@ import { ListSettlementsResponseClass } from '../models';
  */
 export declare const SettlementsApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * This will add settlement entry.  **Required Permissions**  none
+     * This will add settlement entry.  **Required Permissions**  \"payment-management.settlements.create\"
      * @summary Create the settlement entry
      * @param {string} settlementCode
+     * @param {AddSettlementEntryRequestBodyDto} addSettlementEntryRequestBodyDto
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    addSettlementEntry: (settlementCode: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    addSettlementEntry: (settlementCode: string, addSettlementEntryRequestBodyDto: AddSettlementEntryRequestBodyDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * This will create settlement.  **Required Permissions**  none
+     * This will create settlement.  **Required Permissions**  \"payment-management.settlements.create\"
      * @summary Create the settlement
      * @param {CreateSettlementRequestDto} createSettlementRequestDto
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -41,7 +43,7 @@ export declare const SettlementsApiAxiosParamCreator: (configuration?: Configura
      */
     createSettlement: (createSettlementRequestDto: CreateSettlementRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * This will delete settlement.  **Required Permissions**  none
+     * This will delete settlement.  **Required Permissions**  \"payment-management.settlements.delete\"
      * @summary Delete the settlement
      * @param {string} code Unique identifier for the object.
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -50,7 +52,7 @@ export declare const SettlementsApiAxiosParamCreator: (configuration?: Configura
      */
     deleteSettlement: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * This will get settlement.  **Required Permissions**  none
+     * This will get settlement.  **Required Permissions**  \"payment-management.settlements.view\"
      * @summary Retrieve the settlement
      * @param {string} code
      * @param {string} expand
@@ -60,16 +62,16 @@ export declare const SettlementsApiAxiosParamCreator: (configuration?: Configura
      */
     getSettlement: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Retrieves a list of settlements.  **Required Permissions**  none
+     * Retrieves a list of settlements.  **Required Permissions**  \"payment-management.settlements.view\"
      * @summary List settlements
      * @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: code, settlementNumber, domainEntityCode, domainEntityType, domainEntityNumber, partnerCode, status, currency, 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, settlementNumber, domainEntityCode, domainEntityNumber, partnerCode&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: status, balance, 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;       &lt;i&gt;Allowed values: settlementEntries&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: code, settlementNumber, domainEntityCode, domainEntityType, domainEntityNumber, partnerCode, status, currency, createdAt&lt;/i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -81,16 +83,17 @@ export declare const SettlementsApiAxiosParamCreator: (configuration?: Configura
  */
 export declare const SettlementsApiFp: (configuration?: Configuration) => {
     /**
-     * This will add settlement entry.  **Required Permissions**  none
+     * This will add settlement entry.  **Required Permissions**  \"payment-management.settlements.create\"
      * @summary Create the settlement entry
      * @param {string} settlementCode
+     * @param {AddSettlementEntryRequestBodyDto} addSettlementEntryRequestBodyDto
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    addSettlementEntry(settlementCode: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddSettlementEntryResponseClass>>;
+    addSettlementEntry(settlementCode: string, addSettlementEntryRequestBodyDto: AddSettlementEntryRequestBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddSettlementEntryResponseClass>>;
     /**
-     * This will create settlement.  **Required Permissions**  none
+     * This will create settlement.  **Required Permissions**  \"payment-management.settlements.create\"
      * @summary Create the settlement
      * @param {CreateSettlementRequestDto} createSettlementRequestDto
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -99,7 +102,7 @@ export declare const SettlementsApiFp: (configuration?: Configuration) => {
      */
     createSettlement(createSettlementRequestDto: CreateSettlementRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateSettlementResponseClass>>;
     /**
-     * This will delete settlement.  **Required Permissions**  none
+     * This will delete settlement.  **Required Permissions**  \"payment-management.settlements.delete\"
      * @summary Delete the settlement
      * @param {string} code Unique identifier for the object.
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -108,7 +111,7 @@ export declare const SettlementsApiFp: (configuration?: Configuration) => {
      */
     deleteSettlement(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     * This will get settlement.  **Required Permissions**  none
+     * This will get settlement.  **Required Permissions**  \"payment-management.settlements.view\"
      * @summary Retrieve the settlement
      * @param {string} code
      * @param {string} expand
@@ -118,16 +121,16 @@ export declare const SettlementsApiFp: (configuration?: Configuration) => {
      */
     getSettlement(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettlementResponseClass>>;
     /**
-     * Retrieves a list of settlements.  **Required Permissions**  none
+     * Retrieves a list of settlements.  **Required Permissions**  \"payment-management.settlements.view\"
      * @summary List settlements
      * @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: code, settlementNumber, domainEntityCode, domainEntityType, domainEntityNumber, partnerCode, status, currency, 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, settlementNumber, domainEntityCode, domainEntityNumber, partnerCode&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: status, balance, 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;       &lt;i&gt;Allowed values: settlementEntries&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: code, settlementNumber, domainEntityCode, domainEntityType, domainEntityNumber, partnerCode, status, currency, createdAt&lt;/i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -139,16 +142,17 @@ export declare const SettlementsApiFp: (configuration?: Configuration) => {
  */
 export declare const SettlementsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * This will add settlement entry.  **Required Permissions**  none
+     * This will add settlement entry.  **Required Permissions**  \"payment-management.settlements.create\"
      * @summary Create the settlement entry
      * @param {string} settlementCode
+     * @param {AddSettlementEntryRequestBodyDto} addSettlementEntryRequestBodyDto
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    addSettlementEntry(settlementCode: string, authorization?: string, options?: any): AxiosPromise<AddSettlementEntryResponseClass>;
+    addSettlementEntry(settlementCode: string, addSettlementEntryRequestBodyDto: AddSettlementEntryRequestBodyDto, authorization?: string, options?: any): AxiosPromise<AddSettlementEntryResponseClass>;
     /**
-     * This will create settlement.  **Required Permissions**  none
+     * This will create settlement.  **Required Permissions**  \"payment-management.settlements.create\"
      * @summary Create the settlement
      * @param {CreateSettlementRequestDto} createSettlementRequestDto
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -157,7 +161,7 @@ export declare const SettlementsApiFactory: (configuration?: Configuration, base
      */
     createSettlement(createSettlementRequestDto: CreateSettlementRequestDto, authorization?: string, options?: any): AxiosPromise<CreateSettlementResponseClass>;
     /**
-     * This will delete settlement.  **Required Permissions**  none
+     * This will delete settlement.  **Required Permissions**  \"payment-management.settlements.delete\"
      * @summary Delete the settlement
      * @param {string} code Unique identifier for the object.
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -166,7 +170,7 @@ export declare const SettlementsApiFactory: (configuration?: Configuration, base
      */
     deleteSettlement(code: string, authorization?: string, options?: any): AxiosPromise<void>;
     /**
-     * This will get settlement.  **Required Permissions**  none
+     * This will get settlement.  **Required Permissions**  \"payment-management.settlements.view\"
      * @summary Retrieve the settlement
      * @param {string} code
      * @param {string} expand
@@ -176,16 +180,16 @@ export declare const SettlementsApiFactory: (configuration?: Configuration, base
      */
     getSettlement(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetSettlementResponseClass>;
     /**
-     * Retrieves a list of settlements.  **Required Permissions**  none
+     * Retrieves a list of settlements.  **Required Permissions**  \"payment-management.settlements.view\"
      * @summary List settlements
      * @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: code, settlementNumber, domainEntityCode, domainEntityType, domainEntityNumber, partnerCode, status, currency, 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, settlementNumber, domainEntityCode, domainEntityNumber, partnerCode&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: status, balance, 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;       &lt;i&gt;Allowed values: settlementEntries&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: code, settlementNumber, domainEntityCode, domainEntityType, domainEntityNumber, partnerCode, status, currency, createdAt&lt;/i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -203,6 +207,12 @@ export interface SettlementsApiAddSettlementEntryRequest {
      * @memberof SettlementsApiAddSettlementEntry
      */
     readonly settlementCode: string;
+    /**
+     *
+     * @type {AddSettlementEntryRequestBodyDto}
+     * @memberof SettlementsApiAddSettlementEntry
+     */
+    readonly addSettlementEntryRequestBodyDto: AddSettlementEntryRequestBodyDto;
     /**
      * Bearer Token: provided by the login endpoint under the name accessToken.
      * @type {string}
@@ -298,31 +308,31 @@ export interface SettlementsApiListSettlementsRequest {
      */
     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: code, settlementNumber, domainEntityCode, domainEntityType, domainEntityNumber, partnerCode, status, currency, createdAt&lt;/i&gt;
      * @type {string}
      * @memberof SettlementsApiListSettlements
      */
     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, settlementNumber, domainEntityCode, domainEntityNumber, partnerCode&lt;/i&gt;
      * @type {string}
      * @memberof SettlementsApiListSettlements
      */
     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: status, balance, createdAt&lt;/i&gt;
      * @type {string}
      * @memberof SettlementsApiListSettlements
      */
     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: settlementEntries&lt;i&gt;
      * @type {string}
      * @memberof SettlementsApiListSettlements
      */
     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: code, settlementNumber, domainEntityCode, domainEntityType, domainEntityNumber, partnerCode, status, currency, createdAt&lt;/i&gt;
      * @type {string}
      * @memberof SettlementsApiListSettlements
      */
@@ -336,7 +346,7 @@ export interface SettlementsApiListSettlementsRequest {
  */
 export declare class SettlementsApi extends BaseAPI {
     /**
-     * This will add settlement entry.  **Required Permissions**  none
+     * This will add settlement entry.  **Required Permissions**  \"payment-management.settlements.create\"
      * @summary Create the settlement entry
      * @param {SettlementsApiAddSettlementEntryRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -345,7 +355,7 @@ export declare class SettlementsApi extends BaseAPI {
      */
     addSettlementEntry(requestParameters: SettlementsApiAddSettlementEntryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AddSettlementEntryResponseClass, any, {}>>;
     /**
-     * This will create settlement.  **Required Permissions**  none
+     * This will create settlement.  **Required Permissions**  \"payment-management.settlements.create\"
      * @summary Create the settlement
      * @param {SettlementsApiCreateSettlementRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -354,7 +364,7 @@ export declare class SettlementsApi extends BaseAPI {
      */
     createSettlement(requestParameters: SettlementsApiCreateSettlementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateSettlementResponseClass, any, {}>>;
     /**
-     * This will delete settlement.  **Required Permissions**  none
+     * This will delete settlement.  **Required Permissions**  \"payment-management.settlements.delete\"
      * @summary Delete the settlement
      * @param {SettlementsApiDeleteSettlementRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -363,7 +373,7 @@ export declare class SettlementsApi extends BaseAPI {
      */
     deleteSettlement(requestParameters: SettlementsApiDeleteSettlementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
-     * This will get settlement.  **Required Permissions**  none
+     * This will get settlement.  **Required Permissions**  \"payment-management.settlements.view\"
      * @summary Retrieve the settlement
      * @param {SettlementsApiGetSettlementRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -372,7 +382,7 @@ export declare class SettlementsApi extends BaseAPI {
      */
     getSettlement(requestParameters: SettlementsApiGetSettlementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSettlementResponseClass, any, {}>>;
     /**
-     * Retrieves a list of settlements.  **Required Permissions**  none
+     * Retrieves a list of settlements.  **Required Permissions**  \"payment-management.settlements.view\"
      * @summary List settlements
      * @param {SettlementsApiListSettlementsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/dist/api/settlements-api.js

@@ -93,14 +93,15 @@ var SettlementsApiAxiosParamCreator = function (configuration) {
     var _this = this;
     return {
         /**
-         * This will add settlement entry.  **Required Permissions**  none
+         * This will add settlement entry.  **Required Permissions**  \"payment-management.settlements.create\"
          * @summary Create the settlement entry
          * @param {string} settlementCode
+         * @param {AddSettlementEntryRequestBodyDto} addSettlementEntryRequestBodyDto
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        addSettlementEntry: function (settlementCode, authorization, options) {
+        addSettlementEntry: function (settlementCode, addSettlementEntryRequestBodyDto, authorization, options) {
             if (options === void 0) { options = {}; }
             return __awaiter(_this, void 0, void 0, function () {
                 var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -109,6 +110,8 @@ var SettlementsApiAxiosParamCreator = function (configuration) {
                         case 0:
                             // verify required parameter 'settlementCode' is not null or undefined
                             (0, common_1.assertParamExists)('addSettlementEntry', 'settlementCode', settlementCode);
+                            // verify required parameter 'addSettlementEntryRequestBodyDto' is not null or undefined
+                            (0, common_1.assertParamExists)('addSettlementEntry', 'addSettlementEntryRequestBodyDto', addSettlementEntryRequestBodyDto);
                             localVarPath = "/settlementservice/v1/settlements/{settlementCode}/entries"
                                 .replace("{".concat("settlementCode", "}"), encodeURIComponent(String(settlementCode)));
                             localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -129,9 +132,11 @@ var SettlementsApiAxiosParamCreator = function (configuration) {
                             if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
                                 localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
                             }
+                            localVarHeaderParameter['Content-Type'] = 'application/json';
                             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
                             headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
                             localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+                            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(addSettlementEntryRequestBodyDto, localVarRequestOptions, configuration);
                             return [2 /*return*/, {
                                     url: (0, common_1.toPathString)(localVarUrlObj),
                                     options: localVarRequestOptions,
@@ -141,7 +146,7 @@ var SettlementsApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * This will create settlement.  **Required Permissions**  none
+         * This will create settlement.  **Required Permissions**  \"payment-management.settlements.create\"
          * @summary Create the settlement
          * @param {CreateSettlementRequestDto} createSettlementRequestDto
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -190,7 +195,7 @@ var SettlementsApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * This will delete settlement.  **Required Permissions**  none
+         * This will delete settlement.  **Required Permissions**  \"payment-management.settlements.delete\"
          * @summary Delete the settlement
          * @param {string} code Unique identifier for the object.
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -238,7 +243,7 @@ var SettlementsApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * This will get settlement.  **Required Permissions**  none
+         * This will get settlement.  **Required Permissions**  \"payment-management.settlements.view\"
          * @summary Retrieve the settlement
          * @param {string} code
          * @param {string} expand
@@ -292,16 +297,16 @@ var SettlementsApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * Retrieves a list of settlements.  **Required Permissions**  none
+         * Retrieves a list of settlements.  **Required Permissions**  \"payment-management.settlements.view\"
          * @summary List settlements
          * @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: code, settlementNumber, domainEntityCode, domainEntityType, domainEntityNumber, partnerCode, status, currency, 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, settlementNumber, domainEntityCode, domainEntityNumber, partnerCode</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: status, balance, 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/>       <i>Allowed values: settlementEntries<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: code, settlementNumber, domainEntityCode, domainEntityType, domainEntityNumber, partnerCode, status, currency, createdAt</i>
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -374,19 +379,20 @@ var SettlementsApiFp = function (configuration) {
     var localVarAxiosParamCreator = (0, exports.SettlementsApiAxiosParamCreator)(configuration);
     return {
         /**
-         * This will add settlement entry.  **Required Permissions**  none
+         * This will add settlement entry.  **Required Permissions**  \"payment-management.settlements.create\"
          * @summary Create the settlement entry
          * @param {string} settlementCode
+         * @param {AddSettlementEntryRequestBodyDto} addSettlementEntryRequestBodyDto
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        addSettlementEntry: function (settlementCode, authorization, options) {
+        addSettlementEntry: function (settlementCode, addSettlementEntryRequestBodyDto, authorization, options) {
             return __awaiter(this, void 0, void 0, function () {
                 var localVarAxiosArgs;
                 return __generator(this, function (_a) {
                     switch (_a.label) {
-                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.addSettlementEntry(settlementCode, authorization, options)];
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.addSettlementEntry(settlementCode, addSettlementEntryRequestBodyDto, authorization, options)];
                         case 1:
                             localVarAxiosArgs = _a.sent();
                             return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -395,7 +401,7 @@ var SettlementsApiFp = function (configuration) {
             });
         },
         /**
-         * This will create settlement.  **Required Permissions**  none
+         * This will create settlement.  **Required Permissions**  \"payment-management.settlements.create\"
          * @summary Create the settlement
          * @param {CreateSettlementRequestDto} createSettlementRequestDto
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -416,7 +422,7 @@ var SettlementsApiFp = function (configuration) {
             });
         },
         /**
-         * This will delete settlement.  **Required Permissions**  none
+         * This will delete settlement.  **Required Permissions**  \"payment-management.settlements.delete\"
          * @summary Delete the settlement
          * @param {string} code Unique identifier for the object.
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -437,7 +443,7 @@ var SettlementsApiFp = function (configuration) {
             });
         },
         /**
-         * This will get settlement.  **Required Permissions**  none
+         * This will get settlement.  **Required Permissions**  \"payment-management.settlements.view\"
          * @summary Retrieve the settlement
          * @param {string} code
          * @param {string} expand
@@ -459,16 +465,16 @@ var SettlementsApiFp = function (configuration) {
             });
         },
         /**
-         * Retrieves a list of settlements.  **Required Permissions**  none
+         * Retrieves a list of settlements.  **Required Permissions**  \"payment-management.settlements.view\"
          * @summary List settlements
          * @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: code, settlementNumber, domainEntityCode, domainEntityType, domainEntityNumber, partnerCode, status, currency, 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, settlementNumber, domainEntityCode, domainEntityNumber, partnerCode</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: status, balance, 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/>       <i>Allowed values: settlementEntries<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: code, settlementNumber, domainEntityCode, domainEntityType, domainEntityNumber, partnerCode, status, currency, createdAt</i>
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -496,18 +502,19 @@ var SettlementsApiFactory = function (configuration, basePath, axios) {
     var localVarFp = (0, exports.SettlementsApiFp)(configuration);
     return {
         /**
-         * This will add settlement entry.  **Required Permissions**  none
+         * This will add settlement entry.  **Required Permissions**  \"payment-management.settlements.create\"
          * @summary Create the settlement entry
          * @param {string} settlementCode
+         * @param {AddSettlementEntryRequestBodyDto} addSettlementEntryRequestBodyDto
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        addSettlementEntry: function (settlementCode, authorization, options) {
-            return localVarFp.addSettlementEntry(settlementCode, authorization, options).then(function (request) { return request(axios, basePath); });
+        addSettlementEntry: function (settlementCode, addSettlementEntryRequestBodyDto, authorization, options) {
+            return localVarFp.addSettlementEntry(settlementCode, addSettlementEntryRequestBodyDto, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * This will create settlement.  **Required Permissions**  none
+         * This will create settlement.  **Required Permissions**  \"payment-management.settlements.create\"
          * @summary Create the settlement
          * @param {CreateSettlementRequestDto} createSettlementRequestDto
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -518,7 +525,7 @@ var SettlementsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.createSettlement(createSettlementRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * This will delete settlement.  **Required Permissions**  none
+         * This will delete settlement.  **Required Permissions**  \"payment-management.settlements.delete\"
          * @summary Delete the settlement
          * @param {string} code Unique identifier for the object.
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -529,7 +536,7 @@ var SettlementsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.deleteSettlement(code, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * This will get settlement.  **Required Permissions**  none
+         * This will get settlement.  **Required Permissions**  \"payment-management.settlements.view\"
          * @summary Retrieve the settlement
          * @param {string} code
          * @param {string} expand
@@ -541,16 +548,16 @@ var SettlementsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getSettlement(code, expand, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * Retrieves a list of settlements.  **Required Permissions**  none
+         * Retrieves a list of settlements.  **Required Permissions**  \"payment-management.settlements.view\"
          * @summary List settlements
          * @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: code, settlementNumber, domainEntityCode, domainEntityType, domainEntityNumber, partnerCode, status, currency, 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, settlementNumber, domainEntityCode, domainEntityNumber, partnerCode</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: status, balance, 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/>       <i>Allowed values: settlementEntries<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: code, settlementNumber, domainEntityCode, domainEntityType, domainEntityNumber, partnerCode, status, currency, createdAt</i>
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -572,7 +579,7 @@ var SettlementsApi = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
-     * This will add settlement entry.  **Required Permissions**  none
+     * This will add settlement entry.  **Required Permissions**  \"payment-management.settlements.create\"
      * @summary Create the settlement entry
      * @param {SettlementsApiAddSettlementEntryRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -581,10 +588,10 @@ var SettlementsApi = /** @class */ (function (_super) {
      */
     SettlementsApi.prototype.addSettlementEntry = function (requestParameters, options) {
         var _this = this;
-        return (0, exports.SettlementsApiFp)(this.configuration).addSettlementEntry(requestParameters.settlementCode, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
+        return (0, exports.SettlementsApiFp)(this.configuration).addSettlementEntry(requestParameters.settlementCode, requestParameters.addSettlementEntryRequestBodyDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * This will create settlement.  **Required Permissions**  none
+     * This will create settlement.  **Required Permissions**  \"payment-management.settlements.create\"
      * @summary Create the settlement
      * @param {SettlementsApiCreateSettlementRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -596,7 +603,7 @@ var SettlementsApi = /** @class */ (function (_super) {
         return (0, exports.SettlementsApiFp)(this.configuration).createSettlement(requestParameters.createSettlementRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * This will delete settlement.  **Required Permissions**  none
+     * This will delete settlement.  **Required Permissions**  \"payment-management.settlements.delete\"
      * @summary Delete the settlement
      * @param {SettlementsApiDeleteSettlementRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -608,7 +615,7 @@ var SettlementsApi = /** @class */ (function (_super) {
         return (0, exports.SettlementsApiFp)(this.configuration).deleteSettlement(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * This will get settlement.  **Required Permissions**  none
+     * This will get settlement.  **Required Permissions**  \"payment-management.settlements.view\"
      * @summary Retrieve the settlement
      * @param {SettlementsApiGetSettlementRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -620,7 +627,7 @@ var SettlementsApi = /** @class */ (function (_super) {
         return (0, exports.SettlementsApiFp)(this.configuration).getSettlement(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * Retrieves a list of settlements.  **Required Permissions**  none
+     * Retrieves a list of settlements.  **Required Permissions**  \"payment-management.settlements.view\"
      * @summary List settlements
      * @param {SettlementsApiListSettlementsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/dist/models/add-settlement-entry-request-body-dto.d.ts

@@ -0,0 +1,25 @@
+/**
+ * EMIL SettlementService
+ * The EMIL SettlementService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { SettlementEntryInputDto } from './settlement-entry-input-dto';
+/**
+ *
+ * @export
+ * @interface AddSettlementEntryRequestBodyDto
+ */
+export interface AddSettlementEntryRequestBodyDto {
+    /**
+     * Entry of the settlement
+     * @type {SettlementEntryInputDto}
+     * @memberof AddSettlementEntryRequestBodyDto
+     */
+    'entry'?: SettlementEntryInputDto;
+}