Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
31 changes: 9 additions & 22 deletions src/versions/v1/api/pipelines-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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}`
Expand All @@ -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);
Expand Down Expand Up @@ -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);
},
/**
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
}

/**
Expand Down Expand Up @@ -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));
}

/**
Expand Down
23 changes: 5 additions & 18 deletions src/versions/v1/api/stages-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 &#x60;everyone&#x3D;1&#x60; 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}`
Expand All @@ -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);
Expand Down Expand Up @@ -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);
},
/**
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
}

/**
Expand Down Expand Up @@ -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));
}

/**
Expand Down
8 changes: 1 addition & 7 deletions src/versions/v1/models/get-stage-response-data.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;


9 changes: 0 additions & 9 deletions src/versions/v1/models/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down Expand Up @@ -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';
Expand Down
8 changes: 1 addition & 7 deletions src/versions/v1/models/pipeline-details.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;


Loading