pipedrive 25.0.0 → 26.0.0

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

@@ -139,6 +139,40 @@ export const DealsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
+         * @summary Convert a deal to a lead (BETA)
+         * @param {number} id The ID of the deal to convert
+
+         * @throws {RequiredError}
+         */
+        convertDealToLead: (id) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('convertDealToLead', 'id', id);
+            const localVarPath = `/deals/{id}/convert/lead`
+                .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", "leads: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,
+            };
+        }),
         /**
          * Removes a discount from a deal, changing the deal value if the deal has one-time products attached.
          * @summary Delete a discount from a deal
@@ -359,6 +393,100 @@ export const DealsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Returns data about all archived deals.
+         * @summary Get all archived deals
+         * @param {number} [filter_id] If supplied, only deals matching the specified filter are returned
+         * @param {string} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
+         * @param {number} [owner_id] If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
+         * @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
+         * @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
+         * @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
+         * @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
+         * @param {'open' | 'won' | 'lost' | 'deleted'} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. Multiple statuses can be included as a comma separated array. If filter_id is provided, this is ignored.
+         * @param {string} [updated_since] If set, only deals with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
+         * @param {string} [updated_until] If set, only deals with an &#x60;update_time&#x60; earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
+         * @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;.
+         * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
+         * @param {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time'} [include_fields] Optional comma separated string array of additional fields to include
+         * @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
+         * @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}
+         */
+        getArchivedDeals: (filter_id, ids, owner_id, person_id, org_id, pipeline_id, stage_id, status, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = `/deals/archived`;
+            // 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 (filter_id !== undefined) {
+                localVarQueryParameter['filter_id'] = filter_id;
+            }
+            if (ids !== undefined) {
+                localVarQueryParameter['ids'] = ids;
+            }
+            if (owner_id !== undefined) {
+                localVarQueryParameter['owner_id'] = owner_id;
+            }
+            if (person_id !== undefined) {
+                localVarQueryParameter['person_id'] = person_id;
+            }
+            if (org_id !== undefined) {
+                localVarQueryParameter['org_id'] = org_id;
+            }
+            if (pipeline_id !== undefined) {
+                localVarQueryParameter['pipeline_id'] = pipeline_id;
+            }
+            if (stage_id !== undefined) {
+                localVarQueryParameter['stage_id'] = stage_id;
+            }
+            if (status !== undefined) {
+                localVarQueryParameter['status'] = status;
+            }
+            if (updated_since !== undefined) {
+                localVarQueryParameter['updated_since'] = updated_since;
+            }
+            if (updated_until !== undefined) {
+                localVarQueryParameter['updated_until'] = updated_until;
+            }
+            if (sort_by !== undefined) {
+                localVarQueryParameter['sort_by'] = sort_by;
+            }
+            if (sort_direction !== undefined) {
+                localVarQueryParameter['sort_direction'] = sort_direction;
+            }
+            if (include_fields !== undefined) {
+                localVarQueryParameter['include_fields'] = include_fields;
+            }
+            if (custom_fields !== undefined) {
+                localVarQueryParameter['custom_fields'] = custom_fields;
+            }
+            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,
+            };
+        }),
         /**
          * Returns the details of a specific deal.
          * @summary Get details of a deal
@@ -401,6 +529,44 @@ export const DealsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
+         * @summary Get Deal conversion status (BETA)
+         * @param {number} id The ID of a deal
+         * @param {string} conversion_id The ID of the conversion
+
+         * @throws {RequiredError}
+         */
+        getDealConversionStatus: (id, conversion_id) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getDealConversionStatus', 'id', id);
+            // verify required parameter 'conversion_id' is not null or undefined
+            assertParamExists('getDealConversionStatus', 'conversion_id', conversion_id);
+            const localVarPath = `/deals/{id}/convert/status/{conversion_id}`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)))
+                .replace(`{${"conversion_id"}}`, encodeURIComponent(String(conversion_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"], 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 users who are following the deal.
          * @summary List followers of a deal
@@ -536,7 +702,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Returns data about all deals.
+         * Returns data about all not archived deals.
          * @summary Get all deals
          * @param {number} [filter_id] If supplied, only deals matching the specified filter are returned
          * @param {string} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
@@ -1085,6 +1251,19 @@ export const DealsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
+         * @summary Convert a deal to a lead (BETA)
+         * @param {number} id The ID of the deal to convert
+
+         * @throws {RequiredError}
+         */
+        convertDealToLead(id) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.convertDealToLead(id);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
         /**
          * Removes a discount from a deal, changing the deal value if the deal has one-time products attached.
          * @summary Delete a discount from a deal
@@ -1167,6 +1346,34 @@ export const DealsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Returns data about all archived deals.
+         * @summary Get all archived deals
+         * @param {number} [filter_id] If supplied, only deals matching the specified filter are returned
+         * @param {string} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
+         * @param {number} [owner_id] If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
+         * @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
+         * @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
+         * @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
+         * @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
+         * @param {'open' | 'won' | 'lost' | 'deleted'} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. Multiple statuses can be included as a comma separated array. If filter_id is provided, this is ignored.
+         * @param {string} [updated_since] If set, only deals with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
+         * @param {string} [updated_until] If set, only deals with an &#x60;update_time&#x60; earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
+         * @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;.
+         * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
+         * @param {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time'} [include_fields] Optional comma separated string array of additional fields to include
+         * @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
+         * @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}
+         */
+        getArchivedDeals(filter_id, ids, owner_id, person_id, org_id, pipeline_id, stage_id, status, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, limit, cursor) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getArchivedDeals(filter_id, ids, owner_id, person_id, org_id, pipeline_id, stage_id, status, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, limit, cursor);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
         /**
          * Returns the details of a specific deal.
          * @summary Get details of a deal
@@ -1182,6 +1389,20 @@ export const DealsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
+         * @summary Get Deal conversion status (BETA)
+         * @param {number} id The ID of a deal
+         * @param {string} conversion_id The ID of the conversion
+
+         * @throws {RequiredError}
+         */
+        getDealConversionStatus(id, conversion_id) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealConversionStatus(id, conversion_id);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
         /**
          * Lists users who are following the deal.
          * @summary List followers of a deal
@@ -1230,7 +1451,7 @@ export const DealsApiFp = function (configuration) {
             });
         },
         /**
-         * Returns data about all deals.
+         * Returns data about all not archived deals.
          * @summary Get all deals
          * @param {number} [filter_id] If supplied, only deals matching the specified filter are returned
          * @param {string} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
@@ -1438,6 +1659,16 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
         addDealProduct(requestParameters) {
             return localVarFp.addDealProduct(requestParameters.id, requestParameters.AddDealProductRequest).then((request) => request(axios, basePath));
         },
+        /**
+         * Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
+         * @summary Convert a deal to a lead (BETA)
+         * @param {DealsApiConvertDealToLeadRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        convertDealToLead(requestParameters) {
+            return localVarFp.convertDealToLead(requestParameters.id).then((request) => request(axios, basePath));
+        },
         /**
          * Removes a discount from a deal, changing the deal value if the deal has one-time products attached.
          * @summary Delete a discount from a deal
@@ -1498,6 +1729,16 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
         getAdditionalDiscounts(requestParameters) {
             return localVarFp.getAdditionalDiscounts(requestParameters.id).then((request) => request(axios, basePath));
         },
+        /**
+         * Returns data about all archived deals.
+         * @summary Get all archived deals
+         * @param {DealsApiGetArchivedDealsRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getArchivedDeals(requestParameters = {}) {
+            return localVarFp.getArchivedDeals(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.person_id, requestParameters.org_id, requestParameters.pipeline_id, requestParameters.stage_id, requestParameters.status, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
+        },
         /**
          * Returns the details of a specific deal.
          * @summary Get details of a deal
@@ -1508,6 +1749,16 @@ 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));
         },
+        /**
+         * Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
+         * @summary Get Deal conversion status (BETA)
+         * @param {DealsApiGetDealConversionStatusRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getDealConversionStatus(requestParameters) {
+            return localVarFp.getDealConversionStatus(requestParameters.id, requestParameters.conversion_id).then((request) => request(axios, basePath));
+        },
         /**
          * Lists users who are following the deal.
          * @summary List followers of a deal
@@ -1539,7 +1790,7 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getDealProducts(requestParameters.id, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(axios, basePath));
         },
         /**
-         * Returns data about all deals.
+         * Returns data about all not archived deals.
          * @summary Get all deals
          * @param {DealsApiGetDealsRequest} requestParameters Request parameters.
 
@@ -1680,6 +1931,17 @@ export class DealsApi extends BaseAPI {
     addDealProduct(requestParameters) {
         return DealsApiFp(this.configuration).addDealProduct(requestParameters.id, requestParameters.AddDealProductRequest).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
+     * @summary Convert a deal to a lead (BETA)
+     * @param {DealsApiConvertDealToLeadRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    convertDealToLead(requestParameters) {
+        return DealsApiFp(this.configuration).convertDealToLead(requestParameters.id).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Removes a discount from a deal, changing the deal value if the deal has one-time products attached.
      * @summary Delete a discount from a deal
@@ -1746,6 +2008,17 @@ export class DealsApi extends BaseAPI {
     getAdditionalDiscounts(requestParameters) {
         return DealsApiFp(this.configuration).getAdditionalDiscounts(requestParameters.id).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Returns data about all archived deals.
+     * @summary Get all archived deals
+     * @param {DealsApiGetArchivedDealsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    getArchivedDeals(requestParameters = {}) {
+        return DealsApiFp(this.configuration).getArchivedDeals(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.person_id, requestParameters.org_id, requestParameters.pipeline_id, requestParameters.stage_id, requestParameters.status, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Returns the details of a specific deal.
      * @summary Get details of a deal
@@ -1757,6 +2030,17 @@ 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));
     }
+    /**
+     * Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
+     * @summary Get Deal conversion status (BETA)
+     * @param {DealsApiGetDealConversionStatusRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    getDealConversionStatus(requestParameters) {
+        return DealsApiFp(this.configuration).getDealConversionStatus(requestParameters.id, requestParameters.conversion_id).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Lists users who are following the deal.
      * @summary List followers of a deal
@@ -1791,7 +2075,7 @@ export class DealsApi extends BaseAPI {
         return DealsApiFp(this.configuration).getDealProducts(requestParameters.id, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Returns data about all deals.
+     * Returns data about all not archived deals.
      * @summary Get all deals
      * @param {DealsApiGetDealsRequest} requestParameters Request parameters.
 

package/dist/esm/versions/v2/api/leads-api.d.ts

@@ -12,12 +12,33 @@
 import type { Configuration } from '../configuration';
 import type { AxiosInstance } from 'axios';
 import { RequestArgs, BaseAPI } from '../base';
+import { AddConvertLeadToDealResponse } from '../models';
+import { ConvertLeadToDealRequest } from '../models';
+import { GetConvertResponse1 } from '../models';
 import { GetLeadSearchResponse } from '../models';
 /**
  * LeadsApi - axios parameter creator
  * @export
  */
 export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Initiates a conversion of a lead to a deal. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. If the conversion is successful, the lead is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#getLeadConversionStatus\">/api/v2/leads/{lead_id}/convert/status/{conversion_id}</a> endpoint.
+     * @summary Convert a lead to a deal (BETA)
+     * @param {string} id The ID of the lead to convert
+     * @param {ConvertLeadToDealRequest} [ConvertLeadToDealRequest]
+
+     * @throws {RequiredError}
+     */
+    convertLeadToDeal: (id: string, ConvertLeadToDealRequest?: ConvertLeadToDealRequest) => Promise<RequestArgs>;
+    /**
+     * Returns data about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Deal ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
+     * @summary Get Lead conversion status (BETA)
+     * @param {string} id The ID of a lead
+     * @param {string} conversion_id The ID of the conversion
+
+     * @throws {RequiredError}
+     */
+    getLeadConversionStatus: (id: string, conversion_id: string) => Promise<RequestArgs>;
     /**
      * Searches all leads 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 leads can be filtered by the person ID and the organization ID.
      * @summary Search leads
@@ -39,6 +60,24 @@ export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration)
  * @export
  */
 export declare const LeadsApiFp: (configuration?: Configuration) => {
+    /**
+     * Initiates a conversion of a lead to a deal. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. If the conversion is successful, the lead is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#getLeadConversionStatus\">/api/v2/leads/{lead_id}/convert/status/{conversion_id}</a> endpoint.
+     * @summary Convert a lead to a deal (BETA)
+     * @param {string} id The ID of the lead to convert
+     * @param {ConvertLeadToDealRequest} [ConvertLeadToDealRequest]
+
+     * @throws {RequiredError}
+     */
+    convertLeadToDeal(id: string, ConvertLeadToDealRequest?: ConvertLeadToDealRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddConvertLeadToDealResponse>>;
+    /**
+     * Returns data about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Deal ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
+     * @summary Get Lead conversion status (BETA)
+     * @param {string} id The ID of a lead
+     * @param {string} conversion_id The ID of the conversion
+
+     * @throws {RequiredError}
+     */
+    getLeadConversionStatus(id: string, conversion_id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetConvertResponse1>>;
     /**
      * Searches all leads 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 leads can be filtered by the person ID and the organization ID.
      * @summary Search leads
@@ -60,6 +99,22 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const LeadsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Initiates a conversion of a lead to a deal. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. If the conversion is successful, the lead is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#getLeadConversionStatus\">/api/v2/leads/{lead_id}/convert/status/{conversion_id}</a> endpoint.
+     * @summary Convert a lead to a deal (BETA)
+     * @param {LeadsApiConvertLeadToDealRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    convertLeadToDeal(requestParameters: LeadsApiConvertLeadToDealRequest): Promise<AddConvertLeadToDealResponse>;
+    /**
+     * Returns data about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Deal ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
+     * @summary Get Lead conversion status (BETA)
+     * @param {LeadsApiGetLeadConversionStatusRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getLeadConversionStatus(requestParameters: LeadsApiGetLeadConversionStatusRequest): Promise<GetConvertResponse1>;
     /**
      * Searches all leads 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 leads can be filtered by the person ID and the organization ID.
      * @summary Search leads
@@ -69,6 +124,44 @@ export declare const LeadsApiFactory: (configuration?: Configuration, basePath?:
      */
     searchLeads(requestParameters: LeadsApiSearchLeadsRequest): Promise<GetLeadSearchResponse>;
 };
+/**
+ * Request parameters for convertLeadToDeal operation in LeadsApi.
+ * @export
+ * @interface LeadsApiConvertLeadToDealRequest
+ */
+export interface LeadsApiConvertLeadToDealRequest {
+    /**
+     * The ID of the lead to convert
+     * @type {string}
+     * @memberof LeadsApiConvertLeadToDeal
+     */
+    readonly id: string;
+    /**
+     *
+     * @type {ConvertLeadToDealRequest}
+     * @memberof LeadsApiConvertLeadToDeal
+     */
+    readonly ConvertLeadToDealRequest?: ConvertLeadToDealRequest;
+}
+/**
+ * Request parameters for getLeadConversionStatus operation in LeadsApi.
+ * @export
+ * @interface LeadsApiGetLeadConversionStatusRequest
+ */
+export interface LeadsApiGetLeadConversionStatusRequest {
+    /**
+     * The ID of a lead
+     * @type {string}
+     * @memberof LeadsApiGetLeadConversionStatus
+     */
+    readonly id: string;
+    /**
+     * The ID of the conversion
+     * @type {string}
+     * @memberof LeadsApiGetLeadConversionStatus
+     */
+    readonly conversion_id: string;
+}
 /**
  * Request parameters for searchLeads operation in LeadsApi.
  * @export
@@ -131,6 +224,24 @@ export interface LeadsApiSearchLeadsRequest {
  * @extends {BaseAPI}
  */
 export declare class LeadsApi extends BaseAPI {
+    /**
+     * Initiates a conversion of a lead to a deal. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. If the conversion is successful, the lead is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#getLeadConversionStatus\">/api/v2/leads/{lead_id}/convert/status/{conversion_id}</a> endpoint.
+     * @summary Convert a lead to a deal (BETA)
+     * @param {LeadsApiConvertLeadToDealRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof LeadsApi
+     */
+    convertLeadToDeal(requestParameters: LeadsApiConvertLeadToDealRequest): Promise<AddConvertLeadToDealResponse>;
+    /**
+     * Returns data about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Deal ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
+     * @summary Get Lead conversion status (BETA)
+     * @param {LeadsApiGetLeadConversionStatusRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof LeadsApi
+     */
+    getLeadConversionStatus(requestParameters: LeadsApiGetLeadConversionStatusRequest): Promise<GetConvertResponse1>;
     /**
      * Searches all leads 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 leads can be filtered by the person ID and the organization ID.
      * @summary Search leads