pipedrive 24.0.0 → 24.1.0

package/README.md

@@ -261,4 +261,4 @@ app.get('/callback', async (req, res) => {
     }
 });
 
-```
+```

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

@@ -294,11 +294,12 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.
      * @param {number} [filter_id] <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
      * @param {number} [user_id] Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.
+     * @param {number} [pipeline_id] Only deals within the given pipeline will be returned
      * @param {number} [stage_id] Only deals within the given stage will be returned
 
      * @throws {RequiredError}
      */
-    getDealsSummary: (status?: 'open' | 'won' | 'lost', filter_id?: number, user_id?: number, stage_id?: number) => Promise<RequestArgs>;
+    getDealsSummary: (status?: 'open' | 'won' | 'lost', filter_id?: number, user_id?: number, pipeline_id?: number, stage_id?: number) => Promise<RequestArgs>;
     /**
      * Returns open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
      * @summary Get deals timeline
@@ -606,11 +607,12 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost.
      * @param {number} [filter_id] &lt;code&gt;user_id&lt;/code&gt; will not be considered. Only deals matching the given filter will be returned.
      * @param {number} [user_id] Only deals matching the given user will be returned. &#x60;user_id&#x60; will not be considered if you use &#x60;filter_id&#x60;.
+     * @param {number} [pipeline_id] Only deals within the given pipeline will be returned
      * @param {number} [stage_id] Only deals within the given stage will be returned
 
      * @throws {RequiredError}
      */
-    getDealsSummary(status?: 'open' | 'won' | 'lost', filter_id?: number, user_id?: number, stage_id?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsSummaryResponse>>;
+    getDealsSummary(status?: 'open' | 'won' | 'lost', filter_id?: number, user_id?: number, pipeline_id?: number, stage_id?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsSummaryResponse>>;
     /**
      * Returns open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
      * @summary Get deals timeline
@@ -1512,6 +1514,12 @@ export interface DealsApiGetDealsSummaryRequest {
      * @memberof DealsApiGetDealsSummary
      */
     readonly user_id?: number;
+    /**
+     * Only deals within the given pipeline will be returned
+     * @type {number}
+     * @memberof DealsApiGetDealsSummary
+     */
+    readonly pipeline_id?: number;
     /**
      * Only deals within the given stage will be returned
      * @type {number}

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

@@ -1024,11 +1024,12 @@ export const DealsApiAxiosParamCreator = function (configuration) {
          * @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.
          * @param {number} [filter_id] <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
          * @param {number} [user_id] Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.
+         * @param {number} [pipeline_id] Only deals within the given pipeline will be returned
          * @param {number} [stage_id] Only deals within the given stage will be returned
 
          * @throws {RequiredError}
          */
-        getDealsSummary: (status, filter_id, user_id, stage_id) => __awaiter(this, void 0, void 0, function* () {
+        getDealsSummary: (status, filter_id, user_id, pipeline_id, stage_id) => __awaiter(this, void 0, void 0, function* () {
             const localVarPath = `/deals/summary`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -1053,6 +1054,9 @@ export const DealsApiAxiosParamCreator = function (configuration) {
             if (user_id !== undefined) {
                 localVarQueryParameter['user_id'] = user_id;
             }
+            if (pipeline_id !== undefined) {
+                localVarQueryParameter['pipeline_id'] = pipeline_id;
+            }
             if (stage_id !== undefined) {
                 localVarQueryParameter['stage_id'] = stage_id;
             }
@@ -1693,13 +1697,14 @@ export const DealsApiFp = function (configuration) {
          * @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.
          * @param {number} [filter_id] <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
          * @param {number} [user_id] Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.
+         * @param {number} [pipeline_id] Only deals within the given pipeline will be returned
          * @param {number} [stage_id] Only deals within the given stage will be returned
 
          * @throws {RequiredError}
          */
-        getDealsSummary(status, filter_id, user_id, stage_id) {
+        getDealsSummary(status, filter_id, user_id, pipeline_id, stage_id) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealsSummary(status, filter_id, user_id, stage_id);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealsSummary(status, filter_id, user_id, pipeline_id, stage_id);
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
@@ -2045,7 +2050,7 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         getDealsSummary(requestParameters = {}) {
-            return localVarFp.getDealsSummary(requestParameters.status, requestParameters.filter_id, requestParameters.user_id, requestParameters.stage_id).then((request) => request(axios, basePath));
+            return localVarFp.getDealsSummary(requestParameters.status, requestParameters.filter_id, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.stage_id).then((request) => request(axios, basePath));
         },
         /**
          * Returns open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
@@ -2379,7 +2384,7 @@ export class DealsApi extends BaseAPI {
      * @memberof DealsApi
      */
     getDealsSummary(requestParameters = {}) {
-        return DealsApiFp(this.configuration).getDealsSummary(requestParameters.status, requestParameters.filter_id, requestParameters.user_id, requestParameters.stage_id).then((request) => request(this.axios, this.basePath));
+        return DealsApiFp(this.configuration).getDealsSummary(requestParameters.status, requestParameters.filter_id, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.stage_id).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Returns open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.

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

@@ -27,11 +27,15 @@ export interface AddLeadLabelRequest {
     'color': AddLeadLabelRequestColorConst;
 }
 export declare const AddLeadLabelRequestColorConst: {
-    readonly green: "green";
     readonly blue: "blue";
+    readonly brown: "brown";
+    readonly dark_gray: "dark-gray";
+    readonly gray: "gray";
+    readonly green: "green";
+    readonly orange: "orange";
+    readonly pink: "pink";
+    readonly purple: "purple";
     readonly red: "red";
     readonly yellow: "yellow";
-    readonly purple: "purple";
-    readonly gray: "gray";
 };
 export type AddLeadLabelRequestColorConst = typeof AddLeadLabelRequestColorConst[keyof typeof AddLeadLabelRequestColorConst];

package/dist/esm/versions/v1/models/add-lead-label-request.js

@@ -12,10 +12,14 @@
  * Do not edit the class manually.
  */
 export const AddLeadLabelRequestColorConst = {
-    green: 'green',
     blue: 'blue',
-    red: 'red',
-    yellow: 'yellow',
+    brown: 'brown',
+    dark_gray: 'dark-gray',
+    gray: 'gray',
+    green: 'green',
+    orange: 'orange',
+    pink: 'pink',
     purple: 'purple',
-    gray: 'gray'
+    red: 'red',
+    yellow: 'yellow'
 };

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

@@ -42,11 +42,15 @@ export interface LeadLabel {
     'update_time': string;
 }
 export declare const LeadLabelColorConst: {
-    readonly green: "green";
     readonly blue: "blue";
+    readonly brown: "brown";
+    readonly dark_gray: "dark-gray";
+    readonly gray: "gray";
+    readonly green: "green";
+    readonly orange: "orange";
+    readonly pink: "pink";
+    readonly purple: "purple";
     readonly red: "red";
     readonly yellow: "yellow";
-    readonly purple: "purple";
-    readonly gray: "gray";
 };
 export type LeadLabelColorConst = typeof LeadLabelColorConst[keyof typeof LeadLabelColorConst];

package/dist/esm/versions/v1/models/lead-label.js

@@ -12,10 +12,14 @@
  * Do not edit the class manually.
  */
 export const LeadLabelColorConst = {
-    green: 'green',
     blue: 'blue',
-    red: 'red',
-    yellow: 'yellow',
+    brown: 'brown',
+    dark_gray: 'dark-gray',
+    gray: 'gray',
+    green: 'green',
+    orange: 'orange',
+    pink: 'pink',
     purple: 'purple',
-    gray: 'gray'
+    red: 'red',
+    yellow: 'yellow'
 };

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

@@ -27,11 +27,15 @@ export interface UpdateLeadLabelRequest {
     'color'?: UpdateLeadLabelRequestColorConst;
 }
 export declare const UpdateLeadLabelRequestColorConst: {
-    readonly green: "green";
     readonly blue: "blue";
+    readonly brown: "brown";
+    readonly dark_gray: "dark-gray";
+    readonly gray: "gray";
+    readonly green: "green";
+    readonly orange: "orange";
+    readonly pink: "pink";
+    readonly purple: "purple";
     readonly red: "red";
     readonly yellow: "yellow";
-    readonly purple: "purple";
-    readonly gray: "gray";
 };
 export type UpdateLeadLabelRequestColorConst = typeof UpdateLeadLabelRequestColorConst[keyof typeof UpdateLeadLabelRequestColorConst];

package/dist/esm/versions/v1/models/update-lead-label-request.js

@@ -12,10 +12,14 @@
  * Do not edit the class manually.
  */
 export const UpdateLeadLabelRequestColorConst = {
-    green: 'green',
     blue: 'blue',
-    red: 'red',
-    yellow: 'yellow',
+    brown: 'brown',
+    dark_gray: 'dark-gray',
+    gray: 'gray',
+    green: 'green',
+    orange: 'orange',
+    pink: 'pink',
     purple: 'purple',
-    gray: 'gray'
+    red: 'red',
+    yellow: 'yellow'
 };

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

@@ -294,11 +294,12 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.
      * @param {number} [filter_id] <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
      * @param {number} [user_id] Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.
+     * @param {number} [pipeline_id] Only deals within the given pipeline will be returned
      * @param {number} [stage_id] Only deals within the given stage will be returned
 
      * @throws {RequiredError}
      */
-    getDealsSummary: (status?: 'open' | 'won' | 'lost', filter_id?: number, user_id?: number, stage_id?: number) => Promise<RequestArgs>;
+    getDealsSummary: (status?: 'open' | 'won' | 'lost', filter_id?: number, user_id?: number, pipeline_id?: number, stage_id?: number) => Promise<RequestArgs>;
     /**
      * Returns open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
      * @summary Get deals timeline
@@ -606,11 +607,12 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost.
      * @param {number} [filter_id] &lt;code&gt;user_id&lt;/code&gt; will not be considered. Only deals matching the given filter will be returned.
      * @param {number} [user_id] Only deals matching the given user will be returned. &#x60;user_id&#x60; will not be considered if you use &#x60;filter_id&#x60;.
+     * @param {number} [pipeline_id] Only deals within the given pipeline will be returned
      * @param {number} [stage_id] Only deals within the given stage will be returned
 
      * @throws {RequiredError}
      */
-    getDealsSummary(status?: 'open' | 'won' | 'lost', filter_id?: number, user_id?: number, stage_id?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsSummaryResponse>>;
+    getDealsSummary(status?: 'open' | 'won' | 'lost', filter_id?: number, user_id?: number, pipeline_id?: number, stage_id?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsSummaryResponse>>;
     /**
      * Returns open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
      * @summary Get deals timeline
@@ -1512,6 +1514,12 @@ export interface DealsApiGetDealsSummaryRequest {
      * @memberof DealsApiGetDealsSummary
      */
     readonly user_id?: number;
+    /**
+     * Only deals within the given pipeline will be returned
+     * @type {number}
+     * @memberof DealsApiGetDealsSummary
+     */
+    readonly pipeline_id?: number;
     /**
      * Only deals within the given stage will be returned
      * @type {number}

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

@@ -1030,11 +1030,12 @@ const DealsApiAxiosParamCreator = function (configuration) {
          * @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.
          * @param {number} [filter_id] <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
          * @param {number} [user_id] Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.
+         * @param {number} [pipeline_id] Only deals within the given pipeline will be returned
          * @param {number} [stage_id] Only deals within the given stage will be returned
 
          * @throws {RequiredError}
          */
-        getDealsSummary: (status, filter_id, user_id, stage_id) => __awaiter(this, void 0, void 0, function* () {
+        getDealsSummary: (status, filter_id, user_id, pipeline_id, stage_id) => __awaiter(this, void 0, void 0, function* () {
             const localVarPath = `/deals/summary`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -1059,6 +1060,9 @@ const DealsApiAxiosParamCreator = function (configuration) {
             if (user_id !== undefined) {
                 localVarQueryParameter['user_id'] = user_id;
             }
+            if (pipeline_id !== undefined) {
+                localVarQueryParameter['pipeline_id'] = pipeline_id;
+            }
             if (stage_id !== undefined) {
                 localVarQueryParameter['stage_id'] = stage_id;
             }
@@ -1700,13 +1704,14 @@ const DealsApiFp = function (configuration) {
          * @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.
          * @param {number} [filter_id] <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
          * @param {number} [user_id] Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.
+         * @param {number} [pipeline_id] Only deals within the given pipeline will be returned
          * @param {number} [stage_id] Only deals within the given stage will be returned
 
          * @throws {RequiredError}
          */
-        getDealsSummary(status, filter_id, user_id, stage_id) {
+        getDealsSummary(status, filter_id, user_id, pipeline_id, stage_id) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealsSummary(status, filter_id, user_id, stage_id);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealsSummary(status, filter_id, user_id, pipeline_id, stage_id);
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
@@ -2053,7 +2058,7 @@ const DealsApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         getDealsSummary(requestParameters = {}) {
-            return localVarFp.getDealsSummary(requestParameters.status, requestParameters.filter_id, requestParameters.user_id, requestParameters.stage_id).then((request) => request(axios, basePath));
+            return localVarFp.getDealsSummary(requestParameters.status, requestParameters.filter_id, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.stage_id).then((request) => request(axios, basePath));
         },
         /**
          * Returns open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
@@ -2388,7 +2393,7 @@ class DealsApi extends base_1.BaseAPI {
      * @memberof DealsApi
      */
     getDealsSummary(requestParameters = {}) {
-        return (0, exports.DealsApiFp)(this.configuration).getDealsSummary(requestParameters.status, requestParameters.filter_id, requestParameters.user_id, requestParameters.stage_id).then((request) => request(this.axios, this.basePath));
+        return (0, exports.DealsApiFp)(this.configuration).getDealsSummary(requestParameters.status, requestParameters.filter_id, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.stage_id).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Returns open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.

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

@@ -27,11 +27,15 @@ export interface AddLeadLabelRequest {
     'color': AddLeadLabelRequestColorConst;
 }
 export declare const AddLeadLabelRequestColorConst: {
-    readonly green: "green";
     readonly blue: "blue";
+    readonly brown: "brown";
+    readonly dark_gray: "dark-gray";
+    readonly gray: "gray";
+    readonly green: "green";
+    readonly orange: "orange";
+    readonly pink: "pink";
+    readonly purple: "purple";
     readonly red: "red";
     readonly yellow: "yellow";
-    readonly purple: "purple";
-    readonly gray: "gray";
 };
 export type AddLeadLabelRequestColorConst = typeof AddLeadLabelRequestColorConst[keyof typeof AddLeadLabelRequestColorConst];

package/dist/versions/v1/models/add-lead-label-request.js

@@ -15,10 +15,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AddLeadLabelRequestColorConst = void 0;
 exports.AddLeadLabelRequestColorConst = {
-    green: 'green',
     blue: 'blue',
-    red: 'red',
-    yellow: 'yellow',
+    brown: 'brown',
+    dark_gray: 'dark-gray',
+    gray: 'gray',
+    green: 'green',
+    orange: 'orange',
+    pink: 'pink',
     purple: 'purple',
-    gray: 'gray'
+    red: 'red',
+    yellow: 'yellow'
 };

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

@@ -42,11 +42,15 @@ export interface LeadLabel {
     'update_time': string;
 }
 export declare const LeadLabelColorConst: {
-    readonly green: "green";
     readonly blue: "blue";
+    readonly brown: "brown";
+    readonly dark_gray: "dark-gray";
+    readonly gray: "gray";
+    readonly green: "green";
+    readonly orange: "orange";
+    readonly pink: "pink";
+    readonly purple: "purple";
     readonly red: "red";
     readonly yellow: "yellow";
-    readonly purple: "purple";
-    readonly gray: "gray";
 };
 export type LeadLabelColorConst = typeof LeadLabelColorConst[keyof typeof LeadLabelColorConst];

package/dist/versions/v1/models/lead-label.js

@@ -15,10 +15,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LeadLabelColorConst = void 0;
 exports.LeadLabelColorConst = {
-    green: 'green',
     blue: 'blue',
-    red: 'red',
-    yellow: 'yellow',
+    brown: 'brown',
+    dark_gray: 'dark-gray',
+    gray: 'gray',
+    green: 'green',
+    orange: 'orange',
+    pink: 'pink',
     purple: 'purple',
-    gray: 'gray'
+    red: 'red',
+    yellow: 'yellow'
 };

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

@@ -27,11 +27,15 @@ export interface UpdateLeadLabelRequest {
     'color'?: UpdateLeadLabelRequestColorConst;
 }
 export declare const UpdateLeadLabelRequestColorConst: {
-    readonly green: "green";
     readonly blue: "blue";
+    readonly brown: "brown";
+    readonly dark_gray: "dark-gray";
+    readonly gray: "gray";
+    readonly green: "green";
+    readonly orange: "orange";
+    readonly pink: "pink";
+    readonly purple: "purple";
     readonly red: "red";
     readonly yellow: "yellow";
-    readonly purple: "purple";
-    readonly gray: "gray";
 };
 export type UpdateLeadLabelRequestColorConst = typeof UpdateLeadLabelRequestColorConst[keyof typeof UpdateLeadLabelRequestColorConst];

package/dist/versions/v1/models/update-lead-label-request.js

@@ -15,10 +15,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UpdateLeadLabelRequestColorConst = void 0;
 exports.UpdateLeadLabelRequestColorConst = {
-    green: 'green',
     blue: 'blue',
-    red: 'red',
-    yellow: 'yellow',
+    brown: 'brown',
+    dark_gray: 'dark-gray',
+    gray: 'gray',
+    green: 'green',
+    orange: 'orange',
+    pink: 'pink',
     purple: 'purple',
-    gray: 'gray'
+    red: 'red',
+    yellow: 'yellow'
 };

package/package.json

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