pipedrive 25.0.0 → 27.0.0

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

@@ -57,7 +57,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * Adds a new deal. All deals created through the Pipedrive API will have a `origin` set to `API`. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the dealFields and look for `key` values. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/creating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">adding a deal</a>.
      * @summary Add a deal
      * @param {AddDealRequest} [AddDealRequest]
-
+     * @deprecated
      * @throws {RequiredError}
      */
     addDeal: (AddDealRequest?: AddDealRequest) => Promise<RequestArgs>;
@@ -84,7 +84,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @summary Add a product to a deal
      * @param {number} id The ID of the deal
      * @param {AddDealProductRequest} [AddDealProductRequest]
-
+     * @deprecated
      * @throws {RequiredError}
      */
     addDealProduct: (id: number, AddDealProductRequest?: AddDealProductRequest) => Promise<RequestArgs>;
@@ -92,7 +92,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
      * @summary Delete a deal
      * @param {number} id The ID of the deal
-
+     * @deprecated
      * @throws {RequiredError}
      */
     deleteDeal: (id: number) => Promise<RequestArgs>;
@@ -119,15 +119,15 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @summary Delete an attached product from a deal
      * @param {number} id The ID of the deal
      * @param {number} product_attachment_id The product attachment ID
-
+     * @deprecated
      * @throws {RequiredError}
      */
     deleteDealProduct: (id: number, product_attachment_id: number) => Promise<RequestArgs>;
     /**
-     * Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.
+     * Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#deleteDeal\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/deals/{id}</a> instead.
      * @summary Delete multiple deals in bulk
      * @param {string} ids The comma-separated IDs that will be deleted
-
+     * @deprecated
      * @throws {RequiredError}
      */
     deleteDeals: (ids: string) => Promise<RequestArgs>;
@@ -139,23 +139,70 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     duplicateDeal: (id: number) => Promise<RequestArgs>;
+    /**
+     * Returns all archived deals.
+     * @summary Get all archived deals
+     * @param {number} [user_id] If supplied, only deals matching the given user will be returned. However, &#x60;filter_id&#x60; and &#x60;owned_by_you&#x60; takes precedence over &#x60;user_id&#x60; when supplied.
+     * @param {number} [filter_id] The ID of the filter to use
+     * @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} [product_id] If supplied, only deals linked to the specified product 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' | 'all_not_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.
+     * @param {number} [start] Pagination start
+     * @param {number} [limit] Items shown per page
+     * @param {string} [sort] The field names and sorting mode separated by a comma (&#x60;field_name_1 ASC&#x60;, &#x60;field_name_2 DESC&#x60;). Only first-level field keys are supported (no nested keys).
+     * @param {0 | 1} [owned_by_you] When supplied, only deals owned by you are returned. However, &#x60;filter_id&#x60; takes precedence over &#x60;owned_by_you&#x60; when both are supplied.
+     * @deprecated
+     * @throws {RequiredError}
+     */
+    getArchivedDeals: (user_id?: number, filter_id?: number, person_id?: number, org_id?: number, product_id?: number, pipeline_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted', start?: number, limit?: number, sort?: string, owned_by_you?: 0 | 1) => Promise<RequestArgs>;
+    /**
+     * Returns a summary of all archived deals.
+     * @summary Get archived deals summary
+     * @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost.
+     * @param {number} [filter_id] &lt;code&gt;user_id&lt;/code&gt; will not be considered. Only deals matching the given filter will be returned.
+     * @param {number} [user_id] Only deals matching the given user will be returned. &#x60;user_id&#x60; will not be considered if you use &#x60;filter_id&#x60;.
+     * @param {number} [pipeline_id] Only deals within the given pipeline will be returned
+     * @param {number} [stage_id] Only deals within the given stage will be returned
+     * @deprecated
+     * @throws {RequiredError}
+     */
+    getArchivedDealsSummary: (status?: 'open' | 'won' | 'lost', filter_id?: number, user_id?: number, pipeline_id?: number, stage_id?: number) => Promise<RequestArgs>;
+    /**
+     * Returns archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
+     * @summary Get archived deals timeline
+     * @param {string} start_date The date when the first interval starts. Format: YYYY-MM-DD.
+     * @param {'day' | 'week' | 'month' | 'quarter'} interval The type of the interval&lt;table&gt;&lt;tr&gt;&lt;th&gt;Value&lt;/th&gt;&lt;th&gt;Description&lt;/th&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;day&#x60;&lt;/td&gt;&lt;td&gt;Day&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;week&#x60;&lt;/td&gt;&lt;td&gt;A full week (7 days) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;month&#x60;&lt;/td&gt;&lt;td&gt;A full month (depending on the number of days in given month) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;quarter&#x60;&lt;/td&gt;&lt;td&gt;A full quarter (3 months) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;
+     * @param {number} amount The number of given intervals, starting from &#x60;start_date&#x60;, to fetch. E.g. 3 (months).
+     * @param {string} field_key The date field key which deals will be retrieved from
+     * @param {number} [user_id] If supplied, only deals matching the given user will be returned
+     * @param {number} [pipeline_id] If supplied, only deals matching the given pipeline will be returned
+     * @param {number} [filter_id] If supplied, only deals matching the given filter will be returned
+     * @param {0 | 1} [exclude_deals] Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned.
+     * @param {string} [totals_convert_currency] The 3-letter currency code of any of the supported currencies. When supplied, &#x60;totals_converted&#x60; is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to &#x60;default_currency&#x60; in which case the user\&#39;s default currency is used.
+     * @deprecated
+     * @throws {RequiredError}
+     */
+    getArchivedDealsTimeline: (start_date: string, interval: 'day' | 'week' | 'month' | 'quarter', amount: number, field_key: string, user_id?: number, pipeline_id?: number, filter_id?: number, exclude_deals?: 0 | 1, totals_convert_currency?: string) => Promise<RequestArgs>;
     /**
      * Returns the details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of dealFields. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-details-of-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">getting details of a deal</a>.
      * @summary Get details of a deal
      * @param {number} id The ID of the deal
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getDeal: (id: number) => Promise<RequestArgs>;
     /**
-     * Lists activities associated with a deal.
+     * Lists activities associated with a deal. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivities\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/activities?deal_id={id}</a> instead.
      * @summary List activities associated with a deal
      * @param {number} id The ID of the deal
      * @param {number} [start] Pagination start
      * @param {number} [limit] Items shown per page
      * @param {0 | 1} [done] Whether the activity is done or not. 0 &#x3D; Not done, 1 &#x3D; Done. If omitted, returns both Done and Not done activities.
      * @param {string} [exclude] A comma-separated string of activity IDs to exclude from result
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getDealActivities: (id: number, start?: number, limit?: number, done?: 0 | 1, exclude?: string) => Promise<RequestArgs>;
@@ -219,12 +266,12 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      */
     getDealParticipantsChangelog: (id: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
     /**
-     * Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
+     * Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersons\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/persons?deal_id={id}</a> instead.
      * @summary List all persons associated with a deal
      * @param {number} id The ID of the deal
      * @param {number} [start] Pagination start
      * @param {number} [limit] Items shown per page
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getDealPersons: (id: number, start?: number, limit?: number) => Promise<RequestArgs>;
@@ -235,7 +282,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @param {number} [start] Pagination start
      * @param {number} [limit] Items shown per page
      * @param {0 | 1} [include_product_data] Whether to fetch product data along with each attached product (1) or not (0, default)
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getDealProducts: (id: number, start?: number, limit?: number, include_product_data?: 0 | 1) => Promise<RequestArgs>;
@@ -260,7 +307,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      */
     getDealUsers: (id: number) => Promise<RequestArgs>;
     /**
-     * Returns all deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
+     * Returns all not archived deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
      * @summary Get all deals
      * @param {number} [user_id] If supplied, only deals matching the given user will be returned. However, &#x60;filter_id&#x60; and &#x60;owned_by_you&#x60; takes precedence over &#x60;user_id&#x60; when supplied.
      * @param {number} [filter_id] The ID of the filter to use
@@ -270,13 +317,13 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @param {number} [limit] Items shown per page
      * @param {string} [sort] The field names and sorting mode separated by a comma (&#x60;field_name_1 ASC&#x60;, &#x60;field_name_2 DESC&#x60;). Only first-level field keys are supported (no nested keys).
      * @param {0 | 1} [owned_by_you] When supplied, only deals owned by you are returned. However, &#x60;filter_id&#x60; takes precedence over &#x60;owned_by_you&#x60; when both are supplied.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getDeals: (user_id?: number, filter_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted', start?: number, limit?: number, sort?: string, owned_by_you?: 0 | 1) => Promise<RequestArgs>;
     /**
-     * Returns all deals. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>. Please note that only global admins (those with global permissions) can access these endpoints. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
-     * @summary Get all deals (BETA)
+     * Returns all deals. Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeals\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/deals</a> instead.
+     * @summary Get all deals collection
      * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
      * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
      * @param {string} [since] The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the &#x60;update_time&#x60; field.
@@ -284,12 +331,12 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @param {number} [user_id] If supplied, only deals matching the given user will be returned
      * @param {number} [stage_id] If supplied, only deals within the given stage will be returned
      * @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.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getDealsCollection: (cursor?: string, limit?: number, since?: string, until?: string, user_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted') => Promise<RequestArgs>;
     /**
-     * Returns a summary of all the deals.
+     * Returns a summary of all not archived deals.
      * @summary Get deals summary
      * @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost.
      * @param {number} [filter_id] &lt;code&gt;user_id&lt;/code&gt; will not be considered. Only deals matching the given filter will be returned.
@@ -301,7 +348,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      */
     getDealsSummary: (status?: 'open' | 'won' | 'lost', filter_id?: number, user_id?: number, pipeline_id?: number, stage_id?: number) => Promise<RequestArgs>;
     /**
-     * Returns open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
+     * Returns not archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
      * @summary Get deals timeline
      * @param {string} start_date The date when the first interval starts. Format: YYYY-MM-DD.
      * @param {'day' | 'week' | 'month' | 'quarter'} interval The type of the interval&lt;table&gt;&lt;tr&gt;&lt;th&gt;Value&lt;/th&gt;&lt;th&gt;Description&lt;/th&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;day&#x60;&lt;/td&gt;&lt;td&gt;Day&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;week&#x60;&lt;/td&gt;&lt;td&gt;A full week (7 days) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;month&#x60;&lt;/td&gt;&lt;td&gt;A full month (depending on the number of days in given month) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;quarter&#x60;&lt;/td&gt;&lt;td&gt;A full quarter (3 months) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;
@@ -337,7 +384,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @param {'deal.cc_email'} [include_fields] Supports including optional fields in the results which are not provided by default
      * @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using &#x60;search_for_related_items&#x60; parameter.
      * @param {number} [limit] Items shown per page
-
+     * @deprecated
      * @throws {RequiredError}
      */
     searchDeals: (term: string, fields?: 'custom_fields' | 'notes' | 'title', exact_match?: boolean, person_id?: number, organization_id?: number, status?: 'open' | 'won' | 'lost', include_fields?: 'deal.cc_email', start?: number, limit?: number) => Promise<RequestArgs>;
@@ -346,7 +393,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @summary Update a deal
      * @param {number} id The ID of the deal
      * @param {UpdateDealRequest} [UpdateDealRequest]
-
+     * @deprecated
      * @throws {RequiredError}
      */
     updateDeal: (id: number, UpdateDealRequest?: UpdateDealRequest) => Promise<RequestArgs>;
@@ -356,7 +403,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @param {number} id The ID of the deal
      * @param {number} product_attachment_id The ID of the deal-product (the ID of the product attached to the deal)
      * @param {UpdateDealProductRequest} [UpdateDealProductRequest]
-
+     * @deprecated
      * @throws {RequiredError}
      */
     updateDealProduct: (id: number, product_attachment_id: number, UpdateDealProductRequest?: UpdateDealProductRequest) => Promise<RequestArgs>;
@@ -370,7 +417,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * Adds a new deal. All deals created through the Pipedrive API will have a `origin` set to `API`. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the dealFields and look for `key` values. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/creating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">adding a deal</a>.
      * @summary Add a deal
      * @param {AddDealRequest} [AddDealRequest]
-
+     * @deprecated
      * @throws {RequiredError}
      */
     addDeal(AddDealRequest?: AddDealRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAddedDealResponse>>;
@@ -397,7 +444,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @summary Add a product to a deal
      * @param {number} id The ID of the deal
      * @param {AddDealProductRequest} [AddDealProductRequest]
-
+     * @deprecated
      * @throws {RequiredError}
      */
     addDealProduct(id: number, AddDealProductRequest?: AddDealProductRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAddProductAttachmentDetailsResponse>>;
@@ -405,7 +452,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
      * @summary Delete a deal
      * @param {number} id The ID of the deal
-
+     * @deprecated
      * @throws {RequiredError}
      */
     deleteDeal(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteDealResponse>>;
@@ -432,15 +479,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @summary Delete an attached product from a deal
      * @param {number} id The ID of the deal
      * @param {number} product_attachment_id The product attachment ID
-
+     * @deprecated
      * @throws {RequiredError}
      */
     deleteDealProduct(id: number, product_attachment_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteDealProductResponse>>;
     /**
-     * Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.
+     * Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#deleteDeal\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/deals/{id}</a> instead.
      * @summary Delete multiple deals in bulk
      * @param {string} ids The comma-separated IDs that will be deleted
-
+     * @deprecated
      * @throws {RequiredError}
      */
     deleteDeals(ids: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteDealsResponse>>;
@@ -452,23 +499,70 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     duplicateDeal(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDuplicatedDealResponse>>;
+    /**
+     * Returns all archived deals.
+     * @summary Get all archived deals
+     * @param {number} [user_id] If supplied, only deals matching the given user will be returned. However, &#x60;filter_id&#x60; and &#x60;owned_by_you&#x60; takes precedence over &#x60;user_id&#x60; when supplied.
+     * @param {number} [filter_id] The ID of the filter to use
+     * @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} [product_id] If supplied, only deals linked to the specified product 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' | 'all_not_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.
+     * @param {number} [start] Pagination start
+     * @param {number} [limit] Items shown per page
+     * @param {string} [sort] The field names and sorting mode separated by a comma (&#x60;field_name_1 ASC&#x60;, &#x60;field_name_2 DESC&#x60;). Only first-level field keys are supported (no nested keys).
+     * @param {0 | 1} [owned_by_you] When supplied, only deals owned by you are returned. However, &#x60;filter_id&#x60; takes precedence over &#x60;owned_by_you&#x60; when both are supplied.
+     * @deprecated
+     * @throws {RequiredError}
+     */
+    getArchivedDeals(user_id?: number, filter_id?: number, person_id?: number, org_id?: number, product_id?: number, pipeline_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted', start?: number, limit?: number, sort?: string, owned_by_you?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsResponse>>;
+    /**
+     * Returns a summary of all archived deals.
+     * @summary Get archived deals summary
+     * @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost.
+     * @param {number} [filter_id] &lt;code&gt;user_id&lt;/code&gt; will not be considered. Only deals matching the given filter will be returned.
+     * @param {number} [user_id] Only deals matching the given user will be returned. &#x60;user_id&#x60; will not be considered if you use &#x60;filter_id&#x60;.
+     * @param {number} [pipeline_id] Only deals within the given pipeline will be returned
+     * @param {number} [stage_id] Only deals within the given stage will be returned
+     * @deprecated
+     * @throws {RequiredError}
+     */
+    getArchivedDealsSummary(status?: 'open' | 'won' | 'lost', filter_id?: number, user_id?: number, pipeline_id?: number, stage_id?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsSummaryResponse>>;
+    /**
+     * Returns archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
+     * @summary Get archived deals timeline
+     * @param {string} start_date The date when the first interval starts. Format: YYYY-MM-DD.
+     * @param {'day' | 'week' | 'month' | 'quarter'} interval The type of the interval&lt;table&gt;&lt;tr&gt;&lt;th&gt;Value&lt;/th&gt;&lt;th&gt;Description&lt;/th&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;day&#x60;&lt;/td&gt;&lt;td&gt;Day&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;week&#x60;&lt;/td&gt;&lt;td&gt;A full week (7 days) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;month&#x60;&lt;/td&gt;&lt;td&gt;A full month (depending on the number of days in given month) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;quarter&#x60;&lt;/td&gt;&lt;td&gt;A full quarter (3 months) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;
+     * @param {number} amount The number of given intervals, starting from &#x60;start_date&#x60;, to fetch. E.g. 3 (months).
+     * @param {string} field_key The date field key which deals will be retrieved from
+     * @param {number} [user_id] If supplied, only deals matching the given user will be returned
+     * @param {number} [pipeline_id] If supplied, only deals matching the given pipeline will be returned
+     * @param {number} [filter_id] If supplied, only deals matching the given filter will be returned
+     * @param {0 | 1} [exclude_deals] Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned.
+     * @param {string} [totals_convert_currency] The 3-letter currency code of any of the supported currencies. When supplied, &#x60;totals_converted&#x60; is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to &#x60;default_currency&#x60; in which case the user\&#39;s default currency is used.
+     * @deprecated
+     * @throws {RequiredError}
+     */
+    getArchivedDealsTimeline(start_date: string, interval: 'day' | 'week' | 'month' | 'quarter', amount: number, field_key: string, user_id?: number, pipeline_id?: number, filter_id?: number, exclude_deals?: 0 | 1, totals_convert_currency?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsTimelineResponse>>;
     /**
      * Returns the details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of dealFields. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-details-of-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">getting details of a deal</a>.
      * @summary Get details of a deal
      * @param {number} id The ID of the deal
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getDeal(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealResponse>>;
     /**
-     * Lists activities associated with a deal.
+     * Lists activities associated with a deal. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivities\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/activities?deal_id={id}</a> instead.
      * @summary List activities associated with a deal
      * @param {number} id The ID of the deal
      * @param {number} [start] Pagination start
      * @param {number} [limit] Items shown per page
      * @param {0 | 1} [done] Whether the activity is done or not. 0 &#x3D; Not done, 1 &#x3D; Done. If omitted, returns both Done and Not done activities.
      * @param {string} [exclude] A comma-separated string of activity IDs to exclude from result
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getDealActivities(id: number, start?: number, limit?: number, done?: 0 | 1, exclude?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealActivitiesResponse>>;
@@ -532,12 +626,12 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      */
     getDealParticipantsChangelog(id: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetParticipantsChangelogResponse>>;
     /**
-     * Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
+     * Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersons\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/persons?deal_id={id}</a> instead.
      * @summary List all persons associated with a deal
      * @param {number} id The ID of the deal
      * @param {number} [start] Pagination start
      * @param {number} [limit] Items shown per page
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getDealPersons(id: number, start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonsResponse>>;
@@ -548,7 +642,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @param {number} [start] Pagination start
      * @param {number} [limit] Items shown per page
      * @param {0 | 1} [include_product_data] Whether to fetch product data along with each attached product (1) or not (0, default)
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getDealProducts(id: number, start?: number, limit?: number, include_product_data?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductsResponse>>;
@@ -573,7 +667,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      */
     getDealUsers(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPermittedUsersResponse>>;
     /**
-     * Returns all deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
+     * Returns all not archived deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
      * @summary Get all deals
      * @param {number} [user_id] If supplied, only deals matching the given user will be returned. However, &#x60;filter_id&#x60; and &#x60;owned_by_you&#x60; takes precedence over &#x60;user_id&#x60; when supplied.
      * @param {number} [filter_id] The ID of the filter to use
@@ -583,13 +677,13 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @param {number} [limit] Items shown per page
      * @param {string} [sort] The field names and sorting mode separated by a comma (&#x60;field_name_1 ASC&#x60;, &#x60;field_name_2 DESC&#x60;). Only first-level field keys are supported (no nested keys).
      * @param {0 | 1} [owned_by_you] When supplied, only deals owned by you are returned. However, &#x60;filter_id&#x60; takes precedence over &#x60;owned_by_you&#x60; when both are supplied.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getDeals(user_id?: number, filter_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted', start?: number, limit?: number, sort?: string, owned_by_you?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsResponse>>;
     /**
-     * Returns all deals. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>. Please note that only global admins (those with global permissions) can access these endpoints. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
-     * @summary Get all deals (BETA)
+     * Returns all deals. Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeals\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/deals</a> instead.
+     * @summary Get all deals collection
      * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
      * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
      * @param {string} [since] The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the &#x60;update_time&#x60; field.
@@ -597,12 +691,12 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @param {number} [user_id] If supplied, only deals matching the given user will be returned
      * @param {number} [stage_id] If supplied, only deals within the given stage will be returned
      * @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.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getDealsCollection(cursor?: string, limit?: number, since?: string, until?: string, user_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsCollectionResponse>>;
     /**
-     * Returns a summary of all the deals.
+     * Returns a summary of all not archived deals.
      * @summary Get deals summary
      * @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost.
      * @param {number} [filter_id] &lt;code&gt;user_id&lt;/code&gt; will not be considered. Only deals matching the given filter will be returned.
@@ -614,7 +708,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      */
     getDealsSummary(status?: 'open' | 'won' | 'lost', filter_id?: number, user_id?: number, pipeline_id?: number, stage_id?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsSummaryResponse>>;
     /**
-     * Returns open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
+     * Returns not archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
      * @summary Get deals timeline
      * @param {string} start_date The date when the first interval starts. Format: YYYY-MM-DD.
      * @param {'day' | 'week' | 'month' | 'quarter'} interval The type of the interval&lt;table&gt;&lt;tr&gt;&lt;th&gt;Value&lt;/th&gt;&lt;th&gt;Description&lt;/th&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;day&#x60;&lt;/td&gt;&lt;td&gt;Day&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;week&#x60;&lt;/td&gt;&lt;td&gt;A full week (7 days) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;month&#x60;&lt;/td&gt;&lt;td&gt;A full month (depending on the number of days in given month) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;quarter&#x60;&lt;/td&gt;&lt;td&gt;A full quarter (3 months) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;
@@ -650,7 +744,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @param {'deal.cc_email'} [include_fields] Supports including optional fields in the results which are not provided by default
      * @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using &#x60;search_for_related_items&#x60; parameter.
      * @param {number} [limit] Items shown per page
-
+     * @deprecated
      * @throws {RequiredError}
      */
     searchDeals(term: string, fields?: 'custom_fields' | 'notes' | 'title', exact_match?: boolean, person_id?: number, organization_id?: number, status?: 'open' | 'won' | 'lost', include_fields?: 'deal.cc_email', start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealSearchResponse>>;
@@ -659,7 +753,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @summary Update a deal
      * @param {number} id The ID of the deal
      * @param {UpdateDealRequest} [UpdateDealRequest]
-
+     * @deprecated
      * @throws {RequiredError}
      */
     updateDeal(id: number, UpdateDealRequest?: UpdateDealRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAddedDealResponse>>;
@@ -669,7 +763,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @param {number} id The ID of the deal
      * @param {number} product_attachment_id The ID of the deal-product (the ID of the product attached to the deal)
      * @param {UpdateDealProductRequest} [UpdateDealProductRequest]
-
+     * @deprecated
      * @throws {RequiredError}
      */
     updateDealProduct(id: number, product_attachment_id: number, UpdateDealProductRequest?: UpdateDealProductRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductAttachmentDetailsResponse>>;
@@ -683,7 +777,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      * Adds a new deal. All deals created through the Pipedrive API will have a `origin` set to `API`. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the dealFields and look for `key` values. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/creating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">adding a deal</a>.
      * @summary Add a deal
      * @param {DealsApiAddDealRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     addDeal(requestParameters?: DealsApiAddDealRequest): Promise<GetAddedDealResponse>;
@@ -707,7 +801,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      * Adds a product to a deal, creating a new item called a deal-product.
      * @summary Add a product to a deal
      * @param {DealsApiAddDealProductRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     addDealProduct(requestParameters: DealsApiAddDealProductRequest): Promise<GetAddProductAttachmentDetailsResponse>;
@@ -715,7 +809,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      * Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
      * @summary Delete a deal
      * @param {DealsApiDeleteDealRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     deleteDeal(requestParameters: DealsApiDeleteDealRequest): Promise<DeleteDealResponse>;
@@ -739,15 +833,15 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      * Deletes a product attachment from a deal, using the `product_attachment_id`  Not possible to delete the attached product if the deal has installments associated and the product is the last one enabled
      * @summary Delete an attached product from a deal
      * @param {DealsApiDeleteDealProductRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     deleteDealProduct(requestParameters: DealsApiDeleteDealProductRequest): Promise<DeleteDealProductResponse>;
     /**
-     * Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.
+     * Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#deleteDeal\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/deals/{id}</a> instead.
      * @summary Delete multiple deals in bulk
      * @param {DealsApiDeleteDealsRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     deleteDeals(requestParameters: DealsApiDeleteDealsRequest): Promise<DeleteDealsResponse>;
@@ -759,19 +853,43 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     duplicateDeal(requestParameters: DealsApiDuplicateDealRequest): Promise<GetDuplicatedDealResponse>;
+    /**
+     * Returns all archived deals.
+     * @summary Get all archived deals
+     * @param {DealsApiGetArchivedDealsRequest} requestParameters Request parameters.
+     * @deprecated
+     * @throws {RequiredError}
+     */
+    getArchivedDeals(requestParameters?: DealsApiGetArchivedDealsRequest): Promise<GetDealsResponse>;
+    /**
+     * Returns a summary of all archived deals.
+     * @summary Get archived deals summary
+     * @param {DealsApiGetArchivedDealsSummaryRequest} requestParameters Request parameters.
+     * @deprecated
+     * @throws {RequiredError}
+     */
+    getArchivedDealsSummary(requestParameters?: DealsApiGetArchivedDealsSummaryRequest): Promise<GetDealsSummaryResponse>;
+    /**
+     * Returns archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
+     * @summary Get archived deals timeline
+     * @param {DealsApiGetArchivedDealsTimelineRequest} requestParameters Request parameters.
+     * @deprecated
+     * @throws {RequiredError}
+     */
+    getArchivedDealsTimeline(requestParameters: DealsApiGetArchivedDealsTimelineRequest): Promise<GetDealsTimelineResponse>;
     /**
      * Returns the details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of dealFields. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-details-of-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">getting details of a deal</a>.
      * @summary Get details of a deal
      * @param {DealsApiGetDealRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getDeal(requestParameters: DealsApiGetDealRequest): Promise<GetDealResponse>;
     /**
-     * Lists activities associated with a deal.
+     * Lists activities associated with a deal. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivities\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/activities?deal_id={id}</a> instead.
      * @summary List activities associated with a deal
      * @param {DealsApiGetDealActivitiesRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getDealActivities(requestParameters: DealsApiGetDealActivitiesRequest): Promise<GetDealActivitiesResponse>;
@@ -824,10 +942,10 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      */
     getDealParticipantsChangelog(requestParameters: DealsApiGetDealParticipantsChangelogRequest): Promise<GetParticipantsChangelogResponse>;
     /**
-     * Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
+     * Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersons\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/persons?deal_id={id}</a> instead.
      * @summary List all persons associated with a deal
      * @param {DealsApiGetDealPersonsRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getDealPersons(requestParameters: DealsApiGetDealPersonsRequest): Promise<GetPersonsResponse>;
@@ -835,7 +953,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      * Lists products attached to a deal.
      * @summary List products attached to a deal
      * @param {DealsApiGetDealProductsRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getDealProducts(requestParameters: DealsApiGetDealProductsRequest): Promise<GetProductsResponse>;
@@ -856,23 +974,23 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      */
     getDealUsers(requestParameters: DealsApiGetDealUsersRequest): Promise<GetPermittedUsersResponse>;
     /**
-     * Returns all deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
+     * Returns all not archived deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
      * @summary Get all deals
      * @param {DealsApiGetDealsRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getDeals(requestParameters?: DealsApiGetDealsRequest): Promise<GetDealsResponse>;
     /**
-     * Returns all deals. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>. Please note that only global admins (those with global permissions) can access these endpoints. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
-     * @summary Get all deals (BETA)
+     * Returns all deals. Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeals\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/deals</a> instead.
+     * @summary Get all deals collection
      * @param {DealsApiGetDealsCollectionRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getDealsCollection(requestParameters?: DealsApiGetDealsCollectionRequest): Promise<GetDealsCollectionResponse>;
     /**
-     * Returns a summary of all the deals.
+     * Returns a summary of all not archived deals.
      * @summary Get deals summary
      * @param {DealsApiGetDealsSummaryRequest} requestParameters Request parameters.
 
@@ -880,7 +998,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      */
     getDealsSummary(requestParameters?: DealsApiGetDealsSummaryRequest): Promise<GetDealsSummaryResponse>;
     /**
-     * Returns open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
+     * Returns not archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
      * @summary Get deals timeline
      * @param {DealsApiGetDealsTimelineRequest} requestParameters Request parameters.
 
@@ -899,7 +1017,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      * Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID.
      * @summary Search deals
      * @param {DealsApiSearchDealsRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     searchDeals(requestParameters: DealsApiSearchDealsRequest): Promise<GetDealSearchResponse>;
@@ -907,7 +1025,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      * Updates the properties of a deal. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/updating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">updating a deal</a>.
      * @summary Update a deal
      * @param {DealsApiUpdateDealRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     updateDeal(requestParameters: DealsApiUpdateDealRequest): Promise<GetAddedDealResponse>;
@@ -915,7 +1033,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      * Updates the details of the product that has been attached to a deal.
      * @summary Update the product attached to a deal
      * @param {DealsApiUpdateDealProductRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     updateDealProduct(requestParameters: DealsApiUpdateDealProductRequest): Promise<GetProductAttachmentDetailsResponse>;
@@ -1086,6 +1204,183 @@ export interface DealsApiDuplicateDealRequest {
      */
     readonly id: number;
 }
+/**
+ * Request parameters for getArchivedDeals operation in DealsApi.
+ * @export
+ * @interface DealsApiGetArchivedDealsRequest
+ */
+export interface DealsApiGetArchivedDealsRequest {
+    /**
+     * If supplied, only deals matching the given user will be returned. However, &#x60;filter_id&#x60; and &#x60;owned_by_you&#x60; takes precedence over &#x60;user_id&#x60; when supplied.
+     * @type {number}
+     * @memberof DealsApiGetArchivedDeals
+     */
+    readonly user_id?: number;
+    /**
+     * The ID of the filter to use
+     * @type {number}
+     * @memberof DealsApiGetArchivedDeals
+     */
+    readonly filter_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 linked to the specified product are returned. If filter_id is provided, this is ignored.
+     * @type {number}
+     * @memberof DealsApiGetArchivedDeals
+     */
+    readonly product_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.
+     * @type {'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted'}
+     * @memberof DealsApiGetArchivedDeals
+     */
+    readonly status?: 'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted';
+    /**
+     * Pagination start
+     * @type {number}
+     * @memberof DealsApiGetArchivedDeals
+     */
+    readonly start?: number;
+    /**
+     * Items shown per page
+     * @type {number}
+     * @memberof DealsApiGetArchivedDeals
+     */
+    readonly limit?: number;
+    /**
+     * The field names and sorting mode separated by a comma (&#x60;field_name_1 ASC&#x60;, &#x60;field_name_2 DESC&#x60;). Only first-level field keys are supported (no nested keys).
+     * @type {string}
+     * @memberof DealsApiGetArchivedDeals
+     */
+    readonly sort?: string;
+    /**
+     * When supplied, only deals owned by you are returned. However, &#x60;filter_id&#x60; takes precedence over &#x60;owned_by_you&#x60; when both are supplied.
+     * @type {0 | 1}
+     * @memberof DealsApiGetArchivedDeals
+     */
+    readonly owned_by_you?: 0 | 1;
+}
+/**
+ * Request parameters for getArchivedDealsSummary operation in DealsApi.
+ * @export
+ * @interface DealsApiGetArchivedDealsSummaryRequest
+ */
+export interface DealsApiGetArchivedDealsSummaryRequest {
+    /**
+     * Only fetch deals with a specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost.
+     * @type {'open' | 'won' | 'lost'}
+     * @memberof DealsApiGetArchivedDealsSummary
+     */
+    readonly status?: 'open' | 'won' | 'lost';
+    /**
+     * &lt;code&gt;user_id&lt;/code&gt; will not be considered. Only deals matching the given filter will be returned.
+     * @type {number}
+     * @memberof DealsApiGetArchivedDealsSummary
+     */
+    readonly filter_id?: number;
+    /**
+     * Only deals matching the given user will be returned. &#x60;user_id&#x60; will not be considered if you use &#x60;filter_id&#x60;.
+     * @type {number}
+     * @memberof DealsApiGetArchivedDealsSummary
+     */
+    readonly user_id?: number;
+    /**
+     * Only deals within the given pipeline will be returned
+     * @type {number}
+     * @memberof DealsApiGetArchivedDealsSummary
+     */
+    readonly pipeline_id?: number;
+    /**
+     * Only deals within the given stage will be returned
+     * @type {number}
+     * @memberof DealsApiGetArchivedDealsSummary
+     */
+    readonly stage_id?: number;
+}
+/**
+ * Request parameters for getArchivedDealsTimeline operation in DealsApi.
+ * @export
+ * @interface DealsApiGetArchivedDealsTimelineRequest
+ */
+export interface DealsApiGetArchivedDealsTimelineRequest {
+    /**
+     * The date when the first interval starts. Format: YYYY-MM-DD.
+     * @type {string}
+     * @memberof DealsApiGetArchivedDealsTimeline
+     */
+    readonly start_date: string;
+    /**
+     * The type of the interval&lt;table&gt;&lt;tr&gt;&lt;th&gt;Value&lt;/th&gt;&lt;th&gt;Description&lt;/th&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;day&#x60;&lt;/td&gt;&lt;td&gt;Day&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;week&#x60;&lt;/td&gt;&lt;td&gt;A full week (7 days) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;month&#x60;&lt;/td&gt;&lt;td&gt;A full month (depending on the number of days in given month) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;quarter&#x60;&lt;/td&gt;&lt;td&gt;A full quarter (3 months) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;
+     * @type {'day' | 'week' | 'month' | 'quarter'}
+     * @memberof DealsApiGetArchivedDealsTimeline
+     */
+    readonly interval: 'day' | 'week' | 'month' | 'quarter';
+    /**
+     * The number of given intervals, starting from &#x60;start_date&#x60;, to fetch. E.g. 3 (months).
+     * @type {number}
+     * @memberof DealsApiGetArchivedDealsTimeline
+     */
+    readonly amount: number;
+    /**
+     * The date field key which deals will be retrieved from
+     * @type {string}
+     * @memberof DealsApiGetArchivedDealsTimeline
+     */
+    readonly field_key: string;
+    /**
+     * If supplied, only deals matching the given user will be returned
+     * @type {number}
+     * @memberof DealsApiGetArchivedDealsTimeline
+     */
+    readonly user_id?: number;
+    /**
+     * If supplied, only deals matching the given pipeline will be returned
+     * @type {number}
+     * @memberof DealsApiGetArchivedDealsTimeline
+     */
+    readonly pipeline_id?: number;
+    /**
+     * If supplied, only deals matching the given filter will be returned
+     * @type {number}
+     * @memberof DealsApiGetArchivedDealsTimeline
+     */
+    readonly filter_id?: number;
+    /**
+     * Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned.
+     * @type {0 | 1}
+     * @memberof DealsApiGetArchivedDealsTimeline
+     */
+    readonly exclude_deals?: 0 | 1;
+    /**
+     * The 3-letter currency code of any of the supported currencies. When supplied, &#x60;totals_converted&#x60; is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to &#x60;default_currency&#x60; in which case the user\&#39;s default currency is used.
+     * @type {string}
+     * @memberof DealsApiGetArchivedDealsTimeline
+     */
+    readonly totals_convert_currency?: string;
+}
 /**
  * Request parameters for getDeal operation in DealsApi.
  * @export
@@ -1723,7 +2018,7 @@ export declare class DealsApi extends BaseAPI {
      * Adds a new deal. All deals created through the Pipedrive API will have a `origin` set to `API`. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the dealFields and look for `key` values. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/creating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">adding a deal</a>.
      * @summary Add a deal
      * @param {DealsApiAddDealRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof DealsApi
      */
@@ -1750,7 +2045,7 @@ export declare class DealsApi extends BaseAPI {
      * Adds a product to a deal, creating a new item called a deal-product.
      * @summary Add a product to a deal
      * @param {DealsApiAddDealProductRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof DealsApi
      */
@@ -1759,7 +2054,7 @@ export declare class DealsApi extends BaseAPI {
      * Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
      * @summary Delete a deal
      * @param {DealsApiDeleteDealRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof DealsApi
      */
@@ -1786,16 +2081,16 @@ export declare class DealsApi extends BaseAPI {
      * Deletes a product attachment from a deal, using the `product_attachment_id`  Not possible to delete the attached product if the deal has installments associated and the product is the last one enabled
      * @summary Delete an attached product from a deal
      * @param {DealsApiDeleteDealProductRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof DealsApi
      */
     deleteDealProduct(requestParameters: DealsApiDeleteDealProductRequest): Promise<DeleteDealProductResponse>;
     /**
-     * Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.
+     * Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#deleteDeal\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/deals/{id}</a> instead.
      * @summary Delete multiple deals in bulk
      * @param {DealsApiDeleteDealsRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof DealsApi
      */
@@ -1809,20 +2104,47 @@ export declare class DealsApi extends BaseAPI {
      * @memberof DealsApi
      */
     duplicateDeal(requestParameters: DealsApiDuplicateDealRequest): Promise<GetDuplicatedDealResponse>;
+    /**
+     * Returns all archived deals.
+     * @summary Get all archived deals
+     * @param {DealsApiGetArchivedDealsRequest} requestParameters Request parameters.
+     * @deprecated
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    getArchivedDeals(requestParameters?: DealsApiGetArchivedDealsRequest): Promise<GetDealsResponse>;
+    /**
+     * Returns a summary of all archived deals.
+     * @summary Get archived deals summary
+     * @param {DealsApiGetArchivedDealsSummaryRequest} requestParameters Request parameters.
+     * @deprecated
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    getArchivedDealsSummary(requestParameters?: DealsApiGetArchivedDealsSummaryRequest): Promise<GetDealsSummaryResponse>;
+    /**
+     * Returns archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
+     * @summary Get archived deals timeline
+     * @param {DealsApiGetArchivedDealsTimelineRequest} requestParameters Request parameters.
+     * @deprecated
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    getArchivedDealsTimeline(requestParameters: DealsApiGetArchivedDealsTimelineRequest): Promise<GetDealsTimelineResponse>;
     /**
      * Returns the details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of dealFields. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-details-of-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">getting details of a deal</a>.
      * @summary Get details of a deal
      * @param {DealsApiGetDealRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof DealsApi
      */
     getDeal(requestParameters: DealsApiGetDealRequest): Promise<GetDealResponse>;
     /**
-     * Lists activities associated with a deal.
+     * Lists activities associated with a deal. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivities\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/activities?deal_id={id}</a> instead.
      * @summary List activities associated with a deal
      * @param {DealsApiGetDealActivitiesRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof DealsApi
      */
@@ -1882,10 +2204,10 @@ export declare class DealsApi extends BaseAPI {
      */
     getDealParticipantsChangelog(requestParameters: DealsApiGetDealParticipantsChangelogRequest): Promise<GetParticipantsChangelogResponse>;
     /**
-     * Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
+     * Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersons\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/persons?deal_id={id}</a> instead.
      * @summary List all persons associated with a deal
      * @param {DealsApiGetDealPersonsRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof DealsApi
      */
@@ -1894,7 +2216,7 @@ export declare class DealsApi extends BaseAPI {
      * Lists products attached to a deal.
      * @summary List products attached to a deal
      * @param {DealsApiGetDealProductsRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof DealsApi
      */
@@ -1918,25 +2240,25 @@ export declare class DealsApi extends BaseAPI {
      */
     getDealUsers(requestParameters: DealsApiGetDealUsersRequest): Promise<import("../models").BaseResponse1>;
     /**
-     * Returns all deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
+     * Returns all not archived deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
      * @summary Get all deals
      * @param {DealsApiGetDealsRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof DealsApi
      */
     getDeals(requestParameters?: DealsApiGetDealsRequest): Promise<GetDealsResponse>;
     /**
-     * Returns all deals. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>. Please note that only global admins (those with global permissions) can access these endpoints. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
-     * @summary Get all deals (BETA)
+     * Returns all deals. Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeals\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/deals</a> instead.
+     * @summary Get all deals collection
      * @param {DealsApiGetDealsCollectionRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof DealsApi
      */
     getDealsCollection(requestParameters?: DealsApiGetDealsCollectionRequest): Promise<GetDealsCollectionResponse>;
     /**
-     * Returns a summary of all the deals.
+     * Returns a summary of all not archived deals.
      * @summary Get deals summary
      * @param {DealsApiGetDealsSummaryRequest} requestParameters Request parameters.
 
@@ -1945,7 +2267,7 @@ export declare class DealsApi extends BaseAPI {
      */
     getDealsSummary(requestParameters?: DealsApiGetDealsSummaryRequest): Promise<GetDealsSummaryResponse>;
     /**
-     * Returns open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
+     * Returns not archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
      * @summary Get deals timeline
      * @param {DealsApiGetDealsTimelineRequest} requestParameters Request parameters.
 
@@ -1966,7 +2288,7 @@ export declare class DealsApi extends BaseAPI {
      * Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID.
      * @summary Search deals
      * @param {DealsApiSearchDealsRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof DealsApi
      */
@@ -1975,7 +2297,7 @@ export declare class DealsApi extends BaseAPI {
      * Updates the properties of a deal. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/updating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">updating a deal</a>.
      * @summary Update a deal
      * @param {DealsApiUpdateDealRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof DealsApi
      */
@@ -1984,7 +2306,7 @@ export declare class DealsApi extends BaseAPI {
      * Updates the details of the product that has been attached to a deal.
      * @summary Update the product attached to a deal
      * @param {DealsApiUpdateDealProductRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof DealsApi
      */