pipedrive 35.0.0 → 35.1.1

package/dist/esm/versions/v1/models/lead.d.ts

@@ -87,6 +87,11 @@ export interface Lead {
     */
     'is_archived': boolean;
     /**
+    * The reason for archiving the lead. Automatically cleared when the lead is unarchived.
+    * @type {string}
+    */
+    'archive_reason': string | null;
+    /**
     * A flag indicating whether the lead was seen by someone in the Pipedrive UI
     * @type {boolean}
     */

package/dist/esm/versions/v1/models/update-lead-request.d.ts

@@ -47,6 +47,11 @@ export interface UpdateLeadRequest {
     */
     'is_archived'?: boolean;
     /**
+    * The reason for archiving the lead. Can only be provided when `is_archived` is being set to `true` in the same request, or when updating a lead that\'s already archived — providing it otherwise will return a 400 error. Automatically cleared when the lead is unarchived. If archiving with a reason is required for your company, archiving a lead without providing one will also return a 400 error.
+    * @type {string}
+    */
+    'archive_reason'?: string | null;
+    /**
     *
     * @type {LeadValue}
     */

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

@@ -201,14 +201,14 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
      * @param {number} [person_id] Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.
      * @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
-     * @param {Set<'open' | 'won' | 'lost'>} [status] Will filter deals by the provided specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost. The upper limit of found deals associated with the status is 2000.
+     * @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost. The upper limit of found deals associated with the status is 2000.
      * @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
      * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
      * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
 
      * @throws {RequiredError}
      */
-    searchDeals: (term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, status?: Set<'open' | 'won' | 'lost'>, include_fields?: Set<'deal.cc_email'>, limit?: number, cursor?: string) => Promise<RequestArgs>;
+    searchDeals: (term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, status?: 'open' | 'won' | 'lost', include_fields?: Set<'deal.cc_email'>, limit?: number, cursor?: string) => Promise<RequestArgs>;
     /**
      * Edits a discount added to a deal, changing the deal value if the deal has one-time products attached.
      * @summary Update a discount added to a deal
@@ -399,14 +399,14 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
      * @param {number} [person_id] Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.
      * @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
-     * @param {Set<'open' | 'won' | 'lost'>} [status] Will filter deals by the provided specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost. The upper limit of found deals associated with the status is 2000.
+     * @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost. The upper limit of found deals associated with the status is 2000.
      * @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
      * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
      * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
 
      * @throws {RequiredError}
      */
-    searchDeals(term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, status?: Set<'open' | 'won' | 'lost'>, include_fields?: Set<'deal.cc_email'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealSearchResponse>>;
+    searchDeals(term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, status?: 'open' | 'won' | 'lost', include_fields?: Set<'deal.cc_email'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealSearchResponse>>;
     /**
      * Edits a discount added to a deal, changing the deal value if the deal has one-time products attached.
      * @summary Update a discount added to a deal
@@ -1059,10 +1059,10 @@ export interface DealsApiSearchDealsRequest {
     readonly organization_id?: number;
     /**
      * Will filter deals by the provided specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost. The upper limit of found deals associated with the status is 2000.
-     * @type {Set<'open' | 'won' | 'lost'>}
+     * @type {'open' | 'won' | 'lost'}
      * @memberof DealsApiSearchDeals
      */
-    readonly status?: Set<'open' | 'won' | 'lost'>;
+    readonly status?: 'open' | 'won' | 'lost';
     /**
      * Supports including optional fields in the results which are not provided by default
      * @type {Set<'deal.cc_email'>}

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

@@ -693,7 +693,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
          * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
          * @param {number} [person_id] Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.
          * @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
-         * @param {Set<'open' | 'won' | 'lost'>} [status] Will filter deals by the provided specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost. The upper limit of found deals associated with the status is 2000.
+         * @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost. The upper limit of found deals associated with the status is 2000.
          * @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
          * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
          * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
@@ -734,7 +734,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
                 localVarQueryParameter['organization_id'] = organization_id;
             }
             if (status) {
-                localVarQueryParameter['status'] = Array.from(status).join(COLLECTION_FORMATS.csv);
+                localVarQueryParameter['status'] = status;
             }
             if (include_fields) {
                 localVarQueryParameter['include_fields'] = Array.from(include_fields).join(COLLECTION_FORMATS.csv);
@@ -1075,7 +1075,7 @@ export const DealsApiFp = function (configuration) {
          * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
          * @param {number} [person_id] Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.
          * @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
-         * @param {Set<'open' | 'won' | 'lost'>} [status] Will filter deals by the provided specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost. The upper limit of found deals associated with the status is 2000.
+         * @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost. The upper limit of found deals associated with the status is 2000.
          * @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
          * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
          * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page

package/dist/versions/v1/models/lead.d.ts

@@ -87,6 +87,11 @@ export interface Lead {
     */
     'is_archived': boolean;
     /**
+    * The reason for archiving the lead. Automatically cleared when the lead is unarchived.
+    * @type {string}
+    */
+    'archive_reason': string | null;
+    /**
     * A flag indicating whether the lead was seen by someone in the Pipedrive UI
     * @type {boolean}
     */

package/dist/versions/v1/models/update-lead-request.d.ts

@@ -47,6 +47,11 @@ export interface UpdateLeadRequest {
     */
     'is_archived'?: boolean;
     /**
+    * The reason for archiving the lead. Can only be provided when `is_archived` is being set to `true` in the same request, or when updating a lead that\'s already archived — providing it otherwise will return a 400 error. Automatically cleared when the lead is unarchived. If archiving with a reason is required for your company, archiving a lead without providing one will also return a 400 error.
+    * @type {string}
+    */
+    'archive_reason'?: string | null;
+    /**
     *
     * @type {LeadValue}
     */

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

@@ -201,14 +201,14 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
      * @param {number} [person_id] Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.
      * @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
-     * @param {Set<'open' | 'won' | 'lost'>} [status] Will filter deals by the provided specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost. The upper limit of found deals associated with the status is 2000.
+     * @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost. The upper limit of found deals associated with the status is 2000.
      * @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
      * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
      * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
 
      * @throws {RequiredError}
      */
-    searchDeals: (term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, status?: Set<'open' | 'won' | 'lost'>, include_fields?: Set<'deal.cc_email'>, limit?: number, cursor?: string) => Promise<RequestArgs>;
+    searchDeals: (term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, status?: 'open' | 'won' | 'lost', include_fields?: Set<'deal.cc_email'>, limit?: number, cursor?: string) => Promise<RequestArgs>;
     /**
      * Edits a discount added to a deal, changing the deal value if the deal has one-time products attached.
      * @summary Update a discount added to a deal
@@ -399,14 +399,14 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
      * @param {number} [person_id] Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.
      * @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
-     * @param {Set<'open' | 'won' | 'lost'>} [status] Will filter deals by the provided specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost. The upper limit of found deals associated with the status is 2000.
+     * @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost. The upper limit of found deals associated with the status is 2000.
      * @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
      * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
      * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
 
      * @throws {RequiredError}
      */
-    searchDeals(term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, status?: Set<'open' | 'won' | 'lost'>, include_fields?: Set<'deal.cc_email'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealSearchResponse>>;
+    searchDeals(term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, status?: 'open' | 'won' | 'lost', include_fields?: Set<'deal.cc_email'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealSearchResponse>>;
     /**
      * Edits a discount added to a deal, changing the deal value if the deal has one-time products attached.
      * @summary Update a discount added to a deal
@@ -1059,10 +1059,10 @@ export interface DealsApiSearchDealsRequest {
     readonly organization_id?: number;
     /**
      * Will filter deals by the provided specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost. The upper limit of found deals associated with the status is 2000.
-     * @type {Set<'open' | 'won' | 'lost'>}
+     * @type {'open' | 'won' | 'lost'}
      * @memberof DealsApiSearchDeals
      */
-    readonly status?: Set<'open' | 'won' | 'lost'>;
+    readonly status?: 'open' | 'won' | 'lost';
     /**
      * Supports including optional fields in the results which are not provided by default
      * @type {Set<'deal.cc_email'>}

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

@@ -699,7 +699,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
          * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
          * @param {number} [person_id] Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.
          * @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
-         * @param {Set<'open' | 'won' | 'lost'>} [status] Will filter deals by the provided specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost. The upper limit of found deals associated with the status is 2000.
+         * @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost. The upper limit of found deals associated with the status is 2000.
          * @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
          * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
          * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
@@ -740,7 +740,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
                 localVarQueryParameter['organization_id'] = organization_id;
             }
             if (status) {
-                localVarQueryParameter['status'] = Array.from(status).join(base_1.COLLECTION_FORMATS.csv);
+                localVarQueryParameter['status'] = status;
             }
             if (include_fields) {
                 localVarQueryParameter['include_fields'] = Array.from(include_fields).join(base_1.COLLECTION_FORMATS.csv);
@@ -1082,7 +1082,7 @@ const DealsApiFp = function (configuration) {
          * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
          * @param {number} [person_id] Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.
          * @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
-         * @param {Set<'open' | 'won' | 'lost'>} [status] Will filter deals by the provided specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost. The upper limit of found deals associated with the status is 2000.
+         * @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost. The upper limit of found deals associated with the status is 2000.
          * @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
          * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
          * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pipedrive",
-  "version": "35.0.0",
+  "version": "35.1.1",
   "description": "Pipedrive REST client for NodeJS",
   "license": "MIT",
   "homepage": "https://developers.pipedrive.com",