pipedrive 25.0.0 → 26.0.0

package/dist/esm/versions/v1/api/item-search-api.d.ts

@@ -30,7 +30,7 @@ export declare const ItemSearchApiAxiosParamCreator: (configuration?: Configurat
      * @param {'deal.cc_email' | 'person.picture' | 'product.price'} [include_fields] A comma-separated string array. 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 `search_for_related_items` parameter.
      * @param {number} [limit] Items shown per page
-
+     * @deprecated
      * @throws {RequiredError}
      */
     searchItem: (term: string, item_types?: 'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project', fields?: 'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'organization_name' | 'person_name' | 'phone' | 'title' | 'description', search_for_related_items?: boolean, exact_match?: boolean, include_fields?: 'deal.cc_email' | 'person.picture' | 'product.price', start?: number, limit?: number) => Promise<RequestArgs>;
@@ -44,7 +44,7 @@ export declare const ItemSearchApiAxiosParamCreator: (configuration?: Configurat
      * @param {boolean} [return_item_ids] Whether to return the IDs of the matching items or not. When not set or set to &#x60;0&#x60; or &#x60;false&#x60;, only distinct values of the searched field are returned. When set to &#x60;1&#x60; or &#x60;true&#x60;, the ID of each found item is returned.
      * @param {number} [start] Pagination start
      * @param {number} [limit] Items shown per page
-
+     * @deprecated
      * @throws {RequiredError}
      */
     searchItemByField: (term: string, field_type: 'dealField' | 'leadField' | 'personField' | 'organizationField' | 'productField' | 'projectField', field_key: string, exact_match?: boolean, return_item_ids?: boolean, start?: number, limit?: number) => Promise<RequestArgs>;
@@ -65,7 +65,7 @@ export declare const ItemSearchApiFp: (configuration?: Configuration) => {
      * @param {'deal.cc_email' | 'person.picture' | 'product.price'} [include_fields] A comma-separated string array. 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}
      */
     searchItem(term: string, item_types?: 'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project', fields?: 'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'organization_name' | 'person_name' | 'phone' | 'title' | 'description', search_for_related_items?: boolean, exact_match?: boolean, include_fields?: 'deal.cc_email' | 'person.picture' | 'product.price', start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetItemSearchResponse>>;
@@ -79,7 +79,7 @@ export declare const ItemSearchApiFp: (configuration?: Configuration) => {
      * @param {boolean} [return_item_ids] Whether to return the IDs of the matching items or not. When not set or set to &#x60;0&#x60; or &#x60;false&#x60;, only distinct values of the searched field are returned. When set to &#x60;1&#x60; or &#x60;true&#x60;, the ID of each found item is returned.
      * @param {number} [start] Pagination start
      * @param {number} [limit] Items shown per page
-
+     * @deprecated
      * @throws {RequiredError}
      */
     searchItemByField(term: string, field_type: 'dealField' | 'leadField' | 'personField' | 'organizationField' | 'productField' | 'projectField', field_key: string, exact_match?: boolean, return_item_ids?: boolean, start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetItemSearchFieldResponse>>;
@@ -93,7 +93,7 @@ export declare const ItemSearchApiFactory: (configuration?: Configuration, baseP
      * Performs a search from your choice of item types and fields.
      * @summary Perform a search from multiple item types
      * @param {ItemSearchApiSearchItemRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     searchItem(requestParameters: ItemSearchApiSearchItemRequest): Promise<GetItemSearchResponse>;
@@ -101,7 +101,7 @@ export declare const ItemSearchApiFactory: (configuration?: Configuration, baseP
      * Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (deals, leads, persons, organizations or products).
      * @summary Perform a search using a specific field from an item type
      * @param {ItemSearchApiSearchItemByFieldRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     searchItemByField(requestParameters: ItemSearchApiSearchItemByFieldRequest): Promise<GetItemSearchFieldResponse>;
@@ -221,7 +221,7 @@ export declare class ItemSearchApi extends BaseAPI {
      * Performs a search from your choice of item types and fields.
      * @summary Perform a search from multiple item types
      * @param {ItemSearchApiSearchItemRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ItemSearchApi
      */
@@ -230,7 +230,7 @@ export declare class ItemSearchApi extends BaseAPI {
      * Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (deals, leads, persons, organizations or products).
      * @summary Perform a search using a specific field from an item type
      * @param {ItemSearchApiSearchItemByFieldRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ItemSearchApi
      */

package/dist/esm/versions/v1/api/item-search-api.js

@@ -43,7 +43,7 @@ export const ItemSearchApiAxiosParamCreator = function (configuration) {
          * @param {'deal.cc_email' | 'person.picture' | 'product.price'} [include_fields] A comma-separated string array. 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 `search_for_related_items` parameter.
          * @param {number} [limit] Items shown per page
-
+         * @deprecated
          * @throws {RequiredError}
          */
         searchItem: (term, item_types, fields, search_for_related_items, exact_match, include_fields, start, limit) => __awaiter(this, void 0, void 0, function* () {
@@ -106,7 +106,7 @@ export const ItemSearchApiAxiosParamCreator = function (configuration) {
          * @param {boolean} [return_item_ids] Whether to return the IDs of the matching items or not. When not set or set to `0` or `false`, only distinct values of the searched field are returned. When set to `1` or `true`, the ID of each found item is returned.
          * @param {number} [start] Pagination start
          * @param {number} [limit] Items shown per page
-
+         * @deprecated
          * @throws {RequiredError}
          */
         searchItemByField: (term, field_type, field_key, exact_match, return_item_ids, start, limit) => __awaiter(this, void 0, void 0, function* () {
@@ -180,7 +180,7 @@ export const ItemSearchApiFp = function (configuration) {
          * @param {'deal.cc_email' | 'person.picture' | 'product.price'} [include_fields] A comma-separated string array. 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 `search_for_related_items` parameter.
          * @param {number} [limit] Items shown per page
-
+         * @deprecated
          * @throws {RequiredError}
          */
         searchItem(term, item_types, fields, search_for_related_items, exact_match, include_fields, start, limit) {
@@ -199,7 +199,7 @@ export const ItemSearchApiFp = function (configuration) {
          * @param {boolean} [return_item_ids] Whether to return the IDs of the matching items or not. When not set or set to `0` or `false`, only distinct values of the searched field are returned. When set to `1` or `true`, the ID of each found item is returned.
          * @param {number} [start] Pagination start
          * @param {number} [limit] Items shown per page
-
+         * @deprecated
          * @throws {RequiredError}
          */
         searchItemByField(term, field_type, field_key, exact_match, return_item_ids, start, limit) {
@@ -221,7 +221,7 @@ export const ItemSearchApiFactory = function (configuration, basePath, axios) {
          * Performs a search from your choice of item types and fields.
          * @summary Perform a search from multiple item types
          * @param {ItemSearchApiSearchItemRequest} requestParameters Request parameters.
-
+         * @deprecated
          * @throws {RequiredError}
          */
         searchItem(requestParameters) {
@@ -231,7 +231,7 @@ export const ItemSearchApiFactory = function (configuration, basePath, axios) {
          * Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (deals, leads, persons, organizations or products).
          * @summary Perform a search using a specific field from an item type
          * @param {ItemSearchApiSearchItemByFieldRequest} requestParameters Request parameters.
-
+         * @deprecated
          * @throws {RequiredError}
          */
         searchItemByField(requestParameters) {
@@ -250,7 +250,7 @@ export class ItemSearchApi extends BaseAPI {
      * Performs a search from your choice of item types and fields.
      * @summary Perform a search from multiple item types
      * @param {ItemSearchApiSearchItemRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ItemSearchApi
      */
@@ -261,7 +261,7 @@ export class ItemSearchApi extends BaseAPI {
      * Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (deals, leads, persons, organizations or products).
      * @summary Perform a search using a specific field from an item type
      * @param {ItemSearchApiSearchItemByFieldRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ItemSearchApi
      */

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

@@ -40,6 +40,20 @@ export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     deleteLead: (id: string) => Promise<RequestArgs>;
+    /**
+     * Returns multiple archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
+     * @summary Get all archived leads
+     * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
+     * @param {number} [start] For pagination, the position that represents the first result for the page
+     * @param {number} [owner_id] If supplied, only leads matching the given user will be returned. However, &#x60;filter_id&#x60; takes precedence over &#x60;owner_id&#x60; when supplied.
+     * @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, &#x60;filter_id&#x60; takes precedence over &#x60;person_id&#x60; when supplied.
+     * @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, &#x60;filter_id&#x60; takes precedence over &#x60;organization_id&#x60; when supplied.
+     * @param {number} [filter_id] The ID of the filter to use
+     * @param {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'} [sort] The field names and sorting mode separated by a comma (&#x60;field_name_1 ASC&#x60;, &#x60;field_name_2 DESC&#x60;). Only first-level field keys are supported (no nested keys).
+
+     * @throws {RequiredError}
+     */
+    getArchivedLeads: (limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, sort?: 'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time') => Promise<RequestArgs>;
     /**
      * Returns details of a specific lead. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals.
      * @summary Get one lead
@@ -57,11 +71,10 @@ export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration)
      */
     getLeadUsers: (id: string) => Promise<RequestArgs>;
     /**
-     * Returns multiple leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
+     * Returns multiple not archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
      * @summary Get all leads
      * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
      * @param {number} [start] For pagination, the position that represents the first result for the page
-     * @param {'archived' | 'not_archived' | 'all'} [archived_status] Filtering based on the archived status of a lead. If not provided, &#x60;All&#x60; is used.
      * @param {number} [owner_id] If supplied, only leads matching the given user will be returned. However, &#x60;filter_id&#x60; takes precedence over &#x60;owner_id&#x60; when supplied.
      * @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, &#x60;filter_id&#x60; takes precedence over &#x60;person_id&#x60; when supplied.
      * @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, &#x60;filter_id&#x60; takes precedence over &#x60;organization_id&#x60; when supplied.
@@ -70,7 +83,7 @@ export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration)
 
      * @throws {RequiredError}
      */
-    getLeads: (limit?: number, start?: number, archived_status?: 'archived' | 'not_archived' | 'all', owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, sort?: 'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time') => Promise<RequestArgs>;
+    getLeads: (limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, sort?: 'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time') => Promise<RequestArgs>;
     /**
      * Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
      * @summary Search leads
@@ -117,6 +130,20 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteLead(id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadIdResponse>>;
+    /**
+     * Returns multiple archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
+     * @summary Get all archived leads
+     * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
+     * @param {number} [start] For pagination, the position that represents the first result for the page
+     * @param {number} [owner_id] If supplied, only leads matching the given user will be returned. However, &#x60;filter_id&#x60; takes precedence over &#x60;owner_id&#x60; when supplied.
+     * @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, &#x60;filter_id&#x60; takes precedence over &#x60;person_id&#x60; when supplied.
+     * @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, &#x60;filter_id&#x60; takes precedence over &#x60;organization_id&#x60; when supplied.
+     * @param {number} [filter_id] The ID of the filter to use
+     * @param {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'} [sort] The field names and sorting mode separated by a comma (&#x60;field_name_1 ASC&#x60;, &#x60;field_name_2 DESC&#x60;). Only first-level field keys are supported (no nested keys).
+
+     * @throws {RequiredError}
+     */
+    getArchivedLeads(limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, sort?: 'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadsResponse>>;
     /**
      * Returns details of a specific lead. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals.
      * @summary Get one lead
@@ -134,11 +161,10 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
      */
     getLeadUsers(id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UserIds>>;
     /**
-     * Returns multiple leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
+     * Returns multiple not archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
      * @summary Get all leads
      * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
      * @param {number} [start] For pagination, the position that represents the first result for the page
-     * @param {'archived' | 'not_archived' | 'all'} [archived_status] Filtering based on the archived status of a lead. If not provided, &#x60;All&#x60; is used.
      * @param {number} [owner_id] If supplied, only leads matching the given user will be returned. However, &#x60;filter_id&#x60; takes precedence over &#x60;owner_id&#x60; when supplied.
      * @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, &#x60;filter_id&#x60; takes precedence over &#x60;person_id&#x60; when supplied.
      * @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, &#x60;filter_id&#x60; takes precedence over &#x60;organization_id&#x60; when supplied.
@@ -147,7 +173,7 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
 
      * @throws {RequiredError}
      */
-    getLeads(limit?: number, start?: number, archived_status?: 'archived' | 'not_archived' | 'all', owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, sort?: 'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadsResponse>>;
+    getLeads(limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, sort?: 'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadsResponse>>;
     /**
      * Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
      * @summary Search leads
@@ -194,6 +220,14 @@ export declare const LeadsApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     deleteLead(requestParameters: LeadsApiDeleteLeadRequest): Promise<GetLeadIdResponse>;
+    /**
+     * Returns multiple archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
+     * @summary Get all archived leads
+     * @param {LeadsApiGetArchivedLeadsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getArchivedLeads(requestParameters?: LeadsApiGetArchivedLeadsRequest): Promise<GetLeadsResponse>;
     /**
      * Returns details of a specific lead. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals.
      * @summary Get one lead
@@ -211,7 +245,7 @@ export declare const LeadsApiFactory: (configuration?: Configuration, basePath?:
      */
     getLeadUsers(requestParameters: LeadsApiGetLeadUsersRequest): Promise<UserIds>;
     /**
-     * Returns multiple leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
+     * Returns multiple not archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
      * @summary Get all leads
      * @param {LeadsApiGetLeadsRequest} requestParameters Request parameters.
 
@@ -261,6 +295,55 @@ export interface LeadsApiDeleteLeadRequest {
      */
     readonly id: string;
 }
+/**
+ * Request parameters for getArchivedLeads operation in LeadsApi.
+ * @export
+ * @interface LeadsApiGetArchivedLeadsRequest
+ */
+export interface LeadsApiGetArchivedLeadsRequest {
+    /**
+     * For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
+     * @type {number}
+     * @memberof LeadsApiGetArchivedLeads
+     */
+    readonly limit?: number;
+    /**
+     * For pagination, the position that represents the first result for the page
+     * @type {number}
+     * @memberof LeadsApiGetArchivedLeads
+     */
+    readonly start?: number;
+    /**
+     * If supplied, only leads matching the given user will be returned. However, &#x60;filter_id&#x60; takes precedence over &#x60;owner_id&#x60; when supplied.
+     * @type {number}
+     * @memberof LeadsApiGetArchivedLeads
+     */
+    readonly owner_id?: number;
+    /**
+     * If supplied, only leads matching the given person will be returned. However, &#x60;filter_id&#x60; takes precedence over &#x60;person_id&#x60; when supplied.
+     * @type {number}
+     * @memberof LeadsApiGetArchivedLeads
+     */
+    readonly person_id?: number;
+    /**
+     * If supplied, only leads matching the given organization will be returned. However, &#x60;filter_id&#x60; takes precedence over &#x60;organization_id&#x60; when supplied.
+     * @type {number}
+     * @memberof LeadsApiGetArchivedLeads
+     */
+    readonly organization_id?: number;
+    /**
+     * The ID of the filter to use
+     * @type {number}
+     * @memberof LeadsApiGetArchivedLeads
+     */
+    readonly filter_id?: 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 {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'}
+     * @memberof LeadsApiGetArchivedLeads
+     */
+    readonly sort?: 'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time';
+}
 /**
  * Request parameters for getLead operation in LeadsApi.
  * @export
@@ -305,12 +388,6 @@ export interface LeadsApiGetLeadsRequest {
      * @memberof LeadsApiGetLeads
      */
     readonly start?: number;
-    /**
-     * Filtering based on the archived status of a lead. If not provided, &#x60;All&#x60; is used.
-     * @type {'archived' | 'not_archived' | 'all'}
-     * @memberof LeadsApiGetLeads
-     */
-    readonly archived_status?: 'archived' | 'not_archived' | 'all';
     /**
      * If supplied, only leads matching the given user will be returned. However, &#x60;filter_id&#x60; takes precedence over &#x60;owner_id&#x60; when supplied.
      * @type {number}
@@ -441,6 +518,15 @@ export declare class LeadsApi extends BaseAPI {
      * @memberof LeadsApi
      */
     deleteLead(requestParameters: LeadsApiDeleteLeadRequest): Promise<GetLeadIdResponse>;
+    /**
+     * Returns multiple archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
+     * @summary Get all archived leads
+     * @param {LeadsApiGetArchivedLeadsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof LeadsApi
+     */
+    getArchivedLeads(requestParameters?: LeadsApiGetArchivedLeadsRequest): Promise<GetLeadsResponse>;
     /**
      * Returns details of a specific lead. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals.
      * @summary Get one lead
@@ -460,7 +546,7 @@ export declare class LeadsApi extends BaseAPI {
      */
     getLeadUsers(requestParameters: LeadsApiGetLeadUsersRequest): Promise<UserIds>;
     /**
-     * Returns multiple leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
+     * Returns multiple not archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
      * @summary Get all leads
      * @param {LeadsApiGetLeadsRequest} requestParameters Request parameters.
 

package/dist/esm/versions/v1/api/leads-api.js

@@ -99,6 +99,64 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Returns multiple archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
+         * @summary Get all archived leads
+         * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
+         * @param {number} [start] For pagination, the position that represents the first result for the page
+         * @param {number} [owner_id] If supplied, only leads matching the given user will be returned. However, `filter_id` takes precedence over `owner_id` when supplied.
+         * @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
+         * @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
+         * @param {number} [filter_id] The ID of the filter to use
+         * @param {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
+
+         * @throws {RequiredError}
+         */
+        getArchivedLeads: (limit, start, owner_id, person_id, organization_id, filter_id, sort) => __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = `/leads/archived`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication api_key required
+            yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["leads:read", "leads:full"], configuration);
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+            if (start !== undefined) {
+                localVarQueryParameter['start'] = start;
+            }
+            if (owner_id !== undefined) {
+                localVarQueryParameter['owner_id'] = owner_id;
+            }
+            if (person_id !== undefined) {
+                localVarQueryParameter['person_id'] = person_id;
+            }
+            if (organization_id !== undefined) {
+                localVarQueryParameter['organization_id'] = organization_id;
+            }
+            if (filter_id !== undefined) {
+                localVarQueryParameter['filter_id'] = filter_id;
+            }
+            if (sort !== undefined) {
+                localVarQueryParameter['sort'] = sort;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Returns details of a specific lead. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals.
          * @summary Get one lead
@@ -168,11 +226,10 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Returns multiple leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
+         * Returns multiple not archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
          * @summary Get all leads
          * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
          * @param {number} [start] For pagination, the position that represents the first result for the page
-         * @param {'archived' | 'not_archived' | 'all'} [archived_status] Filtering based on the archived status of a lead. If not provided, `All` is used.
          * @param {number} [owner_id] If supplied, only leads matching the given user will be returned. However, `filter_id` takes precedence over `owner_id` when supplied.
          * @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
          * @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
@@ -181,7 +238,7 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
 
          * @throws {RequiredError}
          */
-        getLeads: (limit, start, archived_status, owner_id, person_id, organization_id, filter_id, sort) => __awaiter(this, void 0, void 0, function* () {
+        getLeads: (limit, start, owner_id, person_id, organization_id, filter_id, sort) => __awaiter(this, void 0, void 0, function* () {
             const localVarPath = `/leads`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -203,9 +260,6 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
             if (start !== undefined) {
                 localVarQueryParameter['start'] = start;
             }
-            if (archived_status !== undefined) {
-                localVarQueryParameter['archived_status'] = archived_status;
-            }
             if (owner_id !== undefined) {
                 localVarQueryParameter['owner_id'] = owner_id;
             }
@@ -365,6 +419,25 @@ export const LeadsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Returns multiple archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
+         * @summary Get all archived leads
+         * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
+         * @param {number} [start] For pagination, the position that represents the first result for the page
+         * @param {number} [owner_id] If supplied, only leads matching the given user will be returned. However, `filter_id` takes precedence over `owner_id` when supplied.
+         * @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
+         * @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
+         * @param {number} [filter_id] The ID of the filter to use
+         * @param {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
+
+         * @throws {RequiredError}
+         */
+        getArchivedLeads(limit, start, owner_id, person_id, organization_id, filter_id, sort) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getArchivedLeads(limit, start, owner_id, person_id, organization_id, filter_id, sort);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
         /**
          * Returns details of a specific lead. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals.
          * @summary Get one lead
@@ -392,11 +465,10 @@ export const LeadsApiFp = function (configuration) {
             });
         },
         /**
-         * Returns multiple leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
+         * Returns multiple not archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
          * @summary Get all leads
          * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
          * @param {number} [start] For pagination, the position that represents the first result for the page
-         * @param {'archived' | 'not_archived' | 'all'} [archived_status] Filtering based on the archived status of a lead. If not provided, `All` is used.
          * @param {number} [owner_id] If supplied, only leads matching the given user will be returned. However, `filter_id` takes precedence over `owner_id` when supplied.
          * @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
          * @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
@@ -405,9 +477,9 @@ export const LeadsApiFp = function (configuration) {
 
          * @throws {RequiredError}
          */
-        getLeads(limit, start, archived_status, owner_id, person_id, organization_id, filter_id, sort) {
+        getLeads(limit, start, owner_id, person_id, organization_id, filter_id, sort) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getLeads(limit, start, archived_status, owner_id, person_id, organization_id, filter_id, sort);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getLeads(limit, start, owner_id, person_id, organization_id, filter_id, sort);
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
@@ -474,6 +546,16 @@ export const LeadsApiFactory = function (configuration, basePath, axios) {
         deleteLead(requestParameters) {
             return localVarFp.deleteLead(requestParameters.id).then((request) => request(axios, basePath));
         },
+        /**
+         * Returns multiple archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
+         * @summary Get all archived leads
+         * @param {LeadsApiGetArchivedLeadsRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getArchivedLeads(requestParameters = {}) {
+            return localVarFp.getArchivedLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(axios, basePath));
+        },
         /**
          * Returns details of a specific lead. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals.
          * @summary Get one lead
@@ -495,14 +577,14 @@ export const LeadsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getLeadUsers(requestParameters.id).then((request) => request(axios, basePath));
         },
         /**
-         * Returns multiple leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
+         * Returns multiple not archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
          * @summary Get all leads
          * @param {LeadsApiGetLeadsRequest} requestParameters Request parameters.
 
          * @throws {RequiredError}
          */
         getLeads(requestParameters = {}) {
-            return localVarFp.getLeads(requestParameters.limit, requestParameters.start, requestParameters.archived_status, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(axios, basePath));
+            return localVarFp.getLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(axios, basePath));
         },
         /**
          * Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
@@ -555,6 +637,17 @@ export class LeadsApi extends BaseAPI {
     deleteLead(requestParameters) {
         return LeadsApiFp(this.configuration).deleteLead(requestParameters.id).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Returns multiple archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
+     * @summary Get all archived leads
+     * @param {LeadsApiGetArchivedLeadsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof LeadsApi
+     */
+    getArchivedLeads(requestParameters = {}) {
+        return LeadsApiFp(this.configuration).getArchivedLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Returns details of a specific lead. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals.
      * @summary Get one lead
@@ -578,7 +671,7 @@ export class LeadsApi extends BaseAPI {
         return LeadsApiFp(this.configuration).getLeadUsers(requestParameters.id).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Returns multiple leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
+     * Returns multiple not archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
      * @summary Get all leads
      * @param {LeadsApiGetLeadsRequest} requestParameters Request parameters.
 
@@ -586,7 +679,7 @@ export class LeadsApi extends BaseAPI {
      * @memberof LeadsApi
      */
     getLeads(requestParameters = {}) {
-        return LeadsApiFp(this.configuration).getLeads(requestParameters.limit, requestParameters.start, requestParameters.archived_status, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(this.axios, this.basePath));
+        return LeadsApiFp(this.configuration).getLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.