Release v28.0.0 from PR #649

Author: github-actions[bot]

CHANGELOG.md

@@ -8,6 +8,12 @@ For public Changelog covering all changes done to Pipedrive’s API, webhooks an
 
 ## [Unreleased]
 
+## [28.0.0] - 2025-06-16
+### Removed
+- Removed `deals_summary` from `GET /v1/stages/:id` and `GET /v1/pipelines/:id`
+- Removed `totals_convert_currency` query parameter from `GET /v1/pipelines/:id`
+- Removed `everyone` query parameter from `GET /v1/stages/:id`
+
 ## [27.2.1] - 2025-06-09
 ### Added
 - Documented `address` property in the Organization v2 API for add and update endpoints:
@@ -900,7 +906,8 @@ Those fields will be formatted as "2020-07-13" instead of "2020-07-13T00:00:00.0
 * Fixed `GET /goal/:id/results` error handling in case when there are no existing stages connected to specified goal
 * Fixed typo in lead example response (`crrency` to `currency`)
 
-[Unreleased]: https://github.com/pipedrive/api-docs/compare/v27.2.1...HEAD
+[Unreleased]: https://github.com/pipedrive/api-docs/compare/v28.0.0...HEAD
+[28.0.0]: https://github.com/pipedrive/api-docs/compare/v27.2.1...v28.0.0
 [27.2.1]: https://github.com/pipedrive/api-docs/compare/v27.2.0...v27.2.1
 [27.2.0]: https://github.com/pipedrive/api-docs/compare/v27.1.1...v27.2.0
 [27.1.1]: https://github.com/pipedrive/api-docs/compare/v27.1.0...v27.1.1

package-lock.json

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

package.json

@@ -130,14 +130,13 @@ export const PipelinesApiAxiosParamCreator = function (configuration?: Configura
             };
         },
         /**
-         * Returns data about a specific pipeline. Also returns the summary of the deals in this pipeline across its stages.
+         * Returns data about a specific pipeline.
          * @summary Get one pipeline
          * @param {number} id The ID of the pipeline
-         * @param {string} [totals_convert_currency] The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned in `deals_summary` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used.
          * @deprecated
          * @throws {RequiredError}
          */
-        getPipeline: async (id: number, totals_convert_currency?: string, ): Promise<RequestArgs> => {
+        getPipeline: async (id: number, ): Promise<RequestArgs> => {
             // verify required parameter 'id' is not null or undefined
             assertParamExists('getPipeline', 'id', id)
             const localVarPath = `/pipelines/{id}`
@@ -160,10 +159,6 @@ export const PipelinesApiAxiosParamCreator = function (configuration?: Configura
             // oauth required
             await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full", "admin"], configuration)
 
-            if (totals_convert_currency !== undefined) {
-                localVarQueryParameter['totals_convert_currency'] = totals_convert_currency;
-            }
-
 
 
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -500,15 +495,14 @@ export const PipelinesApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * Returns data about a specific pipeline. Also returns the summary of the deals in this pipeline across its stages.
+         * Returns data about a specific pipeline.
          * @summary Get one pipeline
          * @param {number} id The ID of the pipeline
-         * @param {string} [totals_convert_currency] The 3-letter currency code of any of the supported currencies. When supplied, &#x60;per_stages_converted&#x60; is returned in &#x60;deals_summary&#x60; which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to &#x60;default_currency&#x60; in which case users default currency is used.
          * @deprecated
          * @throws {RequiredError}
          */
-        async getPipeline(id: number, totals_convert_currency?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPipelineResponse>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getPipeline(id, totals_convert_currency, );
+        async getPipeline(id: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPipelineResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getPipeline(id, );
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
@@ -611,14 +605,14 @@ export const PipelinesApiFactory = function (configuration?: Configuration, base
             return localVarFp.deletePipeline(requestParameters.id, ).then((request) => request(axios, basePath));
         },
         /**
-         * Returns data about a specific pipeline. Also returns the summary of the deals in this pipeline across its stages.
+         * Returns data about a specific pipeline.
          * @summary Get one pipeline
          * @param {PipelinesApiGetPipelineRequest} requestParameters Request parameters.
          * @deprecated
          * @throws {RequiredError}
          */
         getPipeline(requestParameters: PipelinesApiGetPipelineRequest, ): Promise<GetPipelineResponse> {
-            return localVarFp.getPipeline(requestParameters.id, requestParameters.totals_convert_currency, ).then((request) => request(axios, basePath));
+            return localVarFp.getPipeline(requestParameters.id, ).then((request) => request(axios, basePath));
         },
         /**
          * Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period.
@@ -712,13 +706,6 @@ export interface PipelinesApiGetPipelineRequest {
      * @memberof PipelinesApiGetPipeline
      */
     readonly id: number
-
-    /**
-     * The 3-letter currency code of any of the supported currencies. When supplied, &#x60;per_stages_converted&#x60; is returned in &#x60;deals_summary&#x60; which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to &#x60;default_currency&#x60; in which case users default currency is used.
-     * @type {string}
-     * @memberof PipelinesApiGetPipeline
-     */
-    readonly totals_convert_currency?: string
 }
 
 /**
@@ -914,15 +901,15 @@ export class PipelinesApi extends BaseAPI {
     }
 
     /**
-     * Returns data about a specific pipeline. Also returns the summary of the deals in this pipeline across its stages.
+     * Returns data about a specific pipeline.
      * @summary Get one pipeline
      * @param {PipelinesApiGetPipelineRequest} requestParameters Request parameters.
      * @deprecated
      * @throws {RequiredError}
      * @memberof PipelinesApi
      */
     public getPipeline(requestParameters: PipelinesApiGetPipelineRequest, ) {
-        return PipelinesApiFp(this.configuration).getPipeline(requestParameters.id, requestParameters.totals_convert_currency, ).then((request) => request(this.axios, this.basePath));
+        return PipelinesApiFp(this.configuration).getPipeline(requestParameters.id, ).then((request) => request(this.axios, this.basePath));
     }
 
     /**

src/versions/v1/api/pipelines-api.ts

@@ -173,11 +173,10 @@ export const StagesApiAxiosParamCreator = function (configuration?: Configuratio
          * Returns data about a specific stage.
          * @summary Get one stage
          * @param {number} id The ID of the stage
-         * @param {0 | 1} [everyone] If `everyone=1` is provided, deals summary will return deals owned by every user
          * @deprecated
          * @throws {RequiredError}
          */
-        getStage: async (id: number, everyone?: 0 | 1, ): Promise<RequestArgs> => {
+        getStage: async (id: number, ): Promise<RequestArgs> => {
             // verify required parameter 'id' is not null or undefined
             assertParamExists('getStage', 'id', id)
             const localVarPath = `/stages/{id}`
@@ -200,10 +199,6 @@ export const StagesApiAxiosParamCreator = function (configuration?: Configuratio
             // oauth required
             await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full", "admin"], configuration)
 
-            if (everyone !== undefined) {
-                localVarQueryParameter['everyone'] = everyone;
-            }
-
 
 
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -426,12 +421,11 @@ export const StagesApiFp = function(configuration?: Configuration) {
          * Returns data about a specific stage.
          * @summary Get one stage
          * @param {number} id The ID of the stage
-         * @param {0 | 1} [everyone] If &#x60;everyone&#x3D;1&#x60; is provided, deals summary will return deals owned by every user
          * @deprecated
          * @throws {RequiredError}
          */
-        async getStage(id: number, everyone?: 0 | 1, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetStageResponse>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getStage(id, everyone, );
+        async getStage(id: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetStageResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getStage(id, );
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
@@ -523,7 +517,7 @@ export const StagesApiFactory = function (configuration?: Configuration, basePat
          * @throws {RequiredError}
          */
         getStage(requestParameters: StagesApiGetStageRequest, ): Promise<GetStageResponse> {
-            return localVarFp.getStage(requestParameters.id, requestParameters.everyone, ).then((request) => request(axios, basePath));
+            return localVarFp.getStage(requestParameters.id, ).then((request) => request(axios, basePath));
         },
         /**
          * Lists deals in a specific stage. If no parameters are provided open deals owned by the authorized user will be returned. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeals\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/deals?stage_id={id}</a> instead.
@@ -612,13 +606,6 @@ export interface StagesApiGetStageRequest {
      * @memberof StagesApiGetStage
      */
     readonly id: number
-
-    /**
-     * If &#x60;everyone&#x3D;1&#x60; is provided, deals summary will return deals owned by every user
-     * @type {0 | 1}
-     * @memberof StagesApiGetStage
-     */
-    readonly everyone?: 0 | 1
 }
 
 /**
@@ -771,7 +758,7 @@ export class StagesApi extends BaseAPI {
      * @memberof StagesApi
      */
     public getStage(requestParameters: StagesApiGetStageRequest, ) {
-        return StagesApiFp(this.configuration).getStage(requestParameters.id, requestParameters.everyone, ).then((request) => request(this.axios, this.basePath));
+        return StagesApiFp(this.configuration).getStage(requestParameters.id, ).then((request) => request(this.axios, this.basePath));
     }
 
     /**

src/versions/v1/api/stages-api.ts

@@ -16,18 +16,12 @@
 // May contain unused imports in some cases
 // @ts-ignore
 import { BaseStage } from './base-stage';
-// May contain unused imports in some cases
-// @ts-ignore
-import { PipelineDetailsAllOfDealsSummary } from './pipeline-details-all-of-deals-summary';
-// May contain unused imports in some cases
-// @ts-ignore
-import { StageDetailsData } from './stage-details-data';
 
 /**
  * @type GetStageResponseData
  * The stage object
  * @export
  */
-export type GetStageResponseData = BaseStage & StageDetailsData;
+export type GetStageResponseData = BaseStage;
 
 

src/versions/v1/models/get-stage-response-data.ts

@@ -672,14 +672,6 @@ export * from './picture-data-pictures';
 export * from './picture-data-with-id';
 export * from './picture-data-with-value';
 export * from './pipeline-details';
-export * from './pipeline-details-all-of';
-export * from './pipeline-details-all-of-deals-summary';
-export * from './pipeline-details-all-of-deals-summary-per-currency';
-export * from './pipeline-details-all-of-deals-summary-per-currency-full';
-export * from './pipeline-details-all-of-deals-summary-per-currency-full-currencyid';
-export * from './pipeline-details-all-of-deals-summary-per-stages';
-export * from './pipeline-details-all-of-deals-summary-per-stages-stageid';
-export * from './pipeline-details-all-of-deals-summary-per-stages-stageidcurrencyid';
 export * from './pipeline-request';
 export * from './pipeline-request1';
 export * from './product-field';
@@ -737,7 +729,6 @@ export * from './role-assignment-data';
 export * from './role-settings';
 export * from './search-item';
 export * from './stage';
-export * from './stage-details-data';
 export * from './stage-with-pipeline-info';
 export * from './sub-role';
 export * from './sub-role-all-of';

src/versions/v1/models/index.ts

@@ -16,18 +16,12 @@
 // May contain unused imports in some cases
 // @ts-ignore
 import { BasePipelineWithSelectedFlag } from './base-pipeline-with-selected-flag';
-// May contain unused imports in some cases
-// @ts-ignore
-import { PipelineDetailsAllOf } from './pipeline-details-all-of';
-// May contain unused imports in some cases
-// @ts-ignore
-import { PipelineDetailsAllOfDealsSummary } from './pipeline-details-all-of-deals-summary';
 
 /**
  * @type PipelineDetails
  * The pipeline object
  * @export
  */
-export type PipelineDetails = BasePipelineWithSelectedFlag & PipelineDetailsAllOf;
+export type PipelineDetails = BasePipelineWithSelectedFlag;