pipedrive 32.2.0 → 33.0.0

package/dist/versions/v2/api/deal-installments-api.js

@@ -0,0 +1,384 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Pipedrive API v2
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DealInstallmentsApi = exports.DealInstallmentsApiFactory = exports.DealInstallmentsApiFp = exports.DealInstallmentsApiAxiosParamCreator = void 0;
+const axios_1 = __importDefault(require("axios"));
+// Some imports not used depending on template conditions
+// @ts-ignore
+const common_1 = require("../common");
+// @ts-ignore
+const base_1 = require("../base");
+/**
+ * DealInstallmentsApi - axios parameter creator
+ * @export
+ */
+const DealInstallmentsApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Removes an installment from a deal.  Only available in Growth and above plans.
+         * @summary Delete an installment from a deal
+         * @param {number} id The ID of the deal
+         * @param {number} installment_id The ID of the installment
+
+         * @throws {RequiredError}
+         */
+        deleteInstallment: (id, installment_id) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            (0, common_1.assertParamExists)('deleteInstallment', 'id', id);
+            // verify required parameter 'installment_id' is not null or undefined
+            (0, common_1.assertParamExists)('deleteInstallment', 'installment_id', installment_id);
+            const localVarPath = `/deals/{id}/installments/{installment_id}`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)))
+                .replace(`{${"installment_id"}}`, encodeURIComponent(String(installment_id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign({ method: 'DELETE' }, baseOptions);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication api_key required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration);
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Lists installments attached to a list of deals.  Only available in Growth and above plans.
+         * @summary List installments added to a list of deals
+         * @param {Array<number>} deal_ids An array of integers with the IDs of the deals for which the attached installments will be returned. A maximum of 100 deal IDs can be provided.
+         * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+         * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
+         * @param {'id' | 'billing_date' | 'deal_id'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;billing_date&#x60;, &#x60;deal_id&#x60;.
+         * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
+
+         * @throws {RequiredError}
+         */
+        getInstallments: (deal_ids, cursor, limit, sort_by, sort_direction) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'deal_ids' is not null or undefined
+            (0, common_1.assertParamExists)('getInstallments', 'deal_ids', deal_ids);
+            const localVarPath = `/deals/installments`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication api_key required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration);
+            if (deal_ids) {
+                localVarQueryParameter['deal_ids'] = deal_ids;
+            }
+            if (cursor !== undefined) {
+                localVarQueryParameter['cursor'] = cursor;
+            }
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+            if (sort_by !== undefined) {
+                localVarQueryParameter['sort_by'] = sort_by;
+            }
+            if (sort_direction !== undefined) {
+                localVarQueryParameter['sort_direction'] = sort_direction;
+            }
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Adds an installment to a deal.  An installment can only be added if the deal includes at least one one-time product.  If the deal contains at least one recurring product, adding installments is not allowed.  Only available in Growth and above plans.
+         * @summary Add an installment to a deal
+         * @param {number} id The ID of the deal
+         * @param {AddInstallmentRequestBody} [AddInstallmentRequestBody]
+
+         * @throws {RequiredError}
+         */
+        postInstallment: (id, AddInstallmentRequestBody) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            (0, common_1.assertParamExists)('postInstallment', 'id', id);
+            const localVarPath = `/deals/{id}/installments`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign({ method: 'POST' }, baseOptions);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication api_key required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(AddInstallmentRequestBody, localVarRequestOptions, configuration);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Edits an installment added to a deal.  Only available in Growth and above plans.
+         * @summary Update an installment added to a deal
+         * @param {number} id The ID of the deal
+         * @param {number} installment_id The ID of the installment
+         * @param {UpdateInstallmentRequestBody} [UpdateInstallmentRequestBody]
+
+         * @throws {RequiredError}
+         */
+        updateInstallment: (id, installment_id, UpdateInstallmentRequestBody) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            (0, common_1.assertParamExists)('updateInstallment', 'id', id);
+            // verify required parameter 'installment_id' is not null or undefined
+            (0, common_1.assertParamExists)('updateInstallment', 'installment_id', installment_id);
+            const localVarPath = `/deals/{id}/installments/{installment_id}`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)))
+                .replace(`{${"installment_id"}}`, encodeURIComponent(String(installment_id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign({ method: 'PATCH' }, baseOptions);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication api_key required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(UpdateInstallmentRequestBody, localVarRequestOptions, configuration);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+exports.DealInstallmentsApiAxiosParamCreator = DealInstallmentsApiAxiosParamCreator;
+/**
+ * DealInstallmentsApi - functional programming interface
+ * @export
+ */
+const DealInstallmentsApiFp = function (configuration) {
+    const localVarAxiosParamCreator = (0, exports.DealInstallmentsApiAxiosParamCreator)(configuration);
+    return {
+        /**
+         * Removes an installment from a deal.  Only available in Growth and above plans.
+         * @summary Delete an installment from a deal
+         * @param {number} id The ID of the deal
+         * @param {number} installment_id The ID of the installment
+
+         * @throws {RequiredError}
+         */
+        deleteInstallment(id, installment_id) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteInstallment(id, installment_id);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Lists installments attached to a list of deals.  Only available in Growth and above plans.
+         * @summary List installments added to a list of deals
+         * @param {Array<number>} deal_ids An array of integers with the IDs of the deals for which the attached installments will be returned. A maximum of 100 deal IDs can be provided.
+         * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+         * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
+         * @param {'id' | 'billing_date' | 'deal_id'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;billing_date&#x60;, &#x60;deal_id&#x60;.
+         * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
+
+         * @throws {RequiredError}
+         */
+        getInstallments(deal_ids, cursor, limit, sort_by, sort_direction) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getInstallments(deal_ids, cursor, limit, sort_by, sort_direction);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Adds an installment to a deal.  An installment can only be added if the deal includes at least one one-time product.  If the deal contains at least one recurring product, adding installments is not allowed.  Only available in Growth and above plans.
+         * @summary Add an installment to a deal
+         * @param {number} id The ID of the deal
+         * @param {AddInstallmentRequestBody} [AddInstallmentRequestBody]
+
+         * @throws {RequiredError}
+         */
+        postInstallment(id, AddInstallmentRequestBody) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.postInstallment(id, AddInstallmentRequestBody);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Edits an installment added to a deal.  Only available in Growth and above plans.
+         * @summary Update an installment added to a deal
+         * @param {number} id The ID of the deal
+         * @param {number} installment_id The ID of the installment
+         * @param {UpdateInstallmentRequestBody} [UpdateInstallmentRequestBody]
+
+         * @throws {RequiredError}
+         */
+        updateInstallment(id, installment_id, UpdateInstallmentRequestBody) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.updateInstallment(id, installment_id, UpdateInstallmentRequestBody);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
+    };
+};
+exports.DealInstallmentsApiFp = DealInstallmentsApiFp;
+/**
+ * DealInstallmentsApi - factory interface
+ * @export
+ */
+const DealInstallmentsApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = (0, exports.DealInstallmentsApiFp)(configuration);
+    return {
+        /**
+         * Removes an installment from a deal.  Only available in Growth and above plans.
+         * @summary Delete an installment from a deal
+         * @param {DealInstallmentsApiDeleteInstallmentRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        deleteInstallment(requestParameters) {
+            return localVarFp.deleteInstallment(requestParameters.id, requestParameters.installment_id).then((request) => request(axios, basePath));
+        },
+        /**
+         * Lists installments attached to a list of deals.  Only available in Growth and above plans.
+         * @summary List installments added to a list of deals
+         * @param {DealInstallmentsApiGetInstallmentsRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getInstallments(requestParameters) {
+            return localVarFp.getInstallments(requestParameters.deal_ids, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(axios, basePath));
+        },
+        /**
+         * Adds an installment to a deal.  An installment can only be added if the deal includes at least one one-time product.  If the deal contains at least one recurring product, adding installments is not allowed.  Only available in Growth and above plans.
+         * @summary Add an installment to a deal
+         * @param {DealInstallmentsApiPostInstallmentRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        postInstallment(requestParameters) {
+            return localVarFp.postInstallment(requestParameters.id, requestParameters.AddInstallmentRequestBody).then((request) => request(axios, basePath));
+        },
+        /**
+         * Edits an installment added to a deal.  Only available in Growth and above plans.
+         * @summary Update an installment added to a deal
+         * @param {DealInstallmentsApiUpdateInstallmentRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        updateInstallment(requestParameters) {
+            return localVarFp.updateInstallment(requestParameters.id, requestParameters.installment_id, requestParameters.UpdateInstallmentRequestBody).then((request) => request(axios, basePath));
+        },
+    };
+};
+exports.DealInstallmentsApiFactory = DealInstallmentsApiFactory;
+/**
+ * DealInstallmentsApi - object-oriented interface
+ * @export
+ * @class DealInstallmentsApi
+ * @extends {BaseAPI}
+ */
+class DealInstallmentsApi extends base_1.BaseAPI {
+    /**
+     * Removes an installment from a deal.  Only available in Growth and above plans.
+     * @summary Delete an installment from a deal
+     * @param {DealInstallmentsApiDeleteInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealInstallmentsApi
+     */
+    deleteInstallment(requestParameters) {
+        return (0, exports.DealInstallmentsApiFp)(this.configuration).deleteInstallment(requestParameters.id, requestParameters.installment_id).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Lists installments attached to a list of deals.  Only available in Growth and above plans.
+     * @summary List installments added to a list of deals
+     * @param {DealInstallmentsApiGetInstallmentsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealInstallmentsApi
+     */
+    getInstallments(requestParameters) {
+        return (0, exports.DealInstallmentsApiFp)(this.configuration).getInstallments(requestParameters.deal_ids, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Adds an installment to a deal.  An installment can only be added if the deal includes at least one one-time product.  If the deal contains at least one recurring product, adding installments is not allowed.  Only available in Growth and above plans.
+     * @summary Add an installment to a deal
+     * @param {DealInstallmentsApiPostInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealInstallmentsApi
+     */
+    postInstallment(requestParameters) {
+        return (0, exports.DealInstallmentsApiFp)(this.configuration).postInstallment(requestParameters.id, requestParameters.AddInstallmentRequestBody).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Edits an installment added to a deal.  Only available in Growth and above plans.
+     * @summary Update an installment added to a deal
+     * @param {DealInstallmentsApiUpdateInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealInstallmentsApi
+     */
+    updateInstallment(requestParameters) {
+        return (0, exports.DealInstallmentsApiFp)(this.configuration).updateInstallment(requestParameters.id, requestParameters.installment_id, requestParameters.UpdateInstallmentRequestBody).then((request) => request(this.axios, this.basePath));
+    }
+}
+exports.DealInstallmentsApi = DealInstallmentsApi;