diff --git a/CHANGELOG.md b/CHANGELOG.md index 669fd2d0..fc4bfab3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,10 @@ The file format of it is based on [Keep a Changelog](http://keepachangelog.com/e For public Changelog covering all changes done to Pipedrive’s API, webhooks and app extensions platforms, see [public Changelog](https://pipedrive.readme.io/docs/changelog) with discussion area in [Developers Community](https://devcommunity.pipedrive.com/c/documentation/changelog/19). ## [Unreleased] +### 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 diff --git a/src/versions/v1/api/pipelines-api.ts b/src/versions/v1/api/pipelines-api.ts index 46b62051..116dafed 100644 --- a/src/versions/v1/api/pipelines-api.ts +++ b/src/versions/v1/api/pipelines-api.ts @@ -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 => { + getPipeline: async (id: number, ): Promise => { // 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, `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} */ - async getPipeline(id: number, totals_convert_currency?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPipeline(id, totals_convert_currency, ); + async getPipeline(id: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + 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 { - 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, `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. - * @type {string} - * @memberof PipelinesApiGetPipeline - */ - readonly totals_convert_currency?: string } /** @@ -914,7 +901,7 @@ 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 @@ -922,7 +909,7 @@ export class PipelinesApi extends BaseAPI { * @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)); } /** diff --git a/src/versions/v1/api/stages-api.ts b/src/versions/v1/api/stages-api.ts index 476099fd..34bc7d2e 100644 --- a/src/versions/v1/api/stages-api.ts +++ b/src/versions/v1/api/stages-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 => { + getStage: async (id: number, ): Promise => { // 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 `everyone=1` 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> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getStage(id, everyone, ); + async getStage(id: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + 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 { - 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.
This endpoint has been deprecated. Please use GET /api/v2/deals?stage_id={id} instead. @@ -612,13 +606,6 @@ export interface StagesApiGetStageRequest { * @memberof StagesApiGetStage */ readonly id: number - - /** - * If `everyone=1` 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)); } /** diff --git a/src/versions/v1/models/get-stage-response-data.ts b/src/versions/v1/models/get-stage-response-data.ts index d7273faa..6c67e285 100644 --- a/src/versions/v1/models/get-stage-response-data.ts +++ b/src/versions/v1/models/get-stage-response-data.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; diff --git a/src/versions/v1/models/index.ts b/src/versions/v1/models/index.ts index 3b70ea64..541c73c5 100644 --- a/src/versions/v1/models/index.ts +++ b/src/versions/v1/models/index.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'; diff --git a/src/versions/v1/models/pipeline-details.ts b/src/versions/v1/models/pipeline-details.ts index 1f0754d3..9a38be06 100644 --- a/src/versions/v1/models/pipeline-details.ts +++ b/src/versions/v1/models/pipeline-details.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;