pipedrive 24.1.1 → 25.0.0

package/dist/esm/versions/v2/api/deals-api.js

@@ -65,6 +65,43 @@ export const DealsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Adds a user as a follower to the deal.
+         * @summary Add a follower to a deal
+         * @param {number} id The ID of the deal
+         * @param {AddDealFollowerRequest} [AddDealFollowerRequest]
+
+         * @throws {RequiredError}
+         */
+        addDealFollower: (id, AddDealFollowerRequest) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('addDealFollower', 'id', id);
+            const localVarPath = `/deals/{id}/followers`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, 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 setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:full"], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            localVarRequestOptions.data = serializeDataIfNeeded(AddDealFollowerRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Adds a product to a deal, creating a new item called a deal-product.
          * @summary Add a product to a deal
@@ -174,6 +211,44 @@ export const DealsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Deletes a user follower from the deal.
+         * @summary Delete a follower from a deal
+         * @param {number} id The ID of the deal
+         * @param {number} follower_id The ID of the following user
+
+         * @throws {RequiredError}
+         */
+        deleteDealFollower: (id, follower_id) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('deleteDealFollower', 'id', id);
+            // verify required parameter 'follower_id' is not null or undefined
+            assertParamExists('deleteDealFollower', 'follower_id', follower_id);
+            const localVarPath = `/deals/{id}/followers/{follower_id}`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)))
+                .replace(`{${"follower_id"}}`, encodeURIComponent(String(follower_id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, 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 setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:full"], configuration);
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Deletes a product attachment from a deal, using the `product_attachment_id`.
          * @summary Delete an attached product from a deal
@@ -212,6 +287,44 @@ export const DealsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Removes an installment from a deal.  Only available in Advanced 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
+            assertParamExists('deleteInstallment', 'id', id);
+            // verify required parameter 'installment_id' is not null or undefined
+            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, 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 setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration);
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Lists discounts attached to a deal.
          * @summary List discounts added to a deal
@@ -288,6 +401,90 @@ export const DealsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Lists users who are following the deal.
+         * @summary List followers of a deal
+         * @param {number} id The ID of the deal
+         * @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 {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+
+         * @throws {RequiredError}
+         */
+        getDealFollowers: (id, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getDealFollowers', 'id', id);
+            const localVarPath = `/deals/{id}/followers`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, 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 setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration);
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+            if (cursor !== undefined) {
+                localVarQueryParameter['cursor'] = cursor;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Lists changelogs about users have followed the deal.
+         * @summary List followers changelog of a deal
+         * @param {number} id The ID of the deal
+         * @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 {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+
+         * @throws {RequiredError}
+         */
+        getDealFollowersChangelog: (id, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getDealFollowersChangelog', 'id', id);
+            const localVarPath = `/deals/{id}/followers/changelog`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, 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 setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration);
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+            if (cursor !== undefined) {
+                localVarQueryParameter['cursor'] = cursor;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Lists products attached to a deal.
          * @summary List products attached to a deal
@@ -484,6 +681,58 @@ export const DealsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Lists installments attached to a list of deals.  Only available in Advanced 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
+            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, 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 setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield 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;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Adds a discount to a deal changing, the deal value if the deal has one-time products attached.
          * @summary Add a discount to a deal
@@ -521,6 +770,43 @@ export const DealsApiAxiosParamCreator = function (configuration) {
                 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 Advanced 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
+            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, 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 setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            localVarRequestOptions.data = serializeDataIfNeeded(AddInstallmentRequestBody, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID.
          * @summary Search deals
@@ -708,6 +994,47 @@ export const DealsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Edits an installment added to a deal.  Only available in Advanced 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
+            assertParamExists('updateInstallment', 'id', id);
+            // verify required parameter 'installment_id' is not null or undefined
+            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, 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 setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            localVarRequestOptions.data = serializeDataIfNeeded(UpdateInstallmentRequestBody, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
     };
 };
 /**
@@ -730,6 +1057,20 @@ export const DealsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Adds a user as a follower to the deal.
+         * @summary Add a follower to a deal
+         * @param {number} id The ID of the deal
+         * @param {AddDealFollowerRequest} [AddDealFollowerRequest]
+
+         * @throws {RequiredError}
+         */
+        addDealFollower(id, AddDealFollowerRequest) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.addDealFollower(id, AddDealFollowerRequest);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
         /**
          * Adds a product to a deal, creating a new item called a deal-product.
          * @summary Add a product to a deal
@@ -771,6 +1112,20 @@ export const DealsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Deletes a user follower from the deal.
+         * @summary Delete a follower from a deal
+         * @param {number} id The ID of the deal
+         * @param {number} follower_id The ID of the following user
+
+         * @throws {RequiredError}
+         */
+        deleteDealFollower(id, follower_id) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteDealFollower(id, follower_id);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
         /**
          * Deletes a product attachment from a deal, using the `product_attachment_id`.
          * @summary Delete an attached product from a deal
@@ -785,6 +1140,20 @@ export const DealsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Removes an installment from a deal.  Only available in Advanced 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 createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
         /**
          * Lists discounts attached to a deal.
          * @summary List discounts added to a deal
@@ -813,6 +1182,36 @@ export const DealsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Lists users who are following the deal.
+         * @summary List followers of a deal
+         * @param {number} id The ID of the deal
+         * @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 {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+
+         * @throws {RequiredError}
+         */
+        getDealFollowers(id, limit, cursor) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealFollowers(id, limit, cursor);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Lists changelogs about users have followed the deal.
+         * @summary List followers changelog of a deal
+         * @param {number} id The ID of the deal
+         * @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 {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+
+         * @throws {RequiredError}
+         */
+        getDealFollowersChangelog(id, limit, cursor) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealFollowersChangelog(id, limit, cursor);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
         /**
          * Lists products attached to a deal.
          * @summary List products attached to a deal
@@ -875,6 +1274,23 @@ export const DealsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Lists installments attached to a list of deals.  Only available in Advanced 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 createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
         /**
          * Adds a discount to a deal changing, the deal value if the deal has one-time products attached.
          * @summary Add a discount to a deal
@@ -889,6 +1305,20 @@ export const DealsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, 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 Advanced 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 createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
         /**
          * Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID.
          * @summary Search deals
@@ -954,6 +1384,21 @@ export const DealsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Edits an installment added to a deal.  Only available in Advanced 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 createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
     };
 };
 /**
@@ -973,6 +1418,16 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
         addDeal(requestParameters = {}) {
             return localVarFp.addDeal(requestParameters.AddDealRequest).then((request) => request(axios, basePath));
         },
+        /**
+         * Adds a user as a follower to the deal.
+         * @summary Add a follower to a deal
+         * @param {DealsApiAddDealFollowerRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        addDealFollower(requestParameters) {
+            return localVarFp.addDealFollower(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(axios, basePath));
+        },
         /**
          * Adds a product to a deal, creating a new item called a deal-product.
          * @summary Add a product to a deal
@@ -1003,6 +1458,16 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
         deleteDeal(requestParameters) {
             return localVarFp.deleteDeal(requestParameters.id).then((request) => request(axios, basePath));
         },
+        /**
+         * Deletes a user follower from the deal.
+         * @summary Delete a follower from a deal
+         * @param {DealsApiDeleteDealFollowerRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        deleteDealFollower(requestParameters) {
+            return localVarFp.deleteDealFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(axios, basePath));
+        },
         /**
          * Deletes a product attachment from a deal, using the `product_attachment_id`.
          * @summary Delete an attached product from a deal
@@ -1013,6 +1478,16 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
         deleteDealProduct(requestParameters) {
             return localVarFp.deleteDealProduct(requestParameters.id, requestParameters.product_attachment_id).then((request) => request(axios, basePath));
         },
+        /**
+         * Removes an installment from a deal.  Only available in Advanced and above plans.
+         * @summary Delete an installment from a deal
+         * @param {DealsApiDeleteInstallmentRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        deleteInstallment(requestParameters) {
+            return localVarFp.deleteInstallment(requestParameters.id, requestParameters.installment_id).then((request) => request(axios, basePath));
+        },
         /**
          * Lists discounts attached to a deal.
          * @summary List discounts added to a deal
@@ -1033,6 +1508,26 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
         getDeal(requestParameters) {
             return localVarFp.getDeal(requestParameters.id, requestParameters.include_fields, requestParameters.custom_fields).then((request) => request(axios, basePath));
         },
+        /**
+         * Lists users who are following the deal.
+         * @summary List followers of a deal
+         * @param {DealsApiGetDealFollowersRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getDealFollowers(requestParameters) {
+            return localVarFp.getDealFollowers(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
+        },
+        /**
+         * Lists changelogs about users have followed the deal.
+         * @summary List followers changelog of a deal
+         * @param {DealsApiGetDealFollowersChangelogRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getDealFollowersChangelog(requestParameters) {
+            return localVarFp.getDealFollowersChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
+        },
         /**
          * Lists products attached to a deal.
          * @summary List products attached to a deal
@@ -1063,6 +1558,16 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
         getDealsProducts(requestParameters) {
             return localVarFp.getDealsProducts(requestParameters.deal_ids, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(axios, basePath));
         },
+        /**
+         * Lists installments attached to a list of deals.  Only available in Advanced and above plans.
+         * @summary List installments added to a list of deals
+         * @param {DealsApiGetInstallmentsRequest} 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 a discount to a deal changing, the deal value if the deal has one-time products attached.
          * @summary Add a discount to a deal
@@ -1073,6 +1578,16 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
         postAdditionalDiscount(requestParameters) {
             return localVarFp.postAdditionalDiscount(requestParameters.id, requestParameters.AddAdditionalDiscountRequestBody).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 Advanced and above plans.
+         * @summary Add an installment to a deal
+         * @param {DealsApiPostInstallmentRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        postInstallment(requestParameters) {
+            return localVarFp.postInstallment(requestParameters.id, requestParameters.AddInstallmentRequestBody).then((request) => request(axios, basePath));
+        },
         /**
          * Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID.
          * @summary Search deals
@@ -1113,6 +1628,16 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
         updateDealProduct(requestParameters) {
             return localVarFp.updateDealProduct(requestParameters.id, requestParameters.product_attachment_id, requestParameters.UpdateDealProductRequest).then((request) => request(axios, basePath));
         },
+        /**
+         * Edits an installment added to a deal.  Only available in Advanced and above plans.
+         * @summary Update an installment added to a deal
+         * @param {DealsApiUpdateInstallmentRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        updateInstallment(requestParameters) {
+            return localVarFp.updateInstallment(requestParameters.id, requestParameters.installment_id, requestParameters.UpdateInstallmentRequestBody).then((request) => request(axios, basePath));
+        },
     };
 };
 /**
@@ -1133,6 +1658,17 @@ export class DealsApi extends BaseAPI {
     addDeal(requestParameters = {}) {
         return DealsApiFp(this.configuration).addDeal(requestParameters.AddDealRequest).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Adds a user as a follower to the deal.
+     * @summary Add a follower to a deal
+     * @param {DealsApiAddDealFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    addDealFollower(requestParameters) {
+        return DealsApiFp(this.configuration).addDealFollower(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Adds a product to a deal, creating a new item called a deal-product.
      * @summary Add a product to a deal
@@ -1166,6 +1702,17 @@ export class DealsApi extends BaseAPI {
     deleteDeal(requestParameters) {
         return DealsApiFp(this.configuration).deleteDeal(requestParameters.id).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Deletes a user follower from the deal.
+     * @summary Delete a follower from a deal
+     * @param {DealsApiDeleteDealFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    deleteDealFollower(requestParameters) {
+        return DealsApiFp(this.configuration).deleteDealFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Deletes a product attachment from a deal, using the `product_attachment_id`.
      * @summary Delete an attached product from a deal
@@ -1177,6 +1724,17 @@ export class DealsApi extends BaseAPI {
     deleteDealProduct(requestParameters) {
         return DealsApiFp(this.configuration).deleteDealProduct(requestParameters.id, requestParameters.product_attachment_id).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Removes an installment from a deal.  Only available in Advanced and above plans.
+     * @summary Delete an installment from a deal
+     * @param {DealsApiDeleteInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    deleteInstallment(requestParameters) {
+        return DealsApiFp(this.configuration).deleteInstallment(requestParameters.id, requestParameters.installment_id).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Lists discounts attached to a deal.
      * @summary List discounts added to a deal
@@ -1199,6 +1757,28 @@ export class DealsApi extends BaseAPI {
     getDeal(requestParameters) {
         return DealsApiFp(this.configuration).getDeal(requestParameters.id, requestParameters.include_fields, requestParameters.custom_fields).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Lists users who are following the deal.
+     * @summary List followers of a deal
+     * @param {DealsApiGetDealFollowersRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    getDealFollowers(requestParameters) {
+        return DealsApiFp(this.configuration).getDealFollowers(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Lists changelogs about users have followed the deal.
+     * @summary List followers changelog of a deal
+     * @param {DealsApiGetDealFollowersChangelogRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    getDealFollowersChangelog(requestParameters) {
+        return DealsApiFp(this.configuration).getDealFollowersChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Lists products attached to a deal.
      * @summary List products attached to a deal
@@ -1232,6 +1812,17 @@ export class DealsApi extends BaseAPI {
     getDealsProducts(requestParameters) {
         return DealsApiFp(this.configuration).getDealsProducts(requestParameters.deal_ids, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Lists installments attached to a list of deals.  Only available in Advanced and above plans.
+     * @summary List installments added to a list of deals
+     * @param {DealsApiGetInstallmentsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    getInstallments(requestParameters) {
+        return DealsApiFp(this.configuration).getInstallments(requestParameters.deal_ids, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Adds a discount to a deal changing, the deal value if the deal has one-time products attached.
      * @summary Add a discount to a deal
@@ -1243,6 +1834,17 @@ export class DealsApi extends BaseAPI {
     postAdditionalDiscount(requestParameters) {
         return DealsApiFp(this.configuration).postAdditionalDiscount(requestParameters.id, requestParameters.AddAdditionalDiscountRequestBody).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 Advanced and above plans.
+     * @summary Add an installment to a deal
+     * @param {DealsApiPostInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    postInstallment(requestParameters) {
+        return DealsApiFp(this.configuration).postInstallment(requestParameters.id, requestParameters.AddInstallmentRequestBody).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID.
      * @summary Search deals
@@ -1287,4 +1889,15 @@ export class DealsApi extends BaseAPI {
     updateDealProduct(requestParameters) {
         return DealsApiFp(this.configuration).updateDealProduct(requestParameters.id, requestParameters.product_attachment_id, requestParameters.UpdateDealProductRequest).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Edits an installment added to a deal.  Only available in Advanced and above plans.
+     * @summary Update an installment added to a deal
+     * @param {DealsApiUpdateInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    updateInstallment(requestParameters) {
+        return DealsApiFp(this.configuration).updateInstallment(requestParameters.id, requestParameters.installment_id, requestParameters.UpdateInstallmentRequestBody).then((request) => request(this.axios, this.basePath));
+    }
 }