From 6c6def141b0b5579c79a3e50333399a2619e37c2 Mon Sep 17 00:00:00 2001 From: pipedrive-bot Date: Thu, 29 Jan 2026 08:50:45 +0000 Subject: [PATCH] Build 308 - version-minor --- CHANGELOG.md | 16 ++++++++++++++++ docs/v2.md | 20 ++++---------------- src/versions/v1/api/leads-api.ts | 23 ++++++++++++++++++----- src/versions/v1/api/notes-api.ts | 25 ++++++++++++++++++++----- src/versions/v2/api.ts | 1 - src/versions/v2/api/deals-api.ts | 16 ++++++++-------- src/versions/v2/api/leads-api.ts | 16 ++++++++-------- 7 files changed, 74 insertions(+), 43 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 710220b7..091ebef2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,22 @@ The file format of it is based on [Keep a Changelog](http://keepachangelog.com/e For public Changelog covering all changes done to Pipedrive’s API, webhooks and app extensions platforms, see [public Changelog](https://pipedrive.readme.io/docs/changelog) with discussion area in [Developers Community](https://devcommunity.pipedrive.com/c/documentation/changelog/19). ## [Unreleased] +### Changed +- Removed beta labels from v2 lead/deal conversion endpoints: + - `GET /api/v2/leads/{id}/convert/status/{conversion_id}` + - `POST /api/v2/leads/{id}/convert` + - `GET /api/v2/deals/{id}/convert/status/{conversion_id}` + - `POST /api/v2/deals/{id}/convert` +- Removed beta labels from v2 deal installments endpoints: + - `GET /api/v2/deals/installments` + - `POST /api/v2/deals/{id}/installments` + - `PATCH /api/v2/deals/{id}/installments/{installment_id}` + - `DELETE /api/v2/deals/{id}/installments/{installment_id}` +- Removed beta labels from v2 product images endpoints: + - `GET /api/v2/products/{id}/images` + - `POST /api/v2/products/{id}/images` + - `PUT /api/v2/products/{id}/images` + - `DELETE /api/v2/products/{id}/images` ## [31.0.0] - 2026-01-27 ### Removed diff --git a/docs/v2.md b/docs/v2.md index f023f2bd..5d56438b 100644 --- a/docs/v2.md +++ b/docs/v2.md @@ -11,18 +11,6 @@ ActivitiesApi | getActivity | **GET** /activities/{id} | Get details of an activ ActivitiesApi | updateActivity | **PATCH** /activities/{id} | Update an activity ActivityFieldsApi | getActivityField | **GET** /activityFields/{field_code} | Get one activity field ActivityFieldsApi | getActivityFields | **GET** /activityFields | Get all activity fields -BetaApi | convertDealToLead | **POST** /deals/{id}/convert/lead | Convert a deal to a lead (BETA) -BetaApi | convertLeadToDeal | **POST** /leads/{id}/convert/deal | Convert a lead to a deal (BETA) -BetaApi | deleteInstallment | **DELETE** /deals/{id}/installments/{installment_id} | Delete an installment from a deal -BetaApi | deleteProductImage | **DELETE** /products/{id}/images | Delete an image of a product -BetaApi | getDealConversionStatus | **GET** /deals/{id}/convert/status/{conversion_id} | Get Deal conversion status (BETA) -BetaApi | getInstallments | **GET** /deals/installments | List installments added to a list of deals -BetaApi | getLeadConversionStatus | **GET** /leads/{id}/convert/status/{conversion_id} | Get Lead conversion status (BETA) -BetaApi | getProductImage | **GET** /products/{id}/images | Get image of a product -BetaApi | postInstallment | **POST** /deals/{id}/installments | Add an installment to a deal -BetaApi | updateInstallment | **PATCH** /deals/{id}/installments/{installment_id} | Update an installment added to a deal -BetaApi | updateProductImage | **PUT** /products/{id}/images | Update an image for a product -BetaApi | uploadProductImage | **POST** /products/{id}/images | Upload an image for a product DealFieldsApi | addDealField | **POST** /dealFields | Create one deal field DealFieldsApi | addDealFieldOptions | **POST** /dealFields/{field_code}/options | Add deal field options in bulk DealFieldsApi | deleteDealField | **DELETE** /dealFields/{field_code} | Delete one deal field @@ -35,7 +23,7 @@ DealsApi | addDeal | **POST** /deals | Add a new deal DealsApi | addDealFollower | **POST** /deals/{id}/followers | Add a follower to a deal DealsApi | addDealProduct | **POST** /deals/{id}/products | Add a product to a deal DealsApi | addManyDealProducts | **POST** /deals/{id}/products/bulk | Add multiple products to a deal -DealsApi | convertDealToLead | **POST** /deals/{id}/convert/lead | Convert a deal to a lead (BETA) +DealsApi | convertDealToLead | **POST** /deals/{id}/convert/lead | Convert a deal to a lead DealsApi | deleteAdditionalDiscount | **DELETE** /deals/{id}/discounts/{discount_id} | Delete a discount from a deal DealsApi | deleteDeal | **DELETE** /deals/{id} | Delete a deal DealsApi | deleteDealFollower | **DELETE** /deals/{id}/followers/{follower_id} | Delete a follower from a deal @@ -45,7 +33,7 @@ DealsApi | deleteManyDealProducts | **DELETE** /deals/{id}/products | Delete man DealsApi | getAdditionalDiscounts | **GET** /deals/{id}/discounts | List discounts added to a deal DealsApi | getArchivedDeals | **GET** /deals/archived | Get all archived deals DealsApi | getDeal | **GET** /deals/{id} | Get details of a deal -DealsApi | getDealConversionStatus | **GET** /deals/{id}/convert/status/{conversion_id} | Get Deal conversion status (BETA) +DealsApi | getDealConversionStatus | **GET** /deals/{id}/convert/status/{conversion_id} | Get Deal conversion status DealsApi | getDealFollowers | **GET** /deals/{id}/followers | List followers of a deal DealsApi | getDealFollowersChangelog | **GET** /deals/{id}/followers/changelog | List followers changelog of a deal DealsApi | getDealProducts | **GET** /deals/{id}/products | List products attached to a deal @@ -61,8 +49,8 @@ DealsApi | updateDealProduct | **PATCH** /deals/{id}/products/{product_attachmen DealsApi | updateInstallment | **PATCH** /deals/{id}/installments/{installment_id} | Update an installment added to a deal ItemSearchApi | searchItem | **GET** /itemSearch | Perform a search from multiple item types ItemSearchApi | searchItemByField | **GET** /itemSearch/field | Perform a search using a specific field from an item type -LeadsApi | convertLeadToDeal | **POST** /leads/{id}/convert/deal | Convert a lead to a deal (BETA) -LeadsApi | getLeadConversionStatus | **GET** /leads/{id}/convert/status/{conversion_id} | Get Lead conversion status (BETA) +LeadsApi | convertLeadToDeal | **POST** /leads/{id}/convert/deal | Convert a lead to a deal +LeadsApi | getLeadConversionStatus | **GET** /leads/{id}/convert/status/{conversion_id} | Get Lead conversion status LeadsApi | searchLeads | **GET** /leads/search | Search leads OrganizationFieldsApi | addOrganizationField | **POST** /organizationFields | Create one organization field OrganizationFieldsApi | addOrganizationFieldOptions | **POST** /organizationFields/{field_code}/options | Add organization field options in bulk diff --git a/src/versions/v1/api/leads-api.ts b/src/versions/v1/api/leads-api.ts index 83c4dc5f..a71b40b5 100644 --- a/src/versions/v1/api/leads-api.ts +++ b/src/versions/v1/api/leads-api.ts @@ -288,11 +288,12 @@ export const LeadsApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied. * @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied. * @param {number} [filter_id] The ID of the filter to use + * @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z. * @param {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). * @throws {RequiredError} */ - getLeads: async (limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, sort?: 'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time', ): Promise => { + getLeads: async (limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, updated_since?: string, sort?: 'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time', ): Promise => { const localVarPath = `/leads`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -336,6 +337,10 @@ export const LeadsApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['filter_id'] = filter_id; } + if (updated_since !== undefined) { + localVarQueryParameter['updated_since'] = updated_since; + } + if (sort !== undefined) { localVarQueryParameter['sort'] = sort; } @@ -556,12 +561,13 @@ export const LeadsApiFp = function(configuration?: Configuration) { * @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied. * @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied. * @param {number} [filter_id] The ID of the filter to use + * @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z. * @param {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). * @throws {RequiredError} */ - async getLeads(limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, sort?: 'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time', ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getLeads(limit, start, owner_id, person_id, organization_id, filter_id, sort, ); + async getLeads(limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, updated_since?: string, sort?: 'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time', ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getLeads(limit, start, owner_id, person_id, organization_id, filter_id, updated_since, sort, ); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -662,7 +668,7 @@ export const LeadsApiFactory = function (configuration?: Configuration, basePath * @throws {RequiredError} */ getLeads(requestParameters: LeadsApiGetLeadsRequest = {}, ): Promise { - return localVarFp.getLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort, ).then((request) => request(axios, basePath)); + return localVarFp.getLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.updated_since, requestParameters.sort, ).then((request) => request(axios, basePath)); }, /** * Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID. @@ -847,6 +853,13 @@ export interface LeadsApiGetLeadsRequest { */ readonly filter_id?: number + /** + * If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z. + * @type {string} + * @memberof LeadsApiGetLeads + */ + readonly updated_since?: string + /** * The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). * @type {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'} @@ -1015,7 +1028,7 @@ export class LeadsApi extends BaseAPI { * @memberof LeadsApi */ public getLeads(requestParameters: LeadsApiGetLeadsRequest = {}, ) { - return LeadsApiFp(this.configuration).getLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort, ).then((request) => request(this.axios, this.basePath)); + return LeadsApiFp(this.configuration).getLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.updated_since, requestParameters.sort, ).then((request) => request(this.axios, this.basePath)); } /** diff --git a/src/versions/v1/api/notes-api.ts b/src/versions/v1/api/notes-api.ts index 2b9cdfca..19d075ff 100644 --- a/src/versions/v1/api/notes-api.ts +++ b/src/versions/v1/api/notes-api.ts @@ -368,6 +368,7 @@ export const NotesApiAxiosParamCreator = function (configuration?: Configuration * @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `content`, `add_time`, `update_time`. * @param {string} [start_date] The date in format of YYYY-MM-DD from which notes to fetch * @param {string} [end_date] The date in format of YYYY-MM-DD until which notes to fetch to + * @param {string} [updated_since] If set, only notes with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. * @param {0 | 1} [pinned_to_lead_flag] If set, the results are filtered by note to lead pinning state * @param {0 | 1} [pinned_to_deal_flag] If set, the results are filtered by note to deal pinning state * @param {0 | 1} [pinned_to_organization_flag] If set, the results are filtered by note to organization pinning state @@ -376,7 +377,7 @@ export const NotesApiAxiosParamCreator = function (configuration?: Configuration * @throws {RequiredError} */ - getNotes: async (user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_id?: number, project_id?: number, start?: number, limit?: number, sort?: string, start_date?: string, end_date?: string, pinned_to_lead_flag?: 0 | 1, pinned_to_deal_flag?: 0 | 1, pinned_to_organization_flag?: 0 | 1, pinned_to_person_flag?: 0 | 1, pinned_to_project_flag?: 0 | 1, ): Promise => { + getNotes: async (user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_id?: number, project_id?: number, start?: number, limit?: number, sort?: string, start_date?: string, end_date?: string, updated_since?: string, pinned_to_lead_flag?: 0 | 1, pinned_to_deal_flag?: 0 | 1, pinned_to_organization_flag?: 0 | 1, pinned_to_person_flag?: 0 | 1, pinned_to_project_flag?: 0 | 1, ): Promise => { const localVarPath = `/notes`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -444,6 +445,12 @@ export const NotesApiAxiosParamCreator = function (configuration?: Configuration end_date; } + if (updated_since !== undefined) { + localVarQueryParameter['updated_since'] = (updated_since as any instanceof Date) ? + (updated_since as any).toISOString() : + updated_since; + } + if (pinned_to_lead_flag !== undefined) { localVarQueryParameter['pinned_to_lead_flag'] = pinned_to_lead_flag; } @@ -676,6 +683,7 @@ export const NotesApiFp = function(configuration?: Configuration) { * @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `content`, `add_time`, `update_time`. * @param {string} [start_date] The date in format of YYYY-MM-DD from which notes to fetch * @param {string} [end_date] The date in format of YYYY-MM-DD until which notes to fetch to + * @param {string} [updated_since] If set, only notes with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. * @param {0 | 1} [pinned_to_lead_flag] If set, the results are filtered by note to lead pinning state * @param {0 | 1} [pinned_to_deal_flag] If set, the results are filtered by note to deal pinning state * @param {0 | 1} [pinned_to_organization_flag] If set, the results are filtered by note to organization pinning state @@ -684,8 +692,8 @@ export const NotesApiFp = function(configuration?: Configuration) { * @throws {RequiredError} */ - async getNotes(user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_id?: number, project_id?: number, start?: number, limit?: number, sort?: string, start_date?: string, end_date?: string, pinned_to_lead_flag?: 0 | 1, pinned_to_deal_flag?: 0 | 1, pinned_to_organization_flag?: 0 | 1, pinned_to_person_flag?: 0 | 1, pinned_to_project_flag?: 0 | 1, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNotes(user_id, lead_id, deal_id, person_id, org_id, project_id, start, limit, sort, start_date, end_date, pinned_to_lead_flag, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag, pinned_to_project_flag, ); + async getNotes(user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_id?: number, project_id?: number, start?: number, limit?: number, sort?: string, start_date?: string, end_date?: string, updated_since?: string, pinned_to_lead_flag?: 0 | 1, pinned_to_deal_flag?: 0 | 1, pinned_to_organization_flag?: 0 | 1, pinned_to_person_flag?: 0 | 1, pinned_to_project_flag?: 0 | 1, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getNotes(user_id, lead_id, deal_id, person_id, org_id, project_id, start, limit, sort, start_date, end_date, updated_since, pinned_to_lead_flag, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag, pinned_to_project_flag, ); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -801,7 +809,7 @@ export const NotesApiFactory = function (configuration?: Configuration, basePath * @throws {RequiredError} */ getNotes(requestParameters: NotesApiGetNotesRequest = {}, ): Promise { - return localVarFp.getNotes(requestParameters.user_id, requestParameters.lead_id, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.project_id, requestParameters.start, requestParameters.limit, requestParameters.sort, requestParameters.start_date, requestParameters.end_date, requestParameters.pinned_to_lead_flag, requestParameters.pinned_to_deal_flag, requestParameters.pinned_to_organization_flag, requestParameters.pinned_to_person_flag, requestParameters.pinned_to_project_flag, ).then((request) => request(axios, basePath)); + return localVarFp.getNotes(requestParameters.user_id, requestParameters.lead_id, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.project_id, requestParameters.start, requestParameters.limit, requestParameters.sort, requestParameters.start_date, requestParameters.end_date, requestParameters.updated_since, requestParameters.pinned_to_lead_flag, requestParameters.pinned_to_deal_flag, requestParameters.pinned_to_organization_flag, requestParameters.pinned_to_person_flag, requestParameters.pinned_to_project_flag, ).then((request) => request(axios, basePath)); }, /** * Updates a comment related to a note. @@ -1042,6 +1050,13 @@ export interface NotesApiGetNotesRequest { */ readonly end_date?: string + /** + * If set, only notes with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. + * @type {string} + * @memberof NotesApiGetNotes + */ + readonly updated_since?: string + /** * If set, the results are filtered by note to lead pinning state * @type {0 | 1} @@ -1227,7 +1242,7 @@ export class NotesApi extends BaseAPI { * @memberof NotesApi */ public getNotes(requestParameters: NotesApiGetNotesRequest = {}, ) { - return NotesApiFp(this.configuration).getNotes(requestParameters.user_id, requestParameters.lead_id, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.project_id, requestParameters.start, requestParameters.limit, requestParameters.sort, requestParameters.start_date, requestParameters.end_date, requestParameters.pinned_to_lead_flag, requestParameters.pinned_to_deal_flag, requestParameters.pinned_to_organization_flag, requestParameters.pinned_to_person_flag, requestParameters.pinned_to_project_flag, ).then((request) => request(this.axios, this.basePath)); + return NotesApiFp(this.configuration).getNotes(requestParameters.user_id, requestParameters.lead_id, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.project_id, requestParameters.start, requestParameters.limit, requestParameters.sort, requestParameters.start_date, requestParameters.end_date, requestParameters.updated_since, requestParameters.pinned_to_lead_flag, requestParameters.pinned_to_deal_flag, requestParameters.pinned_to_organization_flag, requestParameters.pinned_to_person_flag, requestParameters.pinned_to_project_flag, ).then((request) => request(this.axios, this.basePath)); } /** diff --git a/src/versions/v2/api.ts b/src/versions/v2/api.ts index 56ca884b..84b458b3 100644 --- a/src/versions/v2/api.ts +++ b/src/versions/v2/api.ts @@ -16,7 +16,6 @@ export * from './api/activities-api'; export * from './api/activity-fields-api'; -export * from './api/beta-api'; export * from './api/deal-fields-api'; export * from './api/deals-api'; export * from './api/item-search-api'; diff --git a/src/versions/v2/api/deals-api.ts b/src/versions/v2/api/deals-api.ts index 7a54af14..f23d768f 100644 --- a/src/versions/v2/api/deals-api.ts +++ b/src/versions/v2/api/deals-api.ts @@ -273,7 +273,7 @@ export const DealsApiAxiosParamCreator = function (configuration?: 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 /api/v2/deals/{deal_id}/convert/status/{conversion_id} endpoint. - * @summary Convert a deal to a lead (BETA) + * @summary Convert a deal to a lead * @param {number} id The ID of the deal to convert * @throws {RequiredError} @@ -790,7 +790,7 @@ export const DealsApiAxiosParamCreator = function (configuration?: 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) + * @summary Get Deal conversion status * @param {number} id The ID of a deal * @param {string} conversion_id The ID of the conversion @@ -1667,7 +1667,7 @@ export const DealsApiFp = function(configuration?: 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 /api/v2/deals/{deal_id}/convert/status/{conversion_id} endpoint. - * @summary Convert a deal to a lead (BETA) + * @summary Convert a deal to a lead * @param {number} id The ID of the deal to convert * @throws {RequiredError} @@ -1799,7 +1799,7 @@ export const DealsApiFp = function(configuration?: 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) + * @summary Get Deal conversion status * @param {number} id The ID of a deal * @param {string} conversion_id The ID of the conversion @@ -2052,7 +2052,7 @@ export const DealsApiFactory = function (configuration?: Configuration, 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 /api/v2/deals/{deal_id}/convert/status/{conversion_id} endpoint. - * @summary Convert a deal to a lead (BETA) + * @summary Convert a deal to a lead * @param {DealsApiConvertDealToLeadRequest} requestParameters Request parameters. * @throws {RequiredError} @@ -2152,7 +2152,7 @@ export const DealsApiFactory = function (configuration?: Configuration, 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) + * @summary Get Deal conversion status * @param {DealsApiGetDealConversionStatusRequest} requestParameters Request parameters. * @throws {RequiredError} @@ -3260,7 +3260,7 @@ export class DealsApi extends BaseAPI { /** * 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 /api/v2/deals/{deal_id}/convert/status/{conversion_id} endpoint. - * @summary Convert a deal to a lead (BETA) + * @summary Convert a deal to a lead * @param {DealsApiConvertDealToLeadRequest} requestParameters Request parameters. * @throws {RequiredError} @@ -3380,7 +3380,7 @@ export class DealsApi extends BaseAPI { /** * 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) + * @summary Get Deal conversion status * @param {DealsApiGetDealConversionStatusRequest} requestParameters Request parameters. * @throws {RequiredError} diff --git a/src/versions/v2/api/leads-api.ts b/src/versions/v2/api/leads-api.ts index f7bdc131..0160ea7e 100644 --- a/src/versions/v2/api/leads-api.ts +++ b/src/versions/v2/api/leads-api.ts @@ -39,7 +39,7 @@ export const LeadsApiAxiosParamCreator = function (configuration?: Configuration return { /** * 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 /api/v2/leads/{lead_id}/convert/status/{conversion_id} endpoint. - * @summary Convert a lead to a deal (BETA) + * @summary Convert a lead to a deal * @param {string} id The ID of the lead to convert * @param {ConvertLeadToDealRequest} [ConvertLeadToDealRequest] @@ -84,7 +84,7 @@ export const LeadsApiAxiosParamCreator = function (configuration?: Configuration }, /** * 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) + * @summary Get Lead conversion status * @param {string} id The ID of a lead * @param {string} conversion_id The ID of the conversion @@ -219,7 +219,7 @@ export const LeadsApiFp = function(configuration?: Configuration) { return { /** * 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 /api/v2/leads/{lead_id}/convert/status/{conversion_id} endpoint. - * @summary Convert a lead to a deal (BETA) + * @summary Convert a lead to a deal * @param {string} id The ID of the lead to convert * @param {ConvertLeadToDealRequest} [ConvertLeadToDealRequest] @@ -231,7 +231,7 @@ export const LeadsApiFp = function(configuration?: Configuration) { }, /** * 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) + * @summary Get Lead conversion status * @param {string} id The ID of a lead * @param {string} conversion_id The ID of the conversion @@ -271,7 +271,7 @@ export const LeadsApiFactory = function (configuration?: Configuration, basePath return { /** * 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 /api/v2/leads/{lead_id}/convert/status/{conversion_id} endpoint. - * @summary Convert a lead to a deal (BETA) + * @summary Convert a lead to a deal * @param {LeadsApiConvertLeadToDealRequest} requestParameters Request parameters. * @throws {RequiredError} @@ -281,7 +281,7 @@ export const LeadsApiFactory = function (configuration?: Configuration, basePath }, /** * 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) + * @summary Get Lead conversion status * @param {LeadsApiGetLeadConversionStatusRequest} requestParameters Request parameters. * @throws {RequiredError} @@ -416,7 +416,7 @@ export interface LeadsApiSearchLeadsRequest { export 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 /api/v2/leads/{lead_id}/convert/status/{conversion_id} endpoint. - * @summary Convert a lead to a deal (BETA) + * @summary Convert a lead to a deal * @param {LeadsApiConvertLeadToDealRequest} requestParameters Request parameters. * @throws {RequiredError} @@ -428,7 +428,7 @@ export class LeadsApi extends BaseAPI { /** * 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) + * @summary Get Lead conversion status * @param {LeadsApiGetLeadConversionStatusRequest} requestParameters Request parameters. * @throws {RequiredError}