pipedrive 33.8.0 → 34.0.0

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

@@ -25,7 +25,7 @@ import globalAxios from 'axios';
 // @ts-ignore
 import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
 // @ts-ignore
-import { BASE_PATH, BaseAPI } from '../base';
+import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from '../base';
 /**
  * ProductsApi - axios parameter creator
  * @export
@@ -515,18 +515,18 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
          * Returns data about all products.
          * @summary Get all products
          * @param {number} [owner_id] If supplied, only products owned by the given user will be returned
-         * @param {string} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
+         * @param {Set<string>} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
+         * @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
          * @param {number} [filter_id] The ID of the filter to use
          * @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 {'id' | 'name' | 'add_time' | 'update_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;name&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
          * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
          * @param {string} [updated_since] If set, only products with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
-         * @param {string} [custom_fields] Comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for a smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
 
          * @throws {RequiredError}
          */
-        getProducts: (owner_id, ids, filter_id, cursor, limit, sort_by, sort_direction, updated_since, custom_fields) => __awaiter(this, void 0, void 0, function* () {
+        getProducts: (owner_id, ids, custom_fields, filter_id, cursor, limit, sort_by, sort_direction, updated_since) => __awaiter(this, void 0, void 0, function* () {
             const localVarPath = `/products`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -545,8 +545,11 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
             if (owner_id !== undefined) {
                 localVarQueryParameter['owner_id'] = owner_id;
             }
-            if (ids !== undefined) {
-                localVarQueryParameter['ids'] = ids;
+            if (ids) {
+                localVarQueryParameter['ids'] = Array.from(ids).join(COLLECTION_FORMATS.csv);
+            }
+            if (custom_fields) {
+                localVarQueryParameter['custom_fields'] = Array.from(custom_fields).join(COLLECTION_FORMATS.csv);
             }
             if (filter_id !== undefined) {
                 localVarQueryParameter['filter_id'] = filter_id;
@@ -566,9 +569,6 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
             if (updated_since !== undefined) {
                 localVarQueryParameter['updated_since'] = updated_since;
             }
-            if (custom_fields !== undefined) {
-                localVarQueryParameter['custom_fields'] = custom_fields;
-            }
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
@@ -989,20 +989,20 @@ export const ProductsApiFp = function (configuration) {
          * Returns data about all products.
          * @summary Get all products
          * @param {number} [owner_id] If supplied, only products owned by the given user will be returned
-         * @param {string} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
+         * @param {Set<string>} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
+         * @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
          * @param {number} [filter_id] The ID of the filter to use
          * @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 {'id' | 'name' | 'add_time' | 'update_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;name&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
          * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
          * @param {string} [updated_since] If set, only products with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
-         * @param {string} [custom_fields] Comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for a smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
 
          * @throws {RequiredError}
          */
-        getProducts(owner_id, ids, filter_id, cursor, limit, sort_by, sort_direction, updated_since, custom_fields) {
+        getProducts(owner_id, ids, custom_fields, filter_id, cursor, limit, sort_by, sort_direction, updated_since) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getProducts(owner_id, ids, filter_id, cursor, limit, sort_by, sort_direction, updated_since, custom_fields);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getProducts(owner_id, ids, custom_fields, filter_id, cursor, limit, sort_by, sort_direction, updated_since);
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
@@ -1228,7 +1228,7 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         getProducts(requestParameters = {}) {
-            return localVarFp.getProducts(requestParameters.owner_id, requestParameters.ids, requestParameters.filter_id, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.updated_since, requestParameters.custom_fields).then((request) => request(axios, basePath));
+            return localVarFp.getProducts(requestParameters.owner_id, requestParameters.ids, requestParameters.custom_fields, requestParameters.filter_id, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.updated_since).then((request) => request(axios, basePath));
         },
         /**
          * Searches all products by name, code 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.
@@ -1441,7 +1441,7 @@ export class ProductsApi extends BaseAPI {
      * @memberof ProductsApi
      */
     getProducts(requestParameters = {}) {
-        return ProductsApiFp(this.configuration).getProducts(requestParameters.owner_id, requestParameters.ids, requestParameters.filter_id, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.updated_since, requestParameters.custom_fields).then((request) => request(this.axios, this.basePath));
+        return ProductsApiFp(this.configuration).getProducts(requestParameters.owner_id, requestParameters.ids, requestParameters.custom_fields, requestParameters.filter_id, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.updated_since).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Searches all products by name, code 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.

package/dist/esm/versions/v2/models/activity-item-location.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Pipedrive API v2
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+* Location of the activity
+* @export
+* @interface ActivityItemLocation
+*/
+export interface ActivityItemLocation {
+    /**
+    * The full address of the activity
+    * @type {string}
+    */
+    'value'?: string;
+    /**
+    * Country of the activity
+    * @type {string}
+    */
+    'country'?: string | null;
+    /**
+    * Admin area level 1 (e.g. state) of the activity
+    * @type {string}
+    */
+    'admin_area_level_1'?: string | null;
+    /**
+    * Admin area level 2 (e.g. county) of the activity
+    * @type {string}
+    */
+    'admin_area_level_2'?: string | null;
+    /**
+    * Locality (e.g. city) of the activity
+    * @type {string}
+    */
+    'locality'?: string | null;
+    /**
+    * Sublocality (e.g. neighborhood) of the activity
+    * @type {string}
+    */
+    'sublocality'?: string | null;
+    /**
+    * Route (e.g. street) of the activity
+    * @type {string}
+    */
+    'route'?: string | null;
+    /**
+    * Street number of the activity
+    * @type {string}
+    */
+    'street_number'?: string | null;
+    /**
+    * Subpremise (e.g. apartment/suite number) of the activity
+    * @type {string}
+    */
+    'subpremise'?: string | null;
+    /**
+    * Postal code of the activity
+    * @type {string}
+    */
+    'postal_code'?: string | null;
+}

package/dist/esm/versions/v2/models/activity-item-location.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Pipedrive API v2
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/esm/versions/v2/models/activity-item.d.ts

@@ -9,8 +9,8 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { ActivityItemLocation } from './activity-item-location';
 import { AddActivityRequestAttendeesInner } from './add-activity-request-attendees-inner';
-import { AddActivityRequestLocation } from './add-activity-request-location';
 import { AddActivityRequestParticipantsInner } from './add-activity-request-participants-inner';
 /**
 *
@@ -62,27 +62,27 @@ export interface ActivityItem {
     * The ID of the deal linked to the activity
     * @type {number}
     */
-    'deal_id'?: number;
+    'deal_id'?: number | null;
     /**
     * The ID of the lead linked to the activity
     * @type {string}
     */
-    'lead_id'?: string;
+    'lead_id'?: string | null;
     /**
     * The ID of the person linked to the activity
     * @type {number}
     */
-    'person_id'?: number;
+    'person_id'?: number | null;
     /**
     * The ID of the organization linked to the activity
     * @type {number}
     */
-    'org_id'?: number;
+    'org_id'?: number | null;
     /**
     * The ID of the project linked to the activity
     * @type {number}
     */
-    'project_id'?: number;
+    'project_id'?: number | null;
     /**
     * The due date of the activity
     * @type {string}
@@ -92,12 +92,12 @@ export interface ActivityItem {
     * The due time of the activity
     * @type {string}
     */
-    'due_time'?: string;
+    'due_time'?: string | null;
     /**
     * The duration of the activity
     * @type {string}
     */
-    'duration'?: string;
+    'duration'?: string | null;
     /**
     * Whether the activity marks the assignee as busy or not in their calendar
     * @type {boolean}
@@ -112,12 +112,12 @@ export interface ActivityItem {
     * The date and time when the activity was marked as done
     * @type {string}
     */
-    'marked_as_done_time'?: string;
+    'marked_as_done_time'?: string | null;
     /**
     *
-    * @type {AddActivityRequestLocation}
+    * @type {ActivityItemLocation}
     */
-    'location'?: AddActivityRequestLocation;
+    'location'?: ActivityItemLocation | null;
     /**
     * The participants of the activity
     * @type {Array<AddActivityRequestParticipantsInner>}

package/dist/esm/versions/v2/models/add-organization-request.d.ts

@@ -45,7 +45,7 @@ export interface AddOrganizationRequest {
     *
     * @type {OrganizationItemAddress}
     */
-    'address'?: OrganizationItemAddress;
+    'address'?: OrganizationItemAddress | null;
     /**
     * The website of the organization
     * @type {string}

package/dist/esm/versions/v2/models/add-person-request.d.ts

@@ -63,7 +63,7 @@ export interface AddPersonRequest {
     *
     * @type {PersonItemAddress}
     */
-    'postal_address'?: PersonItemAddress;
+    'postal_address'?: PersonItemAddress | null;
     /**
     * Contact sync notes of the person, maximum 10 000 characters. Only accepted when contact sync is enabled for the company; otherwise the request returns 403.
     * @type {string}

package/dist/esm/versions/v2/models/deal.d.ts

@@ -69,7 +69,7 @@ export interface Deal {
     * The last updated date and time of the deal
     * @type {string}
     */
-    'update_time'?: string;
+    'update_time'?: string | null;
     /**
     * The last updated date and time of the deal stage
     * @type {string}

package/dist/esm/versions/v2/models/get-activities-response-all-of-additional-data.d.ts

@@ -19,5 +19,5 @@ export interface GetActivitiesResponseAllOfAdditionalData {
     * The first item on the next page. The value of the `next_cursor` field will be `null` if you have reached the end of the dataset and there’s no more pages to be returned.
     * @type {string}
     */
-    'next_cursor'?: string;
+    'next_cursor'?: string | null;
 }

package/dist/esm/versions/v2/models/get-deal-search-response-all-of-data-items-inner-item.d.ts

@@ -38,7 +38,7 @@ export interface GetDealSearchResponseAllOfDataItemsInnerItem {
     * The value of the deal
     * @type {number}
     */
-    'value'?: number;
+    'value'?: number | null;
     /**
     * The currency of the deal
     * @type {string}

package/dist/esm/versions/v2/models/get-deals-products-response-additional-data.d.ts

@@ -19,5 +19,5 @@ export interface GetDealsProductsResponseAdditionalData {
     * The first item on the next page. The value of the `next_cursor` field will be `null` if you have reached the end of the dataset and there’s no more pages to be returned.
     * @type {string}
     */
-    'next_cursor'?: string;
+    'next_cursor'?: string | null;
 }

package/dist/esm/versions/v2/models/get-organization-search-response-all-of-data-items-inner-item.d.ts

@@ -35,7 +35,7 @@ export interface GetOrganizationSearchResponseAllOfDataItemsInnerItem {
     * The address of the organization
     * @type {string}
     */
-    'address'?: string;
+    'address'?: string | null;
     /**
     * The visibility of the organization
     * @type {number}

package/dist/esm/versions/v2/models/get-product-search-response-all-of-data-items-inner-item.d.ts

@@ -33,9 +33,9 @@ export interface GetProductSearchResponseAllOfDataItemsInnerItem {
     'name'?: string;
     /**
     * The code of the product
-    * @type {number}
+    * @type {string}
     */
-    'code'?: number;
+    'code'?: string | null;
     /**
     * The visibility of the product
     * @type {number}

package/dist/esm/versions/v2/models/index.d.ts

@@ -1,4 +1,5 @@
 export * from './activity-item';
+export * from './activity-item-location';
 export * from './add-ainstallment-response';
 export * from './add-activity-request';
 export * from './add-activity-request-attendees-inner';

package/dist/esm/versions/v2/models/index.js

@@ -1,4 +1,5 @@
 export * from './activity-item';
+export * from './activity-item-location';
 export * from './add-ainstallment-response';
 export * from './add-activity-request';
 export * from './add-activity-request-attendees-inner';

package/dist/esm/versions/v2/models/lead-search-item-item.d.ts

@@ -42,7 +42,7 @@ export interface LeadSearchItemItem {
     *
     * @type {LeadSearchItemItemPerson}
     */
-    'person'?: LeadSearchItemItemPerson;
+    'person'?: LeadSearchItemItemPerson | null;
     /**
     *
     * @type {LeadSearchItemItemOrganization}

package/dist/esm/versions/v2/models/organization-item-address.d.ts

@@ -24,45 +24,45 @@ export interface OrganizationItemAddress {
     * Country of the organization
     * @type {string}
     */
-    'country'?: string;
+    'country'?: string | null;
     /**
     * Admin area level 1 (e.g. state) of the organization
     * @type {string}
     */
-    'admin_area_level_1'?: string;
+    'admin_area_level_1'?: string | null;
     /**
     * Admin area level 2 (e.g. county) of the organization
     * @type {string}
     */
-    'admin_area_level_2'?: string;
+    'admin_area_level_2'?: string | null;
     /**
     * Locality (e.g. city) of the organization
     * @type {string}
     */
-    'locality'?: string;
+    'locality'?: string | null;
     /**
     * Sublocality (e.g. neighborhood) of the organization
     * @type {string}
     */
-    'sublocality'?: string;
+    'sublocality'?: string | null;
     /**
     * Route (e.g. street) of the organization
     * @type {string}
     */
-    'route'?: string;
+    'route'?: string | null;
     /**
     * Street number of the organization
     * @type {string}
     */
-    'street_number'?: string;
+    'street_number'?: string | null;
     /**
     * Subpremise (e.g. apartment/suite number) of the organization
     * @type {string}
     */
-    'subpremise'?: string;
+    'subpremise'?: string | null;
     /**
     * Postal code of the organization
     * @type {string}
     */
-    'postal_code'?: string;
+    'postal_code'?: string | null;
 }

package/dist/esm/versions/v2/models/organization-item.d.ts

@@ -40,7 +40,7 @@ export interface OrganizationItem {
     * The last updated date and time of the organization
     * @type {string}
     */
-    'update_time'?: string;
+    'update_time'?: string | null;
     /**
     * Whether the organization is deleted or not
     * @type {boolean}
@@ -55,7 +55,7 @@ export interface OrganizationItem {
     *
     * @type {OrganizationItemAddress}
     */
-    'address'?: OrganizationItemAddress;
+    'address'?: OrganizationItemAddress | null;
     /**
     * The IDs of labels assigned to the organization
     * @type {Array<number>}

package/dist/esm/versions/v2/models/person-item-address.d.ts

@@ -24,45 +24,45 @@ export interface PersonItemAddress {
     * Country of the person
     * @type {string}
     */
-    'country'?: string;
+    'country'?: string | null;
     /**
     * Admin area level 1 (e.g. state) of the person
     * @type {string}
     */
-    'admin_area_level_1'?: string;
+    'admin_area_level_1'?: string | null;
     /**
     * Admin area level 2 (e.g. county) of the person
     * @type {string}
     */
-    'admin_area_level_2'?: string;
+    'admin_area_level_2'?: string | null;
     /**
     * Locality (e.g. city) of the person
     * @type {string}
     */
-    'locality'?: string;
+    'locality'?: string | null;
     /**
     * Sublocality (e.g. neighborhood) of the person
     * @type {string}
     */
-    'sublocality'?: string;
+    'sublocality'?: string | null;
     /**
     * Route (e.g. street) of the person
     * @type {string}
     */
-    'route'?: string;
+    'route'?: string | null;
     /**
     * Street number of the person
     * @type {string}
     */
-    'street_number'?: string;
+    'street_number'?: string | null;
     /**
     * Subpremise (e.g. apartment/suite number) of the person
     * @type {string}
     */
-    'subpremise'?: string;
+    'subpremise'?: string | null;
     /**
     * Postal code of the person
     * @type {string}
     */
-    'postal_code'?: string;
+    'postal_code'?: string | null;
 }

package/dist/esm/versions/v2/models/person.d.ts

@@ -58,7 +58,7 @@ export interface Person {
     * The last updated date and time of the person
     * @type {string}
     */
-    'update_time'?: string;
+    'update_time'?: string | null;
     /**
     * The emails of the person
     * @type {Array<PersonItemEmail>}
@@ -88,12 +88,12 @@ export interface Person {
     * The ID of the picture associated with the person
     * @type {number}
     */
-    'picture_id'?: number;
+    'picture_id'?: number | null;
     /**
     *
     * @type {PersonItemAddress}
     */
-    'postal_address'?: PersonItemAddress;
+    'postal_address'?: PersonItemAddress | null;
     /**
     * Contact sync notes of the person, maximum 10 000 characters, included if contact sync is enabled for the company
     * @type {string}

package/dist/esm/versions/v2/models/stage-item.d.ts

@@ -64,5 +64,5 @@ export interface StageItem {
     * The stage update time
     * @type {string}
     */
-    'update_time'?: string;
+    'update_time'?: string | null;
 }

package/dist/esm/versions/v2/models/stage-item1.d.ts

@@ -64,5 +64,5 @@ export interface StageItem1 {
     * The stage update time
     * @type {string}
     */
-    'update_time'?: string;
+    'update_time'?: string | null;
 }

package/dist/esm/versions/v2/models/update-organization-request.d.ts

@@ -40,7 +40,7 @@ export interface UpdateOrganizationRequest {
     *
     * @type {OrganizationItemAddress}
     */
-    'address'?: OrganizationItemAddress;
+    'address'?: OrganizationItemAddress | null;
     /**
     * The website of the organization
     * @type {string}

package/dist/esm/versions/v2/models/update-person-request.d.ts

@@ -58,7 +58,7 @@ export interface UpdatePersonRequest {
     *
     * @type {PersonItemAddress}
     */
-    'postal_address'?: PersonItemAddress;
+    'postal_address'?: PersonItemAddress | null;
     /**
     * Contact sync notes of the person, maximum 10 000 characters. Only accepted when contact sync is enabled for the company; otherwise the request returns 403.
     * @type {string}

package/dist/versions/v1/models/deal-all-of-creator-user-id.d.ts

@@ -32,9 +32,9 @@ export interface DealAllOfCreatorUserId {
     'email'?: string;
     /**
     * If the creator has a picture or not
-    * @type {boolean}
+    * @type {number}
     */
-    'has_pic'?: boolean;
+    'has_pic'?: number;
     /**
     * The creator picture hash
     * @type {string}

package/dist/versions/v1/models/get-associated-product-files-response-all-of.d.ts

@@ -21,7 +21,7 @@ export interface GetAssociatedProductFilesResponseAllOf {
     * The array of files
     * @type {Array<GetAssociatedProductFilesResponseAllOfDataInner>}
     */
-    'data': Array<GetAssociatedProductFilesResponseAllOfDataInner>;
+    'data': Array<GetAssociatedProductFilesResponseAllOfDataInner> | null;
     /**
     *
     * @type {GetFieldsResponseAllOfAdditionalData}