@emilgroup/settlement-sdk 0.3.1-beta.10

package/api/settlements-api.ts

@@ -0,0 +1,693 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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 globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
+// @ts-ignore
+import { AddSettlementEntryRequestBodyDto } from '../models';
+// @ts-ignore
+import { AddSettlementEntryResponseClass } from '../models';
+// @ts-ignore
+import { CreateSettlementRequestDto } from '../models';
+// @ts-ignore
+import { CreateSettlementResponseClass } from '../models';
+// @ts-ignore
+import { GetSettlementResponseClass } from '../models';
+// @ts-ignore
+import { ListSettlementsResponseClass } from '../models';
+/**
+ * SettlementsApi - axios parameter creator
+ * @export
+ */
+export const SettlementsApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * 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: async (settlementCode: string, addSettlementEntryRequestBodyDto: AddSettlementEntryRequestBodyDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'settlementCode' is not null or undefined
+            assertParamExists('addSettlementEntry', 'settlementCode', settlementCode)
+            // verify required parameter 'addSettlementEntryRequestBodyDto' is not null or undefined
+            assertParamExists('addSettlementEntry', 'addSettlementEntryRequestBodyDto', addSettlementEntryRequestBodyDto)
+            const localVarPath = `/settlementservice/v1/settlements/{settlementCode}/entries`
+                .replace(`{${"settlementCode"}}`, encodeURIComponent(String(settlementCode)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(addSettlementEntryRequestBodyDto, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 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.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createSettlement: async (createSettlementRequestDto: CreateSettlementRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'createSettlementRequestDto' is not null or undefined
+            assertParamExists('createSettlement', 'createSettlementRequestDto', createSettlementRequestDto)
+            const localVarPath = `/settlementservice/v1/settlements`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(createSettlementRequestDto, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 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.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteSettlement: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('deleteSettlement', 'code', code)
+            const localVarPath = `/settlementservice/v1/settlements/{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;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * This will get settlement.  **Required Permissions**  \"payment-management.settlements.view\"
+         * @summary Retrieve the settlement
+         * @param {string} code 
+         * @param {string} expand 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSettlement: async (code: string, expand: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('getSettlement', 'code', code)
+            // verify required parameter 'expand' is not null or undefined
+            assertParamExists('getSettlement', 'expand', expand)
+            const localVarPath = `/settlementservice/v1/settlements/{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;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (expand !== undefined) {
+                localVarQueryParameter['expand'] = expand;
+            }
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 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: 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}
+         */
+        listSettlements: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/settlementservice/v1/settlements`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // 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 (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+
+            if (order !== undefined) {
+                localVarQueryParameter['order'] = order;
+            }
+
+            if (expand !== undefined) {
+                localVarQueryParameter['expand'] = expand;
+            }
+
+            if (filters !== undefined) {
+                localVarQueryParameter['filters'] = filters;
+            }
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * SettlementsApi - functional programming interface
+ * @export
+ */
+export const SettlementsApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = SettlementsApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * 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}
+         */
+        async addSettlementEntry(settlementCode: string, addSettlementEntryRequestBodyDto: AddSettlementEntryRequestBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddSettlementEntryResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.addSettlementEntry(settlementCode, addSettlementEntryRequestBodyDto, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * 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.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async createSettlement(createSettlementRequestDto: CreateSettlementRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateSettlementResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createSettlement(createSettlementRequestDto, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * 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.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async deleteSettlement(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSettlement(code, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * This will get settlement.  **Required Permissions**  \"payment-management.settlements.view\"
+         * @summary Retrieve the settlement
+         * @param {string} code 
+         * @param {string} expand 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getSettlement(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettlementResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getSettlement(code, expand, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * 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: 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}
+         */
+        async listSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSettlementsResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listSettlements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * SettlementsApi - factory interface
+ * @export
+ */
+export const SettlementsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = SettlementsApiFp(configuration)
+    return {
+        /**
+         * 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, addSettlementEntryRequestBodyDto: AddSettlementEntryRequestBodyDto, authorization?: string, options?: any): AxiosPromise<AddSettlementEntryResponseClass> {
+            return localVarFp.addSettlementEntry(settlementCode, addSettlementEntryRequestBodyDto, authorization, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 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.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createSettlement(createSettlementRequestDto: CreateSettlementRequestDto, authorization?: string, options?: any): AxiosPromise<CreateSettlementResponseClass> {
+            return localVarFp.createSettlement(createSettlementRequestDto, authorization, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 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.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteSettlement(code: string, authorization?: string, options?: any): AxiosPromise<void> {
+            return localVarFp.deleteSettlement(code, authorization, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * This will get settlement.  **Required Permissions**  \"payment-management.settlements.view\"
+         * @summary Retrieve the settlement
+         * @param {string} code 
+         * @param {string} expand 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSettlement(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetSettlementResponseClass> {
+            return localVarFp.getSettlement(code, expand, authorization, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 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: 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}
+         */
+        listSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListSettlementsResponseClass> {
+            return localVarFp.listSettlements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for addSettlementEntry operation in SettlementsApi.
+ * @export
+ * @interface SettlementsApiAddSettlementEntryRequest
+ */
+export interface SettlementsApiAddSettlementEntryRequest {
+    /**
+     * 
+     * @type {string}
+     * @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}
+     * @memberof SettlementsApiAddSettlementEntry
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for createSettlement operation in SettlementsApi.
+ * @export
+ * @interface SettlementsApiCreateSettlementRequest
+ */
+export interface SettlementsApiCreateSettlementRequest {
+    /**
+     * 
+     * @type {CreateSettlementRequestDto}
+     * @memberof SettlementsApiCreateSettlement
+     */
+    readonly createSettlementRequestDto: CreateSettlementRequestDto
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof SettlementsApiCreateSettlement
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for deleteSettlement operation in SettlementsApi.
+ * @export
+ * @interface SettlementsApiDeleteSettlementRequest
+ */
+export interface SettlementsApiDeleteSettlementRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof SettlementsApiDeleteSettlement
+     */
+    readonly code: string
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof SettlementsApiDeleteSettlement
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for getSettlement operation in SettlementsApi.
+ * @export
+ * @interface SettlementsApiGetSettlementRequest
+ */
+export interface SettlementsApiGetSettlementRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof SettlementsApiGetSettlement
+     */
+    readonly code: string
+
+    /**
+     * 
+     * @type {string}
+     * @memberof SettlementsApiGetSettlement
+     */
+    readonly expand: string
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof SettlementsApiGetSettlement
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for listSettlements operation in SettlementsApi.
+ * @export
+ * @interface SettlementsApiListSettlementsRequest
+ */
+export interface SettlementsApiListSettlementsRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof SettlementsApiListSettlements
+     */
+    readonly authorization?: string
+
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof SettlementsApiListSettlements
+     */
+    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 SettlementsApiListSettlements
+     */
+    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: code, settlementNumber, domainEntityCode, domainEntityType, domainEntityNumber, partnerCode, status, currency, createdAt&lt;/i&gt;
+     * @type {string}
+     * @memberof SettlementsApiListSettlements
+     */
+    readonly filter?: string
+
+    /**
+     * 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: 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;       &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: code, settlementNumber, domainEntityCode, domainEntityType, domainEntityNumber, partnerCode, status, currency, createdAt&lt;/i&gt;
+     * @type {string}
+     * @memberof SettlementsApiListSettlements
+     */
+    readonly filters?: string
+}
+
+/**
+ * SettlementsApi - object-oriented interface
+ * @export
+ * @class SettlementsApi
+ * @extends {BaseAPI}
+ */
+export class SettlementsApi extends BaseAPI {
+    /**
+     * 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.
+     * @throws {RequiredError}
+     * @memberof SettlementsApi
+     */
+    public addSettlementEntry(requestParameters: SettlementsApiAddSettlementEntryRequest, options?: AxiosRequestConfig) {
+        return SettlementsApiFp(this.configuration).addSettlementEntry(requestParameters.settlementCode, requestParameters.addSettlementEntryRequestBodyDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 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.
+     * @throws {RequiredError}
+     * @memberof SettlementsApi
+     */
+    public createSettlement(requestParameters: SettlementsApiCreateSettlementRequest, options?: AxiosRequestConfig) {
+        return SettlementsApiFp(this.configuration).createSettlement(requestParameters.createSettlementRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 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.
+     * @throws {RequiredError}
+     * @memberof SettlementsApi
+     */
+    public deleteSettlement(requestParameters: SettlementsApiDeleteSettlementRequest, options?: AxiosRequestConfig) {
+        return SettlementsApiFp(this.configuration).deleteSettlement(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 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.
+     * @throws {RequiredError}
+     * @memberof SettlementsApi
+     */
+    public getSettlement(requestParameters: SettlementsApiGetSettlementRequest, options?: AxiosRequestConfig) {
+        return SettlementsApiFp(this.configuration).getSettlement(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 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.
+     * @throws {RequiredError}
+     * @memberof SettlementsApi
+     */
+    public listSettlements(requestParameters: SettlementsApiListSettlementsRequest = {}, options?: AxiosRequestConfig) {
+        return SettlementsApiFp(this.configuration).listSettlements(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
+    }
+}