pipedrive 33.1.1 → 33.2.0

package/dist/esm/versions/v2/api/deal-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';
 /**
  * DealProductsApi - axios parameter creator
  * @export
@@ -262,7 +262,7 @@ export const DealProductsApiAxiosParamCreator = function (configuration) {
             // oauth required
             yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:read", "products:full", "deals:read", "deals:full"], configuration);
             if (deal_ids) {
-                localVarQueryParameter['deal_ids'] = deal_ids;
+                localVarQueryParameter['deal_ids'] = deal_ids.join(COLLECTION_FORMATS.csv);
             }
             if (cursor !== undefined) {
                 localVarQueryParameter['cursor'] = cursor;

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

@@ -93,12 +93,15 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
      * @param {number} [filter_id] If supplied, only projects matching the specified filter are returned
      * @param {string} [status] If supplied, includes only projects with the specified statuses. Possible values are `open`, `completed`, `canceled` and `deleted`. By default `deleted` projects are not returned.
      * @param {number} [phase_id] If supplied, only projects in the specified phase are returned
+     * @param {number} [deal_id] If supplied, only projects associated with the specified deal are returned
+     * @param {number} [person_id] If supplied, only projects associated with the specified person are returned
+     * @param {number} [org_id] If supplied, only projects associated with the specified organization are returned
      * @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}
      */
-    getProjects: (filter_id?: number, status?: string, phase_id?: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
+    getProjects: (filter_id?: number, status?: string, phase_id?: number, deal_id?: number, person_id?: number, org_id?: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
     /**
      * Searches all projects by title, description, 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 projects can be filtered by person ID or organization ID.
      * @summary Search projects
@@ -196,12 +199,15 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
      * @param {number} [filter_id] If supplied, only projects matching the specified filter are returned
      * @param {string} [status] If supplied, includes only projects with the specified statuses. Possible values are &#x60;open&#x60;, &#x60;completed&#x60;, &#x60;canceled&#x60; and &#x60;deleted&#x60;. By default &#x60;deleted&#x60; projects are not returned.
      * @param {number} [phase_id] If supplied, only projects in the specified phase are returned
+     * @param {number} [deal_id] If supplied, only projects associated with the specified deal are returned
+     * @param {number} [person_id] If supplied, only projects associated with the specified person are returned
+     * @param {number} [org_id] If supplied, only projects associated with the specified organization are returned
      * @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}
      */
-    getProjects(filter_id?: number, status?: string, phase_id?: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProjectsResponse>>;
+    getProjects(filter_id?: number, status?: string, phase_id?: number, deal_id?: number, person_id?: number, org_id?: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProjectsResponse>>;
     /**
      * Searches all projects by title, description, 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 projects can be filtered by person ID or organization ID.
      * @summary Search projects
@@ -463,6 +469,24 @@ export interface ProjectsApiGetProjectsRequest {
      * @memberof ProjectsApiGetProjects
      */
     readonly phase_id?: number;
+    /**
+     * If supplied, only projects associated with the specified deal are returned
+     * @type {number}
+     * @memberof ProjectsApiGetProjects
+     */
+    readonly deal_id?: number;
+    /**
+     * If supplied, only projects associated with the specified person are returned
+     * @type {number}
+     * @memberof ProjectsApiGetProjects
+     */
+    readonly person_id?: number;
+    /**
+     * If supplied, only projects associated with the specified organization are returned
+     * @type {number}
+     * @memberof ProjectsApiGetProjects
+     */
+    readonly org_id?: number;
     /**
      * For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
      * @type {number}

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

@@ -301,12 +301,15 @@ export const ProjectsApiAxiosParamCreator = function (configuration) {
          * @param {number} [filter_id] If supplied, only projects matching the specified filter are returned
          * @param {string} [status] If supplied, includes only projects with the specified statuses. Possible values are `open`, `completed`, `canceled` and `deleted`. By default `deleted` projects are not returned.
          * @param {number} [phase_id] If supplied, only projects in the specified phase are returned
+         * @param {number} [deal_id] If supplied, only projects associated with the specified deal are returned
+         * @param {number} [person_id] If supplied, only projects associated with the specified person are returned
+         * @param {number} [org_id] If supplied, only projects associated with the specified organization are returned
          * @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}
          */
-        getProjects: (filter_id, status, phase_id, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
+        getProjects: (filter_id, status, phase_id, deal_id, person_id, org_id, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
             const localVarPath = `/projects`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -331,6 +334,15 @@ export const ProjectsApiAxiosParamCreator = function (configuration) {
             if (phase_id !== undefined) {
                 localVarQueryParameter['phase_id'] = phase_id;
             }
+            if (deal_id !== undefined) {
+                localVarQueryParameter['deal_id'] = deal_id;
+            }
+            if (person_id !== undefined) {
+                localVarQueryParameter['person_id'] = person_id;
+            }
+            if (org_id !== undefined) {
+                localVarQueryParameter['org_id'] = org_id;
+            }
             if (limit !== undefined) {
                 localVarQueryParameter['limit'] = limit;
             }
@@ -554,14 +566,17 @@ export const ProjectsApiFp = function (configuration) {
          * @param {number} [filter_id] If supplied, only projects matching the specified filter are returned
          * @param {string} [status] If supplied, includes only projects with the specified statuses. Possible values are `open`, `completed`, `canceled` and `deleted`. By default `deleted` projects are not returned.
          * @param {number} [phase_id] If supplied, only projects in the specified phase are returned
+         * @param {number} [deal_id] If supplied, only projects associated with the specified deal are returned
+         * @param {number} [person_id] If supplied, only projects associated with the specified person are returned
+         * @param {number} [org_id] If supplied, only projects associated with the specified organization are returned
          * @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}
          */
-        getProjects(filter_id, status, phase_id, limit, cursor) {
+        getProjects(filter_id, status, phase_id, deal_id, person_id, org_id, limit, cursor) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getProjects(filter_id, status, phase_id, limit, cursor);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getProjects(filter_id, status, phase_id, deal_id, person_id, org_id, limit, cursor);
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
@@ -685,7 +700,7 @@ export const ProjectsApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         getProjects(requestParameters = {}) {
-            return localVarFp.getProjects(requestParameters.filter_id, requestParameters.status, requestParameters.phase_id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
+            return localVarFp.getProjects(requestParameters.filter_id, requestParameters.status, requestParameters.phase_id, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
         },
         /**
          * Searches all projects by title, description, 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 projects can be filtered by person ID or organization ID.
@@ -802,7 +817,7 @@ export class ProjectsApi extends BaseAPI {
      * @memberof ProjectsApi
      */
     getProjects(requestParameters = {}) {
-        return ProjectsApiFp(this.configuration).getProjects(requestParameters.filter_id, requestParameters.status, requestParameters.phase_id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
+        return ProjectsApiFp(this.configuration).getProjects(requestParameters.filter_id, requestParameters.status, requestParameters.phase_id, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Searches all projects by title, description, 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 projects can be filtered by person ID or organization ID.

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

@@ -62,6 +62,31 @@ export interface OrganizationItem {
     */
     'label_ids'?: Array<number>;
     /**
+    * The website of the organization
+    * @type {string}
+    */
+    'website'?: string | null;
+    /**
+    * The LinkedIn profile URL of the organization
+    * @type {string}
+    */
+    'linkedin'?: string | null;
+    /**
+    * The industry the organization belongs to
+    * @type {number}
+    */
+    'industry'?: number | null;
+    /**
+    * The annual revenue of the organization
+    * @type {number}
+    */
+    'annual_revenue'?: number | null;
+    /**
+    * The number of employees in the organization
+    * @type {number}
+    */
+    'employee_count'?: number | null;
+    /**
     * An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes. To clear a custom field value, set it to `null`. For multi-option fields (field type `set`), use `null` to clear the selection — sending an empty array `[]` is not supported and will result in a validation error.
     * @type {{ [key: string]: any | undefined; }}
     */

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

@@ -268,7 +268,7 @@ const DealProductsApiAxiosParamCreator = function (configuration) {
             // oauth required
             yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["products:read", "products:full", "deals:read", "deals:full"], configuration);
             if (deal_ids) {
-                localVarQueryParameter['deal_ids'] = deal_ids;
+                localVarQueryParameter['deal_ids'] = deal_ids.join(base_1.COLLECTION_FORMATS.csv);
             }
             if (cursor !== undefined) {
                 localVarQueryParameter['cursor'] = cursor;

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

@@ -93,12 +93,15 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
      * @param {number} [filter_id] If supplied, only projects matching the specified filter are returned
      * @param {string} [status] If supplied, includes only projects with the specified statuses. Possible values are `open`, `completed`, `canceled` and `deleted`. By default `deleted` projects are not returned.
      * @param {number} [phase_id] If supplied, only projects in the specified phase are returned
+     * @param {number} [deal_id] If supplied, only projects associated with the specified deal are returned
+     * @param {number} [person_id] If supplied, only projects associated with the specified person are returned
+     * @param {number} [org_id] If supplied, only projects associated with the specified organization are returned
      * @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}
      */
-    getProjects: (filter_id?: number, status?: string, phase_id?: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
+    getProjects: (filter_id?: number, status?: string, phase_id?: number, deal_id?: number, person_id?: number, org_id?: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
     /**
      * Searches all projects by title, description, 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 projects can be filtered by person ID or organization ID.
      * @summary Search projects
@@ -196,12 +199,15 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
      * @param {number} [filter_id] If supplied, only projects matching the specified filter are returned
      * @param {string} [status] If supplied, includes only projects with the specified statuses. Possible values are &#x60;open&#x60;, &#x60;completed&#x60;, &#x60;canceled&#x60; and &#x60;deleted&#x60;. By default &#x60;deleted&#x60; projects are not returned.
      * @param {number} [phase_id] If supplied, only projects in the specified phase are returned
+     * @param {number} [deal_id] If supplied, only projects associated with the specified deal are returned
+     * @param {number} [person_id] If supplied, only projects associated with the specified person are returned
+     * @param {number} [org_id] If supplied, only projects associated with the specified organization are returned
      * @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}
      */
-    getProjects(filter_id?: number, status?: string, phase_id?: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProjectsResponse>>;
+    getProjects(filter_id?: number, status?: string, phase_id?: number, deal_id?: number, person_id?: number, org_id?: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProjectsResponse>>;
     /**
      * Searches all projects by title, description, 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 projects can be filtered by person ID or organization ID.
      * @summary Search projects
@@ -463,6 +469,24 @@ export interface ProjectsApiGetProjectsRequest {
      * @memberof ProjectsApiGetProjects
      */
     readonly phase_id?: number;
+    /**
+     * If supplied, only projects associated with the specified deal are returned
+     * @type {number}
+     * @memberof ProjectsApiGetProjects
+     */
+    readonly deal_id?: number;
+    /**
+     * If supplied, only projects associated with the specified person are returned
+     * @type {number}
+     * @memberof ProjectsApiGetProjects
+     */
+    readonly person_id?: number;
+    /**
+     * If supplied, only projects associated with the specified organization are returned
+     * @type {number}
+     * @memberof ProjectsApiGetProjects
+     */
+    readonly org_id?: number;
     /**
      * For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
      * @type {number}

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

@@ -307,12 +307,15 @@ const ProjectsApiAxiosParamCreator = function (configuration) {
          * @param {number} [filter_id] If supplied, only projects matching the specified filter are returned
          * @param {string} [status] If supplied, includes only projects with the specified statuses. Possible values are `open`, `completed`, `canceled` and `deleted`. By default `deleted` projects are not returned.
          * @param {number} [phase_id] If supplied, only projects in the specified phase are returned
+         * @param {number} [deal_id] If supplied, only projects associated with the specified deal are returned
+         * @param {number} [person_id] If supplied, only projects associated with the specified person are returned
+         * @param {number} [org_id] If supplied, only projects associated with the specified organization are returned
          * @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}
          */
-        getProjects: (filter_id, status, phase_id, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
+        getProjects: (filter_id, status, phase_id, deal_id, person_id, org_id, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
             const localVarPath = `/projects`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -337,6 +340,15 @@ const ProjectsApiAxiosParamCreator = function (configuration) {
             if (phase_id !== undefined) {
                 localVarQueryParameter['phase_id'] = phase_id;
             }
+            if (deal_id !== undefined) {
+                localVarQueryParameter['deal_id'] = deal_id;
+            }
+            if (person_id !== undefined) {
+                localVarQueryParameter['person_id'] = person_id;
+            }
+            if (org_id !== undefined) {
+                localVarQueryParameter['org_id'] = org_id;
+            }
             if (limit !== undefined) {
                 localVarQueryParameter['limit'] = limit;
             }
@@ -561,14 +573,17 @@ const ProjectsApiFp = function (configuration) {
          * @param {number} [filter_id] If supplied, only projects matching the specified filter are returned
          * @param {string} [status] If supplied, includes only projects with the specified statuses. Possible values are `open`, `completed`, `canceled` and `deleted`. By default `deleted` projects are not returned.
          * @param {number} [phase_id] If supplied, only projects in the specified phase are returned
+         * @param {number} [deal_id] If supplied, only projects associated with the specified deal are returned
+         * @param {number} [person_id] If supplied, only projects associated with the specified person are returned
+         * @param {number} [org_id] If supplied, only projects associated with the specified organization are returned
          * @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}
          */
-        getProjects(filter_id, status, phase_id, limit, cursor) {
+        getProjects(filter_id, status, phase_id, deal_id, person_id, org_id, limit, cursor) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getProjects(filter_id, status, phase_id, limit, cursor);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getProjects(filter_id, status, phase_id, deal_id, person_id, org_id, limit, cursor);
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
@@ -693,7 +708,7 @@ const ProjectsApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         getProjects(requestParameters = {}) {
-            return localVarFp.getProjects(requestParameters.filter_id, requestParameters.status, requestParameters.phase_id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
+            return localVarFp.getProjects(requestParameters.filter_id, requestParameters.status, requestParameters.phase_id, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
         },
         /**
          * Searches all projects by title, description, 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 projects can be filtered by person ID or organization ID.
@@ -811,7 +826,7 @@ class ProjectsApi extends base_1.BaseAPI {
      * @memberof ProjectsApi
      */
     getProjects(requestParameters = {}) {
-        return (0, exports.ProjectsApiFp)(this.configuration).getProjects(requestParameters.filter_id, requestParameters.status, requestParameters.phase_id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
+        return (0, exports.ProjectsApiFp)(this.configuration).getProjects(requestParameters.filter_id, requestParameters.status, requestParameters.phase_id, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Searches all projects by title, description, 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 projects can be filtered by person ID or organization ID.

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

@@ -62,6 +62,31 @@ export interface OrganizationItem {
     */
     'label_ids'?: Array<number>;
     /**
+    * The website of the organization
+    * @type {string}
+    */
+    'website'?: string | null;
+    /**
+    * The LinkedIn profile URL of the organization
+    * @type {string}
+    */
+    'linkedin'?: string | null;
+    /**
+    * The industry the organization belongs to
+    * @type {number}
+    */
+    'industry'?: number | null;
+    /**
+    * The annual revenue of the organization
+    * @type {number}
+    */
+    'annual_revenue'?: number | null;
+    /**
+    * The number of employees in the organization
+    * @type {number}
+    */
+    'employee_count'?: number | null;
+    /**
     * An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes. To clear a custom field value, set it to `null`. For multi-option fields (field type `set`), use `null` to clear the selection — sending an empty array `[]` is not supported and will result in a validation error.
     * @type {{ [key: string]: any | undefined; }}
     */

package/package.json

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