pipedrive 24.2.0 → 26.0.0

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

@@ -15,18 +15,25 @@ import { RequestArgs, BaseAPI } from '../base';
 import { AddAInstallmentResponse } from '../models';
 import { AddAdditionalDiscountRequestBody } from '../models';
 import { AddAdditionalDiscountResponse } from '../models';
+import { AddConvertDealToLeadResponse } from '../models';
+import { AddDealFollowerRequest } from '../models';
 import { AddDealProductRequest } from '../models';
 import { AddDealProductResponse } from '../models';
 import { AddDealRequest } from '../models';
+import { AddFollowerResponse } from '../models';
 import { AddInstallmentRequestBody } from '../models';
 import { DeleteAdditionalDiscountResponse } from '../models';
 import { DeleteDealProductResponse } from '../models';
 import { DeleteDealResponse } from '../models';
+import { DeleteFollowerResponse } from '../models';
 import { DeleteInstallmentResponse } from '../models';
 import { GetAdditionalDiscountsResponse } from '../models';
+import { GetConvertResponse1 } from '../models';
 import { GetDealSearchResponse } from '../models';
 import { GetDealsProductsResponse } from '../models';
 import { GetDealsResponse } from '../models';
+import { GetFollowerChangelogsResponse } from '../models';
+import { GetFollowersResponse } from '../models';
 import { GetInstallmentsResponse } from '../models';
 import { UpdateAdditionalDiscountRequestBody } from '../models';
 import { UpdateAdditionalDiscountResponse } from '../models';
@@ -48,6 +55,15 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     addDeal: (AddDealRequest?: AddDealRequest) => Promise<RequestArgs>;
+    /**
+     * 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: number, AddDealFollowerRequest?: AddDealFollowerRequest) => Promise<RequestArgs>;
     /**
      * Adds a product to a deal, creating a new item called a deal-product.
      * @summary Add a product to a deal
@@ -57,6 +73,14 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     addDealProduct: (id: number, AddDealProductRequest?: AddDealProductRequest) => Promise<RequestArgs>;
+    /**
+     * 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: number) => Promise<RequestArgs>;
     /**
      * 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
@@ -74,6 +98,15 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     deleteDeal: (id: number) => Promise<RequestArgs>;
+    /**
+     * 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: number, follower_id: number) => Promise<RequestArgs>;
     /**
      * Deletes a product attachment from a deal, using the `product_attachment_id`.
      * @summary Delete an attached product from a deal
@@ -100,6 +133,29 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     getAdditionalDiscounts: (id: number) => Promise<RequestArgs>;
+    /**
+     * 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?: number, ids?: string, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted', updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: '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', custom_fields?: string, limit?: number, cursor?: string) => Promise<RequestArgs>;
     /**
      * Returns the details of a specific deal.
      * @summary Get details of a deal
@@ -110,6 +166,35 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     getDeal: (id: number, include_fields?: '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', custom_fields?: string) => Promise<RequestArgs>;
+    /**
+     * 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: number, conversion_id: string) => Promise<RequestArgs>;
+    /**
+     * 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: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
+    /**
+     * 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: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
     /**
      * Lists products attached to a deal.
      * @summary List products attached to a deal
@@ -123,7 +208,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      */
     getDealProducts: (id: number, cursor?: string, limit?: number, sort_by?: 'id' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc') => Promise<RequestArgs>;
     /**
-     * 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.
@@ -256,6 +341,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     addDeal(AddDealRequest?: AddDealRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertDealResponse>>;
+    /**
+     * 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: number, AddDealFollowerRequest?: AddDealFollowerRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddFollowerResponse>>;
     /**
      * Adds a product to a deal, creating a new item called a deal-product.
      * @summary Add a product to a deal
@@ -265,6 +359,14 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     addDealProduct(id: number, AddDealProductRequest?: AddDealProductRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealProductResponse>>;
+    /**
+     * 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: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddConvertDealToLeadResponse>>;
     /**
      * 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
@@ -282,6 +384,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteDeal(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteDealResponse>>;
+    /**
+     * 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: number, follower_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteFollowerResponse>>;
     /**
      * Deletes a product attachment from a deal, using the `product_attachment_id`.
      * @summary Delete an attached product from a deal
@@ -308,6 +419,29 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getAdditionalDiscounts(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAdditionalDiscountsResponse>>;
+    /**
+     * 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?: number, ids?: string, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted', updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: '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', custom_fields?: string, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsResponse>>;
     /**
      * Returns the details of a specific deal.
      * @summary Get details of a deal
@@ -318,6 +452,35 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getDeal(id: number, include_fields?: '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', custom_fields?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertDealResponse>>;
+    /**
+     * 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: number, conversion_id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetConvertResponse1>>;
+    /**
+     * 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: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFollowersResponse>>;
+    /**
+     * 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: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFollowerChangelogsResponse>>;
     /**
      * Lists products attached to a deal.
      * @summary List products attached to a deal
@@ -331,7 +494,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      */
     getDealProducts(id: number, cursor?: string, limit?: number, sort_by?: 'id' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsProductsResponse>>;
     /**
-     * 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.
@@ -464,6 +627,14 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     addDeal(requestParameters?: DealsApiAddDealRequest): Promise<UpsertDealResponse>;
+    /**
+     * 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: DealsApiAddDealFollowerRequest): Promise<AddFollowerResponse>;
     /**
      * Adds a product to a deal, creating a new item called a deal-product.
      * @summary Add a product to a deal
@@ -472,6 +643,14 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     addDealProduct(requestParameters: DealsApiAddDealProductRequest): Promise<AddDealProductResponse>;
+    /**
+     * 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: DealsApiConvertDealToLeadRequest): Promise<AddConvertDealToLeadResponse>;
     /**
      * 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
@@ -488,6 +667,14 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     deleteDeal(requestParameters: DealsApiDeleteDealRequest): Promise<DeleteDealResponse>;
+    /**
+     * Deletes a user follower from the deal.
+     * @summary Delete a follower from a deal
+     * @param {DealsApiDeleteDealFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    deleteDealFollower(requestParameters: DealsApiDeleteDealFollowerRequest): Promise<DeleteFollowerResponse>;
     /**
      * Deletes a product attachment from a deal, using the `product_attachment_id`.
      * @summary Delete an attached product from a deal
@@ -512,6 +699,14 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     getAdditionalDiscounts(requestParameters: DealsApiGetAdditionalDiscountsRequest): Promise<GetAdditionalDiscountsResponse>;
+    /**
+     * Returns data about all archived deals.
+     * @summary Get all archived deals
+     * @param {DealsApiGetArchivedDealsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getArchivedDeals(requestParameters?: DealsApiGetArchivedDealsRequest): Promise<GetDealsResponse>;
     /**
      * Returns the details of a specific deal.
      * @summary Get details of a deal
@@ -520,6 +715,30 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     getDeal(requestParameters: DealsApiGetDealRequest): Promise<UpsertDealResponse>;
+    /**
+     * 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: DealsApiGetDealConversionStatusRequest): Promise<GetConvertResponse1>;
+    /**
+     * Lists users who are following the deal.
+     * @summary List followers of a deal
+     * @param {DealsApiGetDealFollowersRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getDealFollowers(requestParameters: DealsApiGetDealFollowersRequest): Promise<GetFollowersResponse>;
+    /**
+     * Lists changelogs about users have followed the deal.
+     * @summary List followers changelog of a deal
+     * @param {DealsApiGetDealFollowersChangelogRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getDealFollowersChangelog(requestParameters: DealsApiGetDealFollowersChangelogRequest): Promise<GetFollowerChangelogsResponse>;
     /**
      * Lists products attached to a deal.
      * @summary List products attached to a deal
@@ -529,7 +748,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      */
     getDealProducts(requestParameters: DealsApiGetDealProductsRequest): Promise<GetDealsProductsResponse>;
     /**
-     * Returns data about all deals.
+     * Returns data about all not archived deals.
      * @summary Get all deals
      * @param {DealsApiGetDealsRequest} requestParameters Request parameters.
 
@@ -622,6 +841,25 @@ export interface DealsApiAddDealRequest {
      */
     readonly AddDealRequest?: AddDealRequest;
 }
+/**
+ * Request parameters for addDealFollower operation in DealsApi.
+ * @export
+ * @interface DealsApiAddDealFollowerRequest
+ */
+export interface DealsApiAddDealFollowerRequest {
+    /**
+     * The ID of the deal
+     * @type {number}
+     * @memberof DealsApiAddDealFollower
+     */
+    readonly id: number;
+    /**
+     *
+     * @type {AddDealFollowerRequest}
+     * @memberof DealsApiAddDealFollower
+     */
+    readonly AddDealFollowerRequest?: AddDealFollowerRequest;
+}
 /**
  * Request parameters for addDealProduct operation in DealsApi.
  * @export
@@ -641,6 +879,19 @@ export interface DealsApiAddDealProductRequest {
      */
     readonly AddDealProductRequest?: AddDealProductRequest;
 }
+/**
+ * Request parameters for convertDealToLead operation in DealsApi.
+ * @export
+ * @interface DealsApiConvertDealToLeadRequest
+ */
+export interface DealsApiConvertDealToLeadRequest {
+    /**
+     * The ID of the deal to convert
+     * @type {number}
+     * @memberof DealsApiConvertDealToLead
+     */
+    readonly id: number;
+}
 /**
  * Request parameters for deleteAdditionalDiscount operation in DealsApi.
  * @export
@@ -673,6 +924,25 @@ export interface DealsApiDeleteDealRequest {
      */
     readonly id: number;
 }
+/**
+ * Request parameters for deleteDealFollower operation in DealsApi.
+ * @export
+ * @interface DealsApiDeleteDealFollowerRequest
+ */
+export interface DealsApiDeleteDealFollowerRequest {
+    /**
+     * The ID of the deal
+     * @type {number}
+     * @memberof DealsApiDeleteDealFollower
+     */
+    readonly id: number;
+    /**
+     * The ID of the following user
+     * @type {number}
+     * @memberof DealsApiDeleteDealFollower
+     */
+    readonly follower_id: number;
+}
 /**
  * Request parameters for deleteDealProduct operation in DealsApi.
  * @export
@@ -724,6 +994,109 @@ export interface DealsApiGetAdditionalDiscountsRequest {
      */
     readonly id: number;
 }
+/**
+ * Request parameters for getArchivedDeals operation in DealsApi.
+ * @export
+ * @interface DealsApiGetArchivedDealsRequest
+ */
+export interface DealsApiGetArchivedDealsRequest {
+    /**
+     * If supplied, only deals matching the specified filter are returned
+     * @type {number}
+     * @memberof DealsApiGetArchivedDeals
+     */
+    readonly filter_id?: number;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof DealsApiGetArchivedDeals
+     */
+    readonly ids?: string;
+    /**
+     * If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
+     * @type {number}
+     * @memberof DealsApiGetArchivedDeals
+     */
+    readonly owner_id?: number;
+    /**
+     * If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
+     * @type {number}
+     * @memberof DealsApiGetArchivedDeals
+     */
+    readonly person_id?: number;
+    /**
+     * If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
+     * @type {number}
+     * @memberof DealsApiGetArchivedDeals
+     */
+    readonly org_id?: number;
+    /**
+     * If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
+     * @type {number}
+     * @memberof DealsApiGetArchivedDeals
+     */
+    readonly pipeline_id?: number;
+    /**
+     * If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
+     * @type {number}
+     * @memberof DealsApiGetArchivedDeals
+     */
+    readonly stage_id?: number;
+    /**
+     * 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.
+     * @type {'open' | 'won' | 'lost' | 'deleted'}
+     * @memberof DealsApiGetArchivedDeals
+     */
+    readonly status?: 'open' | 'won' | 'lost' | 'deleted';
+    /**
+     * 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.
+     * @type {string}
+     * @memberof DealsApiGetArchivedDeals
+     */
+    readonly updated_since?: string;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof DealsApiGetArchivedDeals
+     */
+    readonly updated_until?: string;
+    /**
+     * The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;.
+     * @type {'id' | 'update_time' | 'add_time'}
+     * @memberof DealsApiGetArchivedDeals
+     */
+    readonly sort_by?: 'id' | 'update_time' | 'add_time';
+    /**
+     * The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
+     * @type {'asc' | 'desc'}
+     * @memberof DealsApiGetArchivedDeals
+     */
+    readonly sort_direction?: 'asc' | 'desc';
+    /**
+     * Optional comma separated string array of additional fields to include
+     * @type {'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'}
+     * @memberof DealsApiGetArchivedDeals
+     */
+    readonly include_fields?: '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';
+    /**
+     * 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.
+     * @type {string}
+     * @memberof DealsApiGetArchivedDeals
+     */
+    readonly custom_fields?: string;
+    /**
+     * 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.
+     * @type {number}
+     * @memberof DealsApiGetArchivedDeals
+     */
+    readonly limit?: number;
+    /**
+     * For pagination, the marker (an opaque string value) representing the first item on the next page
+     * @type {string}
+     * @memberof DealsApiGetArchivedDeals
+     */
+    readonly cursor?: string;
+}
 /**
  * Request parameters for getDeal operation in DealsApi.
  * @export
@@ -749,6 +1122,75 @@ export interface DealsApiGetDealRequest {
      */
     readonly custom_fields?: string;
 }
+/**
+ * Request parameters for getDealConversionStatus operation in DealsApi.
+ * @export
+ * @interface DealsApiGetDealConversionStatusRequest
+ */
+export interface DealsApiGetDealConversionStatusRequest {
+    /**
+     * The ID of a deal
+     * @type {number}
+     * @memberof DealsApiGetDealConversionStatus
+     */
+    readonly id: number;
+    /**
+     * The ID of the conversion
+     * @type {string}
+     * @memberof DealsApiGetDealConversionStatus
+     */
+    readonly conversion_id: string;
+}
+/**
+ * Request parameters for getDealFollowers operation in DealsApi.
+ * @export
+ * @interface DealsApiGetDealFollowersRequest
+ */
+export interface DealsApiGetDealFollowersRequest {
+    /**
+     * The ID of the deal
+     * @type {number}
+     * @memberof DealsApiGetDealFollowers
+     */
+    readonly id: number;
+    /**
+     * 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.
+     * @type {number}
+     * @memberof DealsApiGetDealFollowers
+     */
+    readonly limit?: number;
+    /**
+     * For pagination, the marker (an opaque string value) representing the first item on the next page
+     * @type {string}
+     * @memberof DealsApiGetDealFollowers
+     */
+    readonly cursor?: string;
+}
+/**
+ * Request parameters for getDealFollowersChangelog operation in DealsApi.
+ * @export
+ * @interface DealsApiGetDealFollowersChangelogRequest
+ */
+export interface DealsApiGetDealFollowersChangelogRequest {
+    /**
+     * The ID of the deal
+     * @type {number}
+     * @memberof DealsApiGetDealFollowersChangelog
+     */
+    readonly id: number;
+    /**
+     * 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.
+     * @type {number}
+     * @memberof DealsApiGetDealFollowersChangelog
+     */
+    readonly limit?: number;
+    /**
+     * For pagination, the marker (an opaque string value) representing the first item on the next page
+     * @type {string}
+     * @memberof DealsApiGetDealFollowersChangelog
+     */
+    readonly cursor?: string;
+}
 /**
  * Request parameters for getDealProducts operation in DealsApi.
  * @export
@@ -1172,6 +1614,15 @@ export declare class DealsApi extends BaseAPI {
      * @memberof DealsApi
      */
     addDeal(requestParameters?: DealsApiAddDealRequest): Promise<UpsertDealResponse>;
+    /**
+     * 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: DealsApiAddDealFollowerRequest): Promise<AddFollowerResponse>;
     /**
      * Adds a product to a deal, creating a new item called a deal-product.
      * @summary Add a product to a deal
@@ -1181,6 +1632,15 @@ export declare class DealsApi extends BaseAPI {
      * @memberof DealsApi
      */
     addDealProduct(requestParameters: DealsApiAddDealProductRequest): Promise<AddDealProductResponse>;
+    /**
+     * 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: DealsApiConvertDealToLeadRequest): Promise<AddConvertDealToLeadResponse>;
     /**
      * 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
@@ -1199,6 +1659,15 @@ export declare class DealsApi extends BaseAPI {
      * @memberof DealsApi
      */
     deleteDeal(requestParameters: DealsApiDeleteDealRequest): Promise<DeleteDealResponse>;
+    /**
+     * 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: DealsApiDeleteDealFollowerRequest): Promise<DeleteFollowerResponse>;
     /**
      * Deletes a product attachment from a deal, using the `product_attachment_id`.
      * @summary Delete an attached product from a deal
@@ -1226,6 +1695,15 @@ export declare class DealsApi extends BaseAPI {
      * @memberof DealsApi
      */
     getAdditionalDiscounts(requestParameters: DealsApiGetAdditionalDiscountsRequest): Promise<GetAdditionalDiscountsResponse>;
+    /**
+     * Returns data about all archived deals.
+     * @summary Get all archived deals
+     * @param {DealsApiGetArchivedDealsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    getArchivedDeals(requestParameters?: DealsApiGetArchivedDealsRequest): Promise<GetDealsResponse>;
     /**
      * Returns the details of a specific deal.
      * @summary Get details of a deal
@@ -1235,6 +1713,33 @@ export declare class DealsApi extends BaseAPI {
      * @memberof DealsApi
      */
     getDeal(requestParameters: DealsApiGetDealRequest): Promise<UpsertDealResponse>;
+    /**
+     * 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: DealsApiGetDealConversionStatusRequest): Promise<GetConvertResponse1>;
+    /**
+     * Lists users who are following the deal.
+     * @summary List followers of a deal
+     * @param {DealsApiGetDealFollowersRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    getDealFollowers(requestParameters: DealsApiGetDealFollowersRequest): Promise<GetFollowersResponse>;
+    /**
+     * 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: DealsApiGetDealFollowersChangelogRequest): Promise<GetFollowerChangelogsResponse>;
     /**
      * Lists products attached to a deal.
      * @summary List products attached to a deal
@@ -1245,7 +1750,7 @@ export declare class DealsApi extends BaseAPI {
      */
     getDealProducts(requestParameters: DealsApiGetDealProductsRequest): Promise<GetDealsProductsResponse>;
     /**
-     * Returns data about all deals.
+     * Returns data about all not archived deals.
      * @summary Get all deals
      * @param {DealsApiGetDealsRequest} requestParameters Request parameters.