pipedrive 27.2.1 → 28.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/esm/versions/v1/api/pipelines-api.d.ts +6 -14
- package/dist/esm/versions/v1/api/pipelines-api.js +9 -14
- package/dist/esm/versions/v1/api/stages-api.d.ts +2 -10
- package/dist/esm/versions/v1/api/stages-api.js +5 -10
- package/dist/esm/versions/v1/models/get-stage-response-data.d.ts +1 -2
- package/dist/esm/versions/v1/models/index.d.ts +0 -9
- package/dist/esm/versions/v1/models/index.js +0 -9
- package/dist/esm/versions/v1/models/pipeline-details.d.ts +1 -2
- package/dist/versions/v1/api/pipelines-api.d.ts +6 -14
- package/dist/versions/v1/api/pipelines-api.js +9 -14
- package/dist/versions/v1/api/stages-api.d.ts +2 -10
- package/dist/versions/v1/api/stages-api.js +5 -10
- package/dist/versions/v1/models/get-stage-response-data.d.ts +1 -2
- package/dist/versions/v1/models/index.d.ts +0 -9
- package/dist/versions/v1/models/index.js +0 -9
- package/dist/versions/v1/models/pipeline-details.d.ts +1 -2
- package/package.json +1 -1
@@ -44,14 +44,13 @@ export declare const PipelinesApiAxiosParamCreator: (configuration?: Configurati
|
|
44
44
|
*/
|
45
45
|
deletePipeline: (id: number) => Promise<RequestArgs>;
|
46
46
|
/**
|
47
|
-
* Returns data about a specific pipeline.
|
47
|
+
* Returns data about a specific pipeline.
|
48
48
|
* @summary Get one pipeline
|
49
49
|
* @param {number} id The ID of the pipeline
|
50
|
-
* @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.
|
51
50
|
* @deprecated
|
52
51
|
* @throws {RequiredError}
|
53
52
|
*/
|
54
|
-
getPipeline: (id: number
|
53
|
+
getPipeline: (id: number) => Promise<RequestArgs>;
|
55
54
|
/**
|
56
55
|
* Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period.
|
57
56
|
* @summary Get deals conversion rates in pipeline
|
@@ -129,14 +128,13 @@ export declare const PipelinesApiFp: (configuration?: Configuration) => {
|
|
129
128
|
*/
|
130
129
|
deletePipeline(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeletePipelineResponse>>;
|
131
130
|
/**
|
132
|
-
* Returns data about a specific pipeline.
|
131
|
+
* Returns data about a specific pipeline.
|
133
132
|
* @summary Get one pipeline
|
134
133
|
* @param {number} id The ID of the pipeline
|
135
|
-
* @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.
|
136
134
|
* @deprecated
|
137
135
|
* @throws {RequiredError}
|
138
136
|
*/
|
139
|
-
getPipeline(id: number
|
137
|
+
getPipeline(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPipelineResponse>>;
|
140
138
|
/**
|
141
139
|
* Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period.
|
142
140
|
* @summary Get deals conversion rates in pipeline
|
@@ -214,7 +212,7 @@ export declare const PipelinesApiFactory: (configuration?: Configuration, basePa
|
|
214
212
|
*/
|
215
213
|
deletePipeline(requestParameters: PipelinesApiDeletePipelineRequest): Promise<DeletePipelineResponse>;
|
216
214
|
/**
|
217
|
-
* Returns data about a specific pipeline.
|
215
|
+
* Returns data about a specific pipeline.
|
218
216
|
* @summary Get one pipeline
|
219
217
|
* @param {PipelinesApiGetPipelineRequest} requestParameters Request parameters.
|
220
218
|
* @deprecated
|
@@ -299,12 +297,6 @@ export interface PipelinesApiGetPipelineRequest {
|
|
299
297
|
* @memberof PipelinesApiGetPipeline
|
300
298
|
*/
|
301
299
|
readonly id: number;
|
302
|
-
/**
|
303
|
-
* 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.
|
304
|
-
* @type {string}
|
305
|
-
* @memberof PipelinesApiGetPipeline
|
306
|
-
*/
|
307
|
-
readonly totals_convert_currency?: string;
|
308
300
|
}
|
309
301
|
/**
|
310
302
|
* Request parameters for getPipelineConversionStatistics operation in PipelinesApi.
|
@@ -474,7 +466,7 @@ export declare class PipelinesApi extends BaseAPI {
|
|
474
466
|
*/
|
475
467
|
deletePipeline(requestParameters: PipelinesApiDeletePipelineRequest): Promise<DeletePipelineResponse>;
|
476
468
|
/**
|
477
|
-
* Returns data about a specific pipeline.
|
469
|
+
* Returns data about a specific pipeline.
|
478
470
|
* @summary Get one pipeline
|
479
471
|
* @param {PipelinesApiGetPipelineRequest} requestParameters Request parameters.
|
480
472
|
* @deprecated
|
@@ -100,14 +100,13 @@ export const PipelinesApiAxiosParamCreator = function (configuration) {
|
|
100
100
|
};
|
101
101
|
}),
|
102
102
|
/**
|
103
|
-
* Returns data about a specific pipeline.
|
103
|
+
* Returns data about a specific pipeline.
|
104
104
|
* @summary Get one pipeline
|
105
105
|
* @param {number} id The ID of the pipeline
|
106
|
-
* @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.
|
107
106
|
* @deprecated
|
108
107
|
* @throws {RequiredError}
|
109
108
|
*/
|
110
|
-
getPipeline: (id
|
109
|
+
getPipeline: (id) => __awaiter(this, void 0, void 0, function* () {
|
111
110
|
// verify required parameter 'id' is not null or undefined
|
112
111
|
assertParamExists('getPipeline', 'id', id);
|
113
112
|
const localVarPath = `/pipelines/{id}`
|
@@ -126,9 +125,6 @@ export const PipelinesApiAxiosParamCreator = function (configuration) {
|
|
126
125
|
// authentication oauth2 required
|
127
126
|
// oauth required
|
128
127
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full", "admin"], configuration);
|
129
|
-
if (totals_convert_currency !== undefined) {
|
130
|
-
localVarQueryParameter['totals_convert_currency'] = totals_convert_currency;
|
131
|
-
}
|
132
128
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
133
129
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
134
130
|
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
@@ -414,16 +410,15 @@ export const PipelinesApiFp = function (configuration) {
|
|
414
410
|
});
|
415
411
|
},
|
416
412
|
/**
|
417
|
-
* Returns data about a specific pipeline.
|
413
|
+
* Returns data about a specific pipeline.
|
418
414
|
* @summary Get one pipeline
|
419
415
|
* @param {number} id The ID of the pipeline
|
420
|
-
* @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.
|
421
416
|
* @deprecated
|
422
417
|
* @throws {RequiredError}
|
423
418
|
*/
|
424
|
-
getPipeline(id
|
419
|
+
getPipeline(id) {
|
425
420
|
return __awaiter(this, void 0, void 0, function* () {
|
426
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPipeline(id
|
421
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPipeline(id);
|
427
422
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
428
423
|
});
|
429
424
|
},
|
@@ -536,14 +531,14 @@ export const PipelinesApiFactory = function (configuration, basePath, axios) {
|
|
536
531
|
return localVarFp.deletePipeline(requestParameters.id).then((request) => request(axios, basePath));
|
537
532
|
},
|
538
533
|
/**
|
539
|
-
* Returns data about a specific pipeline.
|
534
|
+
* Returns data about a specific pipeline.
|
540
535
|
* @summary Get one pipeline
|
541
536
|
* @param {PipelinesApiGetPipelineRequest} requestParameters Request parameters.
|
542
537
|
* @deprecated
|
543
538
|
* @throws {RequiredError}
|
544
539
|
*/
|
545
540
|
getPipeline(requestParameters) {
|
546
|
-
return localVarFp.getPipeline(requestParameters.id
|
541
|
+
return localVarFp.getPipeline(requestParameters.id).then((request) => request(axios, basePath));
|
547
542
|
},
|
548
543
|
/**
|
549
544
|
* Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period.
|
@@ -626,7 +621,7 @@ export class PipelinesApi extends BaseAPI {
|
|
626
621
|
return PipelinesApiFp(this.configuration).deletePipeline(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
627
622
|
}
|
628
623
|
/**
|
629
|
-
* Returns data about a specific pipeline.
|
624
|
+
* Returns data about a specific pipeline.
|
630
625
|
* @summary Get one pipeline
|
631
626
|
* @param {PipelinesApiGetPipelineRequest} requestParameters Request parameters.
|
632
627
|
* @deprecated
|
@@ -634,7 +629,7 @@ export class PipelinesApi extends BaseAPI {
|
|
634
629
|
* @memberof PipelinesApi
|
635
630
|
*/
|
636
631
|
getPipeline(requestParameters) {
|
637
|
-
return PipelinesApiFp(this.configuration).getPipeline(requestParameters.id
|
632
|
+
return PipelinesApiFp(this.configuration).getPipeline(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
638
633
|
}
|
639
634
|
/**
|
640
635
|
* Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period.
|
@@ -53,11 +53,10 @@ export declare const StagesApiAxiosParamCreator: (configuration?: Configuration)
|
|
53
53
|
* Returns data about a specific stage.
|
54
54
|
* @summary Get one stage
|
55
55
|
* @param {number} id The ID of the stage
|
56
|
-
* @param {0 | 1} [everyone] If `everyone=1` is provided, deals summary will return deals owned by every user
|
57
56
|
* @deprecated
|
58
57
|
* @throws {RequiredError}
|
59
58
|
*/
|
60
|
-
getStage: (id: number
|
59
|
+
getStage: (id: number) => Promise<RequestArgs>;
|
61
60
|
/**
|
62
61
|
* 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.
|
63
62
|
* @summary Get deals in a stage
|
@@ -124,11 +123,10 @@ export declare const StagesApiFp: (configuration?: Configuration) => {
|
|
124
123
|
* Returns data about a specific stage.
|
125
124
|
* @summary Get one stage
|
126
125
|
* @param {number} id The ID of the stage
|
127
|
-
* @param {0 | 1} [everyone] If `everyone=1` is provided, deals summary will return deals owned by every user
|
128
126
|
* @deprecated
|
129
127
|
* @throws {RequiredError}
|
130
128
|
*/
|
131
|
-
getStage(id: number
|
129
|
+
getStage(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetStageResponse>>;
|
132
130
|
/**
|
133
131
|
* 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.
|
134
132
|
* @summary Get deals in a stage
|
@@ -275,12 +273,6 @@ export interface StagesApiGetStageRequest {
|
|
275
273
|
* @memberof StagesApiGetStage
|
276
274
|
*/
|
277
275
|
readonly id: number;
|
278
|
-
/**
|
279
|
-
* If `everyone=1` is provided, deals summary will return deals owned by every user
|
280
|
-
* @type {0 | 1}
|
281
|
-
* @memberof StagesApiGetStage
|
282
|
-
*/
|
283
|
-
readonly everyone?: 0 | 1;
|
284
276
|
}
|
285
277
|
/**
|
286
278
|
* Request parameters for getStageDeals operation in StagesApi.
|
@@ -139,11 +139,10 @@ export const StagesApiAxiosParamCreator = function (configuration) {
|
|
139
139
|
* Returns data about a specific stage.
|
140
140
|
* @summary Get one stage
|
141
141
|
* @param {number} id The ID of the stage
|
142
|
-
* @param {0 | 1} [everyone] If `everyone=1` is provided, deals summary will return deals owned by every user
|
143
142
|
* @deprecated
|
144
143
|
* @throws {RequiredError}
|
145
144
|
*/
|
146
|
-
getStage: (id
|
145
|
+
getStage: (id) => __awaiter(this, void 0, void 0, function* () {
|
147
146
|
// verify required parameter 'id' is not null or undefined
|
148
147
|
assertParamExists('getStage', 'id', id);
|
149
148
|
const localVarPath = `/stages/{id}`
|
@@ -162,9 +161,6 @@ export const StagesApiAxiosParamCreator = function (configuration) {
|
|
162
161
|
// authentication oauth2 required
|
163
162
|
// oauth required
|
164
163
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full", "admin"], configuration);
|
165
|
-
if (everyone !== undefined) {
|
166
|
-
localVarQueryParameter['everyone'] = everyone;
|
167
|
-
}
|
168
164
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
169
165
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
170
166
|
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
@@ -358,13 +354,12 @@ export const StagesApiFp = function (configuration) {
|
|
358
354
|
* Returns data about a specific stage.
|
359
355
|
* @summary Get one stage
|
360
356
|
* @param {number} id The ID of the stage
|
361
|
-
* @param {0 | 1} [everyone] If `everyone=1` is provided, deals summary will return deals owned by every user
|
362
357
|
* @deprecated
|
363
358
|
* @throws {RequiredError}
|
364
359
|
*/
|
365
|
-
getStage(id
|
360
|
+
getStage(id) {
|
366
361
|
return __awaiter(this, void 0, void 0, function* () {
|
367
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getStage(id
|
362
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getStage(id);
|
368
363
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
369
364
|
});
|
370
365
|
},
|
@@ -462,7 +457,7 @@ export const StagesApiFactory = function (configuration, basePath, axios) {
|
|
462
457
|
* @throws {RequiredError}
|
463
458
|
*/
|
464
459
|
getStage(requestParameters) {
|
465
|
-
return localVarFp.getStage(requestParameters.id
|
460
|
+
return localVarFp.getStage(requestParameters.id).then((request) => request(axios, basePath));
|
466
461
|
},
|
467
462
|
/**
|
468
463
|
* 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.
|
@@ -545,7 +540,7 @@ export class StagesApi extends BaseAPI {
|
|
545
540
|
* @memberof StagesApi
|
546
541
|
*/
|
547
542
|
getStage(requestParameters) {
|
548
|
-
return StagesApiFp(this.configuration).getStage(requestParameters.id
|
543
|
+
return StagesApiFp(this.configuration).getStage(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
549
544
|
}
|
550
545
|
/**
|
551
546
|
* 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.
|
@@ -10,10 +10,9 @@
|
|
10
10
|
* Do not edit the class manually.
|
11
11
|
*/
|
12
12
|
import { BaseStage } from './base-stage';
|
13
|
-
import { StageDetailsData } from './stage-details-data';
|
14
13
|
/**
|
15
14
|
* @type GetStageResponseData
|
16
15
|
* The stage object
|
17
16
|
* @export
|
18
17
|
*/
|
19
|
-
export type GetStageResponseData = BaseStage
|
18
|
+
export type GetStageResponseData = BaseStage;
|
@@ -672,14 +672,6 @@ export * from './picture-data-pictures';
|
|
672
672
|
export * from './picture-data-with-id';
|
673
673
|
export * from './picture-data-with-value';
|
674
674
|
export * from './pipeline-details';
|
675
|
-
export * from './pipeline-details-all-of';
|
676
|
-
export * from './pipeline-details-all-of-deals-summary';
|
677
|
-
export * from './pipeline-details-all-of-deals-summary-per-currency';
|
678
|
-
export * from './pipeline-details-all-of-deals-summary-per-currency-full';
|
679
|
-
export * from './pipeline-details-all-of-deals-summary-per-currency-full-currencyid';
|
680
|
-
export * from './pipeline-details-all-of-deals-summary-per-stages';
|
681
|
-
export * from './pipeline-details-all-of-deals-summary-per-stages-stageid';
|
682
|
-
export * from './pipeline-details-all-of-deals-summary-per-stages-stageidcurrencyid';
|
683
675
|
export * from './pipeline-request';
|
684
676
|
export * from './pipeline-request1';
|
685
677
|
export * from './product-field';
|
@@ -737,7 +729,6 @@ export * from './role-assignment-data';
|
|
737
729
|
export * from './role-settings';
|
738
730
|
export * from './search-item';
|
739
731
|
export * from './stage';
|
740
|
-
export * from './stage-details-data';
|
741
732
|
export * from './stage-with-pipeline-info';
|
742
733
|
export * from './sub-role';
|
743
734
|
export * from './sub-role-all-of';
|
@@ -672,14 +672,6 @@ export * from './picture-data-pictures';
|
|
672
672
|
export * from './picture-data-with-id';
|
673
673
|
export * from './picture-data-with-value';
|
674
674
|
export * from './pipeline-details';
|
675
|
-
export * from './pipeline-details-all-of';
|
676
|
-
export * from './pipeline-details-all-of-deals-summary';
|
677
|
-
export * from './pipeline-details-all-of-deals-summary-per-currency';
|
678
|
-
export * from './pipeline-details-all-of-deals-summary-per-currency-full';
|
679
|
-
export * from './pipeline-details-all-of-deals-summary-per-currency-full-currencyid';
|
680
|
-
export * from './pipeline-details-all-of-deals-summary-per-stages';
|
681
|
-
export * from './pipeline-details-all-of-deals-summary-per-stages-stageid';
|
682
|
-
export * from './pipeline-details-all-of-deals-summary-per-stages-stageidcurrencyid';
|
683
675
|
export * from './pipeline-request';
|
684
676
|
export * from './pipeline-request1';
|
685
677
|
export * from './product-field';
|
@@ -737,7 +729,6 @@ export * from './role-assignment-data';
|
|
737
729
|
export * from './role-settings';
|
738
730
|
export * from './search-item';
|
739
731
|
export * from './stage';
|
740
|
-
export * from './stage-details-data';
|
741
732
|
export * from './stage-with-pipeline-info';
|
742
733
|
export * from './sub-role';
|
743
734
|
export * from './sub-role-all-of';
|
@@ -10,10 +10,9 @@
|
|
10
10
|
* Do not edit the class manually.
|
11
11
|
*/
|
12
12
|
import { BasePipelineWithSelectedFlag } from './base-pipeline-with-selected-flag';
|
13
|
-
import { PipelineDetailsAllOf } from './pipeline-details-all-of';
|
14
13
|
/**
|
15
14
|
* @type PipelineDetails
|
16
15
|
* The pipeline object
|
17
16
|
* @export
|
18
17
|
*/
|
19
|
-
export type PipelineDetails = BasePipelineWithSelectedFlag
|
18
|
+
export type PipelineDetails = BasePipelineWithSelectedFlag;
|
@@ -44,14 +44,13 @@ export declare const PipelinesApiAxiosParamCreator: (configuration?: Configurati
|
|
44
44
|
*/
|
45
45
|
deletePipeline: (id: number) => Promise<RequestArgs>;
|
46
46
|
/**
|
47
|
-
* Returns data about a specific pipeline.
|
47
|
+
* Returns data about a specific pipeline.
|
48
48
|
* @summary Get one pipeline
|
49
49
|
* @param {number} id The ID of the pipeline
|
50
|
-
* @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.
|
51
50
|
* @deprecated
|
52
51
|
* @throws {RequiredError}
|
53
52
|
*/
|
54
|
-
getPipeline: (id: number
|
53
|
+
getPipeline: (id: number) => Promise<RequestArgs>;
|
55
54
|
/**
|
56
55
|
* Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period.
|
57
56
|
* @summary Get deals conversion rates in pipeline
|
@@ -129,14 +128,13 @@ export declare const PipelinesApiFp: (configuration?: Configuration) => {
|
|
129
128
|
*/
|
130
129
|
deletePipeline(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeletePipelineResponse>>;
|
131
130
|
/**
|
132
|
-
* Returns data about a specific pipeline.
|
131
|
+
* Returns data about a specific pipeline.
|
133
132
|
* @summary Get one pipeline
|
134
133
|
* @param {number} id The ID of the pipeline
|
135
|
-
* @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.
|
136
134
|
* @deprecated
|
137
135
|
* @throws {RequiredError}
|
138
136
|
*/
|
139
|
-
getPipeline(id: number
|
137
|
+
getPipeline(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPipelineResponse>>;
|
140
138
|
/**
|
141
139
|
* Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period.
|
142
140
|
* @summary Get deals conversion rates in pipeline
|
@@ -214,7 +212,7 @@ export declare const PipelinesApiFactory: (configuration?: Configuration, basePa
|
|
214
212
|
*/
|
215
213
|
deletePipeline(requestParameters: PipelinesApiDeletePipelineRequest): Promise<DeletePipelineResponse>;
|
216
214
|
/**
|
217
|
-
* Returns data about a specific pipeline.
|
215
|
+
* Returns data about a specific pipeline.
|
218
216
|
* @summary Get one pipeline
|
219
217
|
* @param {PipelinesApiGetPipelineRequest} requestParameters Request parameters.
|
220
218
|
* @deprecated
|
@@ -299,12 +297,6 @@ export interface PipelinesApiGetPipelineRequest {
|
|
299
297
|
* @memberof PipelinesApiGetPipeline
|
300
298
|
*/
|
301
299
|
readonly id: number;
|
302
|
-
/**
|
303
|
-
* 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.
|
304
|
-
* @type {string}
|
305
|
-
* @memberof PipelinesApiGetPipeline
|
306
|
-
*/
|
307
|
-
readonly totals_convert_currency?: string;
|
308
300
|
}
|
309
301
|
/**
|
310
302
|
* Request parameters for getPipelineConversionStatistics operation in PipelinesApi.
|
@@ -474,7 +466,7 @@ export declare class PipelinesApi extends BaseAPI {
|
|
474
466
|
*/
|
475
467
|
deletePipeline(requestParameters: PipelinesApiDeletePipelineRequest): Promise<DeletePipelineResponse>;
|
476
468
|
/**
|
477
|
-
* Returns data about a specific pipeline.
|
469
|
+
* Returns data about a specific pipeline.
|
478
470
|
* @summary Get one pipeline
|
479
471
|
* @param {PipelinesApiGetPipelineRequest} requestParameters Request parameters.
|
480
472
|
* @deprecated
|
@@ -106,14 +106,13 @@ const PipelinesApiAxiosParamCreator = function (configuration) {
|
|
106
106
|
};
|
107
107
|
}),
|
108
108
|
/**
|
109
|
-
* Returns data about a specific pipeline.
|
109
|
+
* Returns data about a specific pipeline.
|
110
110
|
* @summary Get one pipeline
|
111
111
|
* @param {number} id The ID of the pipeline
|
112
|
-
* @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.
|
113
112
|
* @deprecated
|
114
113
|
* @throws {RequiredError}
|
115
114
|
*/
|
116
|
-
getPipeline: (id
|
115
|
+
getPipeline: (id) => __awaiter(this, void 0, void 0, function* () {
|
117
116
|
// verify required parameter 'id' is not null or undefined
|
118
117
|
(0, common_1.assertParamExists)('getPipeline', 'id', id);
|
119
118
|
const localVarPath = `/pipelines/{id}`
|
@@ -132,9 +131,6 @@ const PipelinesApiAxiosParamCreator = function (configuration) {
|
|
132
131
|
// authentication oauth2 required
|
133
132
|
// oauth required
|
134
133
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full", "admin"], configuration);
|
135
|
-
if (totals_convert_currency !== undefined) {
|
136
|
-
localVarQueryParameter['totals_convert_currency'] = totals_convert_currency;
|
137
|
-
}
|
138
134
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
139
135
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
140
136
|
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
@@ -421,16 +417,15 @@ const PipelinesApiFp = function (configuration) {
|
|
421
417
|
});
|
422
418
|
},
|
423
419
|
/**
|
424
|
-
* Returns data about a specific pipeline.
|
420
|
+
* Returns data about a specific pipeline.
|
425
421
|
* @summary Get one pipeline
|
426
422
|
* @param {number} id The ID of the pipeline
|
427
|
-
* @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.
|
428
423
|
* @deprecated
|
429
424
|
* @throws {RequiredError}
|
430
425
|
*/
|
431
|
-
getPipeline(id
|
426
|
+
getPipeline(id) {
|
432
427
|
return __awaiter(this, void 0, void 0, function* () {
|
433
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPipeline(id
|
428
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPipeline(id);
|
434
429
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
435
430
|
});
|
436
431
|
},
|
@@ -544,14 +539,14 @@ const PipelinesApiFactory = function (configuration, basePath, axios) {
|
|
544
539
|
return localVarFp.deletePipeline(requestParameters.id).then((request) => request(axios, basePath));
|
545
540
|
},
|
546
541
|
/**
|
547
|
-
* Returns data about a specific pipeline.
|
542
|
+
* Returns data about a specific pipeline.
|
548
543
|
* @summary Get one pipeline
|
549
544
|
* @param {PipelinesApiGetPipelineRequest} requestParameters Request parameters.
|
550
545
|
* @deprecated
|
551
546
|
* @throws {RequiredError}
|
552
547
|
*/
|
553
548
|
getPipeline(requestParameters) {
|
554
|
-
return localVarFp.getPipeline(requestParameters.id
|
549
|
+
return localVarFp.getPipeline(requestParameters.id).then((request) => request(axios, basePath));
|
555
550
|
},
|
556
551
|
/**
|
557
552
|
* Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period.
|
@@ -635,7 +630,7 @@ class PipelinesApi extends base_1.BaseAPI {
|
|
635
630
|
return (0, exports.PipelinesApiFp)(this.configuration).deletePipeline(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
636
631
|
}
|
637
632
|
/**
|
638
|
-
* Returns data about a specific pipeline.
|
633
|
+
* Returns data about a specific pipeline.
|
639
634
|
* @summary Get one pipeline
|
640
635
|
* @param {PipelinesApiGetPipelineRequest} requestParameters Request parameters.
|
641
636
|
* @deprecated
|
@@ -643,7 +638,7 @@ class PipelinesApi extends base_1.BaseAPI {
|
|
643
638
|
* @memberof PipelinesApi
|
644
639
|
*/
|
645
640
|
getPipeline(requestParameters) {
|
646
|
-
return (0, exports.PipelinesApiFp)(this.configuration).getPipeline(requestParameters.id
|
641
|
+
return (0, exports.PipelinesApiFp)(this.configuration).getPipeline(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
647
642
|
}
|
648
643
|
/**
|
649
644
|
* Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period.
|
@@ -53,11 +53,10 @@ export declare const StagesApiAxiosParamCreator: (configuration?: Configuration)
|
|
53
53
|
* Returns data about a specific stage.
|
54
54
|
* @summary Get one stage
|
55
55
|
* @param {number} id The ID of the stage
|
56
|
-
* @param {0 | 1} [everyone] If `everyone=1` is provided, deals summary will return deals owned by every user
|
57
56
|
* @deprecated
|
58
57
|
* @throws {RequiredError}
|
59
58
|
*/
|
60
|
-
getStage: (id: number
|
59
|
+
getStage: (id: number) => Promise<RequestArgs>;
|
61
60
|
/**
|
62
61
|
* 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.
|
63
62
|
* @summary Get deals in a stage
|
@@ -124,11 +123,10 @@ export declare const StagesApiFp: (configuration?: Configuration) => {
|
|
124
123
|
* Returns data about a specific stage.
|
125
124
|
* @summary Get one stage
|
126
125
|
* @param {number} id The ID of the stage
|
127
|
-
* @param {0 | 1} [everyone] If `everyone=1` is provided, deals summary will return deals owned by every user
|
128
126
|
* @deprecated
|
129
127
|
* @throws {RequiredError}
|
130
128
|
*/
|
131
|
-
getStage(id: number
|
129
|
+
getStage(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetStageResponse>>;
|
132
130
|
/**
|
133
131
|
* 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.
|
134
132
|
* @summary Get deals in a stage
|
@@ -275,12 +273,6 @@ export interface StagesApiGetStageRequest {
|
|
275
273
|
* @memberof StagesApiGetStage
|
276
274
|
*/
|
277
275
|
readonly id: number;
|
278
|
-
/**
|
279
|
-
* If `everyone=1` is provided, deals summary will return deals owned by every user
|
280
|
-
* @type {0 | 1}
|
281
|
-
* @memberof StagesApiGetStage
|
282
|
-
*/
|
283
|
-
readonly everyone?: 0 | 1;
|
284
276
|
}
|
285
277
|
/**
|
286
278
|
* Request parameters for getStageDeals operation in StagesApi.
|
@@ -145,11 +145,10 @@ const StagesApiAxiosParamCreator = function (configuration) {
|
|
145
145
|
* Returns data about a specific stage.
|
146
146
|
* @summary Get one stage
|
147
147
|
* @param {number} id The ID of the stage
|
148
|
-
* @param {0 | 1} [everyone] If `everyone=1` is provided, deals summary will return deals owned by every user
|
149
148
|
* @deprecated
|
150
149
|
* @throws {RequiredError}
|
151
150
|
*/
|
152
|
-
getStage: (id
|
151
|
+
getStage: (id) => __awaiter(this, void 0, void 0, function* () {
|
153
152
|
// verify required parameter 'id' is not null or undefined
|
154
153
|
(0, common_1.assertParamExists)('getStage', 'id', id);
|
155
154
|
const localVarPath = `/stages/{id}`
|
@@ -168,9 +167,6 @@ const StagesApiAxiosParamCreator = function (configuration) {
|
|
168
167
|
// authentication oauth2 required
|
169
168
|
// oauth required
|
170
169
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full", "admin"], configuration);
|
171
|
-
if (everyone !== undefined) {
|
172
|
-
localVarQueryParameter['everyone'] = everyone;
|
173
|
-
}
|
174
170
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
175
171
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
176
172
|
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
@@ -365,13 +361,12 @@ const StagesApiFp = function (configuration) {
|
|
365
361
|
* Returns data about a specific stage.
|
366
362
|
* @summary Get one stage
|
367
363
|
* @param {number} id The ID of the stage
|
368
|
-
* @param {0 | 1} [everyone] If `everyone=1` is provided, deals summary will return deals owned by every user
|
369
364
|
* @deprecated
|
370
365
|
* @throws {RequiredError}
|
371
366
|
*/
|
372
|
-
getStage(id
|
367
|
+
getStage(id) {
|
373
368
|
return __awaiter(this, void 0, void 0, function* () {
|
374
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getStage(id
|
369
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getStage(id);
|
375
370
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
376
371
|
});
|
377
372
|
},
|
@@ -470,7 +465,7 @@ const StagesApiFactory = function (configuration, basePath, axios) {
|
|
470
465
|
* @throws {RequiredError}
|
471
466
|
*/
|
472
467
|
getStage(requestParameters) {
|
473
|
-
return localVarFp.getStage(requestParameters.id
|
468
|
+
return localVarFp.getStage(requestParameters.id).then((request) => request(axios, basePath));
|
474
469
|
},
|
475
470
|
/**
|
476
471
|
* 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.
|
@@ -554,7 +549,7 @@ class StagesApi extends base_1.BaseAPI {
|
|
554
549
|
* @memberof StagesApi
|
555
550
|
*/
|
556
551
|
getStage(requestParameters) {
|
557
|
-
return (0, exports.StagesApiFp)(this.configuration).getStage(requestParameters.id
|
552
|
+
return (0, exports.StagesApiFp)(this.configuration).getStage(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
558
553
|
}
|
559
554
|
/**
|
560
555
|
* 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.
|
@@ -10,10 +10,9 @@
|
|
10
10
|
* Do not edit the class manually.
|
11
11
|
*/
|
12
12
|
import { BaseStage } from './base-stage';
|
13
|
-
import { StageDetailsData } from './stage-details-data';
|
14
13
|
/**
|
15
14
|
* @type GetStageResponseData
|
16
15
|
* The stage object
|
17
16
|
* @export
|
18
17
|
*/
|
19
|
-
export type GetStageResponseData = BaseStage
|
18
|
+
export type GetStageResponseData = BaseStage;
|
@@ -672,14 +672,6 @@ export * from './picture-data-pictures';
|
|
672
672
|
export * from './picture-data-with-id';
|
673
673
|
export * from './picture-data-with-value';
|
674
674
|
export * from './pipeline-details';
|
675
|
-
export * from './pipeline-details-all-of';
|
676
|
-
export * from './pipeline-details-all-of-deals-summary';
|
677
|
-
export * from './pipeline-details-all-of-deals-summary-per-currency';
|
678
|
-
export * from './pipeline-details-all-of-deals-summary-per-currency-full';
|
679
|
-
export * from './pipeline-details-all-of-deals-summary-per-currency-full-currencyid';
|
680
|
-
export * from './pipeline-details-all-of-deals-summary-per-stages';
|
681
|
-
export * from './pipeline-details-all-of-deals-summary-per-stages-stageid';
|
682
|
-
export * from './pipeline-details-all-of-deals-summary-per-stages-stageidcurrencyid';
|
683
675
|
export * from './pipeline-request';
|
684
676
|
export * from './pipeline-request1';
|
685
677
|
export * from './product-field';
|
@@ -737,7 +729,6 @@ export * from './role-assignment-data';
|
|
737
729
|
export * from './role-settings';
|
738
730
|
export * from './search-item';
|
739
731
|
export * from './stage';
|
740
|
-
export * from './stage-details-data';
|
741
732
|
export * from './stage-with-pipeline-info';
|
742
733
|
export * from './sub-role';
|
743
734
|
export * from './sub-role-all-of';
|
@@ -688,14 +688,6 @@ __exportStar(require("./picture-data-pictures"), exports);
|
|
688
688
|
__exportStar(require("./picture-data-with-id"), exports);
|
689
689
|
__exportStar(require("./picture-data-with-value"), exports);
|
690
690
|
__exportStar(require("./pipeline-details"), exports);
|
691
|
-
__exportStar(require("./pipeline-details-all-of"), exports);
|
692
|
-
__exportStar(require("./pipeline-details-all-of-deals-summary"), exports);
|
693
|
-
__exportStar(require("./pipeline-details-all-of-deals-summary-per-currency"), exports);
|
694
|
-
__exportStar(require("./pipeline-details-all-of-deals-summary-per-currency-full"), exports);
|
695
|
-
__exportStar(require("./pipeline-details-all-of-deals-summary-per-currency-full-currencyid"), exports);
|
696
|
-
__exportStar(require("./pipeline-details-all-of-deals-summary-per-stages"), exports);
|
697
|
-
__exportStar(require("./pipeline-details-all-of-deals-summary-per-stages-stageid"), exports);
|
698
|
-
__exportStar(require("./pipeline-details-all-of-deals-summary-per-stages-stageidcurrencyid"), exports);
|
699
691
|
__exportStar(require("./pipeline-request"), exports);
|
700
692
|
__exportStar(require("./pipeline-request1"), exports);
|
701
693
|
__exportStar(require("./product-field"), exports);
|
@@ -753,7 +745,6 @@ __exportStar(require("./role-assignment-data"), exports);
|
|
753
745
|
__exportStar(require("./role-settings"), exports);
|
754
746
|
__exportStar(require("./search-item"), exports);
|
755
747
|
__exportStar(require("./stage"), exports);
|
756
|
-
__exportStar(require("./stage-details-data"), exports);
|
757
748
|
__exportStar(require("./stage-with-pipeline-info"), exports);
|
758
749
|
__exportStar(require("./sub-role"), exports);
|
759
750
|
__exportStar(require("./sub-role-all-of"), exports);
|
@@ -10,10 +10,9 @@
|
|
10
10
|
* Do not edit the class manually.
|
11
11
|
*/
|
12
12
|
import { BasePipelineWithSelectedFlag } from './base-pipeline-with-selected-flag';
|
13
|
-
import { PipelineDetailsAllOf } from './pipeline-details-all-of';
|
14
13
|
/**
|
15
14
|
* @type PipelineDetails
|
16
15
|
* The pipeline object
|
17
16
|
* @export
|
18
17
|
*/
|
19
|
-
export type PipelineDetails = BasePipelineWithSelectedFlag
|
18
|
+
export type PipelineDetails = BasePipelineWithSelectedFlag;
|