@emilgroup/settlement-sdk 0.3.1-beta.10

package/dist/api/health-api.js

@@ -0,0 +1,196 @@
+"use strict";
+/* 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.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthApi = exports.HealthApiFactory = exports.HealthApiFp = exports.HealthApiAxiosParamCreator = void 0;
+var axios_1 = __importDefault(require("axios"));
+// Some imports not used depending on template conditions
+// @ts-ignore
+var common_1 = require("../common");
+// @ts-ignore
+var base_1 = require("../base");
+/**
+ * HealthApi - axios parameter creator
+ * @export
+ */
+var HealthApiAxiosParamCreator = function (configuration) {
+    var _this = this;
+    return {
+        /**
+         *
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        check: function (options) {
+            if (options === void 0) { options = {}; }
+            return __awaiter(_this, void 0, void 0, function () {
+                var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                return __generator(this, function (_a) {
+                    localVarPath = "/settlementservice/health";
+                    localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                    if (configuration) {
+                        baseOptions = configuration.baseOptions;
+                        baseAccessToken = configuration.accessToken;
+                    }
+                    localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
+                    localVarHeaderParameter = {};
+                    localVarQueryParameter = {};
+                    (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+                    headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+                    localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+                    return [2 /*return*/, {
+                            url: (0, common_1.toPathString)(localVarUrlObj),
+                            options: localVarRequestOptions,
+                        }];
+                });
+            });
+        },
+    };
+};
+exports.HealthApiAxiosParamCreator = HealthApiAxiosParamCreator;
+/**
+ * HealthApi - functional programming interface
+ * @export
+ */
+var HealthApiFp = function (configuration) {
+    var localVarAxiosParamCreator = (0, exports.HealthApiAxiosParamCreator)(configuration);
+    return {
+        /**
+         *
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        check: function (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.check(options)];
+                        case 1:
+                            localVarAxiosArgs = _a.sent();
+                            return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
+                    }
+                });
+            });
+        },
+    };
+};
+exports.HealthApiFp = HealthApiFp;
+/**
+ * HealthApi - factory interface
+ * @export
+ */
+var HealthApiFactory = function (configuration, basePath, axios) {
+    var localVarFp = (0, exports.HealthApiFp)(configuration);
+    return {
+        /**
+         *
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        check: function (options) {
+            return localVarFp.check(options).then(function (request) { return request(axios, basePath); });
+        },
+    };
+};
+exports.HealthApiFactory = HealthApiFactory;
+/**
+ * HealthApi - object-oriented interface
+ * @export
+ * @class HealthApi
+ * @extends {BaseAPI}
+ */
+var HealthApi = /** @class */ (function (_super) {
+    __extends(HealthApi, _super);
+    function HealthApi() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof HealthApi
+     */
+    HealthApi.prototype.check = function (options) {
+        var _this = this;
+        return (0, exports.HealthApiFp)(this.configuration).check(options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
+    return HealthApi;
+}(base_1.BaseAPI));
+exports.HealthApi = HealthApi;

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

@@ -0,0 +1,393 @@
+/**
+ * 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 { 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';
+import { GetSettlementResponseClass } from '../models';
+import { ListSettlementsResponseClass } from '../models';
+/**
+ * SettlementsApi - axios parameter creator
+ * @export
+ */
+export declare const SettlementsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * 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?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * SettlementsApi - functional programming interface
+ * @export
+ */
+export declare const SettlementsApiFp: (configuration?: Configuration) => {
+    /**
+     * 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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddSettlementEntryResponseClass>>;
+    /**
+     * 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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateSettlementResponseClass>>;
+    /**
+     * 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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * 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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettlementResponseClass>>;
+    /**
+     * 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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSettlementsResponseClass>>;
+};
+/**
+ * SettlementsApi - factory interface
+ * @export
+ */
+export declare const SettlementsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+};
+/**
+ * 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 declare 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
+     */
+    addSettlementEntry(requestParameters: SettlementsApiAddSettlementEntryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AddSettlementEntryResponseClass, any, {}>>;
+    /**
+     * 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
+     */
+    createSettlement(requestParameters: SettlementsApiCreateSettlementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateSettlementResponseClass, any, {}>>;
+    /**
+     * 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
+     */
+    deleteSettlement(requestParameters: SettlementsApiDeleteSettlementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * 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
+     */
+    getSettlement(requestParameters: SettlementsApiGetSettlementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSettlementResponseClass, any, {}>>;
+    /**
+     * 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
+     */
+    listSettlements(requestParameters?: SettlementsApiListSettlementsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListSettlementsResponseClass, any, {}>>;
+}