pipedrive 30.0.0 → 30.2.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/v2/api/deals-api.d.ts +137 -26
- package/dist/esm/versions/v2/api/deals-api.js +153 -8
- package/dist/esm/versions/v2/models/add-many-deal-product-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/add-many-deal-product-response.js +14 -0
- package/dist/esm/versions/v2/models/create-many-deal-product-request.d.ts +24 -0
- package/dist/esm/versions/v2/models/create-many-deal-product-request.js +14 -0
- package/dist/esm/versions/v2/models/delete-many-deal-product-response-additional-data.d.ts +23 -0
- package/dist/esm/versions/v2/models/delete-many-deal-product-response-additional-data.js +14 -0
- package/dist/esm/versions/v2/models/delete-many-deal-product-response-data.d.ts +23 -0
- package/dist/esm/versions/v2/models/delete-many-deal-product-response-data.js +14 -0
- package/dist/esm/versions/v2/models/delete-many-deal-product-response.d.ts +35 -0
- package/dist/esm/versions/v2/models/delete-many-deal-product-response.js +14 -0
- package/dist/esm/versions/v2/models/get-deals-products-response-data-inner-all-of.d.ts +5 -0
- package/dist/esm/versions/v2/models/index.d.ts +5 -0
- package/dist/esm/versions/v2/models/index.js +5 -0
- package/dist/versions/v2/api/deals-api.d.ts +137 -26
- package/dist/versions/v2/api/deals-api.js +153 -8
- package/dist/versions/v2/models/add-many-deal-product-response.d.ts +29 -0
- package/dist/versions/v2/models/add-many-deal-product-response.js +15 -0
- package/dist/versions/v2/models/create-many-deal-product-request.d.ts +24 -0
- package/dist/versions/v2/models/create-many-deal-product-request.js +15 -0
- package/dist/versions/v2/models/delete-many-deal-product-response-additional-data.d.ts +23 -0
- package/dist/versions/v2/models/delete-many-deal-product-response-additional-data.js +15 -0
- package/dist/versions/v2/models/delete-many-deal-product-response-data.d.ts +23 -0
- package/dist/versions/v2/models/delete-many-deal-product-response-data.js +15 -0
- package/dist/versions/v2/models/delete-many-deal-product-response.d.ts +35 -0
- package/dist/versions/v2/models/delete-many-deal-product-response.js +15 -0
- package/dist/versions/v2/models/get-deals-products-response-data-inner-all-of.d.ts +5 -0
- package/dist/versions/v2/models/index.d.ts +5 -0
- package/dist/versions/v2/models/index.js +5 -0
- package/package.json +1 -1
@@ -0,0 +1,29 @@
|
|
1
|
+
/**
|
2
|
+
* Pipedrive API v2
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
4
|
+
*
|
5
|
+
* The version of the OpenAPI document: 2.0.0
|
6
|
+
*
|
7
|
+
*
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
9
|
+
* https://openapi-generator.tech
|
10
|
+
* Do not edit the class manually.
|
11
|
+
*/
|
12
|
+
import { GetDealsProductsResponseDataInner } from './get-deals-products-response-data-inner';
|
13
|
+
/**
|
14
|
+
*
|
15
|
+
* @export
|
16
|
+
* @interface AddManyDealProductResponse
|
17
|
+
*/
|
18
|
+
export interface AddManyDealProductResponse {
|
19
|
+
/**
|
20
|
+
* If the response is successful or not
|
21
|
+
* @type {boolean}
|
22
|
+
*/
|
23
|
+
'success'?: boolean;
|
24
|
+
/**
|
25
|
+
* Array of created deal products
|
26
|
+
* @type {Array<GetDealsProductsResponseDataInner>}
|
27
|
+
*/
|
28
|
+
'data'?: Array<GetDealsProductsResponseDataInner>;
|
29
|
+
}
|
@@ -0,0 +1,14 @@
|
|
1
|
+
/* tslint:disable */
|
2
|
+
/* eslint-disable */
|
3
|
+
/**
|
4
|
+
* Pipedrive API v2
|
5
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
6
|
+
*
|
7
|
+
* The version of the OpenAPI document: 2.0.0
|
8
|
+
*
|
9
|
+
*
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
11
|
+
* https://openapi-generator.tech
|
12
|
+
* Do not edit the class manually.
|
13
|
+
*/
|
14
|
+
export {};
|
@@ -0,0 +1,24 @@
|
|
1
|
+
/**
|
2
|
+
* Pipedrive API v2
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
4
|
+
*
|
5
|
+
* The version of the OpenAPI document: 2.0.0
|
6
|
+
*
|
7
|
+
*
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
9
|
+
* https://openapi-generator.tech
|
10
|
+
* Do not edit the class manually.
|
11
|
+
*/
|
12
|
+
import { AddDealProductRequest } from './add-deal-product-request';
|
13
|
+
/**
|
14
|
+
*
|
15
|
+
* @export
|
16
|
+
* @interface CreateManyDealProductRequest
|
17
|
+
*/
|
18
|
+
export interface CreateManyDealProductRequest {
|
19
|
+
/**
|
20
|
+
* Array of products to attach to the deal. See the single product endpoint (https://developers.pipedrive.com/docs/api/v1/Deals#addDealProduct) for the expected format of array items.
|
21
|
+
* @type {Array<AddDealProductRequest>}
|
22
|
+
*/
|
23
|
+
'data': Array<AddDealProductRequest>;
|
24
|
+
}
|
@@ -0,0 +1,14 @@
|
|
1
|
+
/* tslint:disable */
|
2
|
+
/* eslint-disable */
|
3
|
+
/**
|
4
|
+
* Pipedrive API v2
|
5
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
6
|
+
*
|
7
|
+
* The version of the OpenAPI document: 2.0.0
|
8
|
+
*
|
9
|
+
*
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
11
|
+
* https://openapi-generator.tech
|
12
|
+
* Do not edit the class manually.
|
13
|
+
*/
|
14
|
+
export {};
|
@@ -0,0 +1,23 @@
|
|
1
|
+
/**
|
2
|
+
* Pipedrive API v2
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
4
|
+
*
|
5
|
+
* The version of the OpenAPI document: 2.0.0
|
6
|
+
*
|
7
|
+
*
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
9
|
+
* https://openapi-generator.tech
|
10
|
+
* Do not edit the class manually.
|
11
|
+
*/
|
12
|
+
/**
|
13
|
+
*
|
14
|
+
* @export
|
15
|
+
* @interface DeleteManyDealProductResponseAdditionalData
|
16
|
+
*/
|
17
|
+
export interface DeleteManyDealProductResponseAdditionalData {
|
18
|
+
/**
|
19
|
+
* Whether there are more products to delete (when the deal has more than 100 products)
|
20
|
+
* @type {boolean}
|
21
|
+
*/
|
22
|
+
'more_items_in_collection'?: boolean;
|
23
|
+
}
|
@@ -0,0 +1,14 @@
|
|
1
|
+
/* tslint:disable */
|
2
|
+
/* eslint-disable */
|
3
|
+
/**
|
4
|
+
* Pipedrive API v2
|
5
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
6
|
+
*
|
7
|
+
* The version of the OpenAPI document: 2.0.0
|
8
|
+
*
|
9
|
+
*
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
11
|
+
* https://openapi-generator.tech
|
12
|
+
* Do not edit the class manually.
|
13
|
+
*/
|
14
|
+
export {};
|
@@ -0,0 +1,23 @@
|
|
1
|
+
/**
|
2
|
+
* Pipedrive API v2
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
4
|
+
*
|
5
|
+
* The version of the OpenAPI document: 2.0.0
|
6
|
+
*
|
7
|
+
*
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
9
|
+
* https://openapi-generator.tech
|
10
|
+
* Do not edit the class manually.
|
11
|
+
*/
|
12
|
+
/**
|
13
|
+
*
|
14
|
+
* @export
|
15
|
+
* @interface DeleteManyDealProductResponseData
|
16
|
+
*/
|
17
|
+
export interface DeleteManyDealProductResponseData {
|
18
|
+
/**
|
19
|
+
* Array of IDs of products that were deleted from the deal
|
20
|
+
* @type {Array<number>}
|
21
|
+
*/
|
22
|
+
'ids'?: Array<number>;
|
23
|
+
}
|
@@ -0,0 +1,14 @@
|
|
1
|
+
/* tslint:disable */
|
2
|
+
/* eslint-disable */
|
3
|
+
/**
|
4
|
+
* Pipedrive API v2
|
5
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
6
|
+
*
|
7
|
+
* The version of the OpenAPI document: 2.0.0
|
8
|
+
*
|
9
|
+
*
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
11
|
+
* https://openapi-generator.tech
|
12
|
+
* Do not edit the class manually.
|
13
|
+
*/
|
14
|
+
export {};
|
@@ -0,0 +1,35 @@
|
|
1
|
+
/**
|
2
|
+
* Pipedrive API v2
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
4
|
+
*
|
5
|
+
* The version of the OpenAPI document: 2.0.0
|
6
|
+
*
|
7
|
+
*
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
9
|
+
* https://openapi-generator.tech
|
10
|
+
* Do not edit the class manually.
|
11
|
+
*/
|
12
|
+
import { DeleteManyDealProductResponseAdditionalData } from './delete-many-deal-product-response-additional-data';
|
13
|
+
import { DeleteManyDealProductResponseData } from './delete-many-deal-product-response-data';
|
14
|
+
/**
|
15
|
+
*
|
16
|
+
* @export
|
17
|
+
* @interface DeleteManyDealProductResponse
|
18
|
+
*/
|
19
|
+
export interface DeleteManyDealProductResponse {
|
20
|
+
/**
|
21
|
+
* If the response is successful or not
|
22
|
+
* @type {boolean}
|
23
|
+
*/
|
24
|
+
'success'?: boolean;
|
25
|
+
/**
|
26
|
+
*
|
27
|
+
* @type {DeleteManyDealProductResponseData}
|
28
|
+
*/
|
29
|
+
'data'?: DeleteManyDealProductResponseData;
|
30
|
+
/**
|
31
|
+
*
|
32
|
+
* @type {DeleteManyDealProductResponseAdditionalData}
|
33
|
+
*/
|
34
|
+
'additional_data'?: DeleteManyDealProductResponseAdditionalData | null;
|
35
|
+
}
|
@@ -0,0 +1,14 @@
|
|
1
|
+
/* tslint:disable */
|
2
|
+
/* eslint-disable */
|
3
|
+
/**
|
4
|
+
* Pipedrive API v2
|
5
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
6
|
+
*
|
7
|
+
* The version of the OpenAPI document: 2.0.0
|
8
|
+
*
|
9
|
+
*
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
11
|
+
* https://openapi-generator.tech
|
12
|
+
* Do not edit the class manually.
|
13
|
+
*/
|
14
|
+
export {};
|
@@ -51,6 +51,11 @@ export interface GetDealsProductsResponseDataInnerAllOf {
|
|
51
51
|
*/
|
52
52
|
'product_variation_id'?: number | null;
|
53
53
|
/**
|
54
|
+
* The order number of the product within the deal
|
55
|
+
* @type {number}
|
56
|
+
*/
|
57
|
+
'order_nr'?: number | null;
|
58
|
+
/**
|
54
59
|
* The date and time when the product was added to the deal
|
55
60
|
* @type {string}
|
56
61
|
*/
|
@@ -17,6 +17,7 @@ export * from './add-deal-request';
|
|
17
17
|
export * from './add-follower-response';
|
18
18
|
export * from './add-follower-response-all-of';
|
19
19
|
export * from './add-installment-request-body';
|
20
|
+
export * from './add-many-deal-product-response';
|
20
21
|
export * from './add-organization-request';
|
21
22
|
export * from './add-person-request';
|
22
23
|
export * from './add-person-request-emails-inner';
|
@@ -32,6 +33,7 @@ export * from './base-product-all-of';
|
|
32
33
|
export * from './base-product-all-of1';
|
33
34
|
export * from './base-response';
|
34
35
|
export * from './convert-lead-to-deal-request';
|
36
|
+
export * from './create-many-deal-product-request';
|
35
37
|
export * from './deal-item';
|
36
38
|
export * from './deal-item1';
|
37
39
|
export * from './deal-product-request-body';
|
@@ -48,6 +50,9 @@ export * from './delete-follower-response';
|
|
48
50
|
export * from './delete-follower-response-data';
|
49
51
|
export * from './delete-installment-response';
|
50
52
|
export * from './delete-installment-response-data';
|
53
|
+
export * from './delete-many-deal-product-response';
|
54
|
+
export * from './delete-many-deal-product-response-additional-data';
|
55
|
+
export * from './delete-many-deal-product-response-data';
|
51
56
|
export * from './delete-organization-response';
|
52
57
|
export * from './delete-organization-response-data';
|
53
58
|
export * from './delete-person-response';
|
@@ -17,6 +17,7 @@ export * from './add-deal-request';
|
|
17
17
|
export * from './add-follower-response';
|
18
18
|
export * from './add-follower-response-all-of';
|
19
19
|
export * from './add-installment-request-body';
|
20
|
+
export * from './add-many-deal-product-response';
|
20
21
|
export * from './add-organization-request';
|
21
22
|
export * from './add-person-request';
|
22
23
|
export * from './add-person-request-emails-inner';
|
@@ -32,6 +33,7 @@ export * from './base-product-all-of';
|
|
32
33
|
export * from './base-product-all-of1';
|
33
34
|
export * from './base-response';
|
34
35
|
export * from './convert-lead-to-deal-request';
|
36
|
+
export * from './create-many-deal-product-request';
|
35
37
|
export * from './deal-item';
|
36
38
|
export * from './deal-item1';
|
37
39
|
export * from './deal-product-request-body';
|
@@ -48,6 +50,9 @@ export * from './delete-follower-response';
|
|
48
50
|
export * from './delete-follower-response-data';
|
49
51
|
export * from './delete-installment-response';
|
50
52
|
export * from './delete-installment-response-data';
|
53
|
+
export * from './delete-many-deal-product-response';
|
54
|
+
export * from './delete-many-deal-product-response-additional-data';
|
55
|
+
export * from './delete-many-deal-product-response-data';
|
51
56
|
export * from './delete-organization-response';
|
52
57
|
export * from './delete-organization-response-data';
|
53
58
|
export * from './delete-person-response';
|
@@ -22,11 +22,14 @@ import { AddDealProductResponse } from '../models';
|
|
22
22
|
import { AddDealRequest } from '../models';
|
23
23
|
import { AddFollowerResponse } from '../models';
|
24
24
|
import { AddInstallmentRequestBody } from '../models';
|
25
|
+
import { AddManyDealProductResponse } from '../models';
|
26
|
+
import { CreateManyDealProductRequest } from '../models';
|
25
27
|
import { DeleteAdditionalDiscountResponse } from '../models';
|
26
28
|
import { DeleteDealProductResponse } from '../models';
|
27
29
|
import { DeleteDealResponse } from '../models';
|
28
30
|
import { DeleteFollowerResponse } from '../models';
|
29
31
|
import { DeleteInstallmentResponse } from '../models';
|
32
|
+
import { DeleteManyDealProductResponse } from '../models';
|
30
33
|
import { GetAdditionalDiscountsResponse } from '../models';
|
31
34
|
import { GetConvertResponse1 } from '../models';
|
32
35
|
import { GetDealSearchResponse } from '../models';
|
@@ -73,6 +76,15 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
73
76
|
* @throws {RequiredError}
|
74
77
|
*/
|
75
78
|
addDealProduct: (id: number, AddDealProductRequest?: AddDealProductRequest) => Promise<RequestArgs>;
|
79
|
+
/**
|
80
|
+
* Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
|
81
|
+
* @summary Add multiple products to a deal
|
82
|
+
* @param {number} id The ID of the deal
|
83
|
+
* @param {CreateManyDealProductRequest} [CreateManyDealProductRequest]
|
84
|
+
|
85
|
+
* @throws {RequiredError}
|
86
|
+
*/
|
87
|
+
addManyDealProducts: (id: number, CreateManyDealProductRequest?: CreateManyDealProductRequest) => Promise<RequestArgs>;
|
76
88
|
/**
|
77
89
|
* Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
|
78
90
|
* @summary Convert a deal to a lead (BETA)
|
@@ -85,11 +97,11 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
85
97
|
* Removes a discount from a deal, changing the deal value if the deal has one-time products attached.
|
86
98
|
* @summary Delete a discount from a deal
|
87
99
|
* @param {number} id The ID of the deal
|
88
|
-
* @param {
|
100
|
+
* @param {string} discount_id The ID of the discount
|
89
101
|
|
90
102
|
* @throws {RequiredError}
|
91
103
|
*/
|
92
|
-
deleteAdditionalDiscount: (id: number, discount_id:
|
104
|
+
deleteAdditionalDiscount: (id: number, discount_id: string) => Promise<RequestArgs>;
|
93
105
|
/**
|
94
106
|
* Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
|
95
107
|
* @summary Delete a deal
|
@@ -125,6 +137,15 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
125
137
|
* @throws {RequiredError}
|
126
138
|
*/
|
127
139
|
deleteInstallment: (id: number, installment_id: number) => Promise<RequestArgs>;
|
140
|
+
/**
|
141
|
+
* Deletes multiple products from a deal. If no product IDs are specified, up to 100 products will be removed from the deal. A maximum of 100 product IDs can be provided per request.
|
142
|
+
* @summary Delete many products from a deal
|
143
|
+
* @param {number} id The ID of the deal
|
144
|
+
* @param {string} [ids] Comma-separated list of deal product IDs to delete. If not provided, all deal products will be deleted up to 100 items. Maximum 100 IDs allowed.
|
145
|
+
|
146
|
+
* @throws {RequiredError}
|
147
|
+
*/
|
148
|
+
deleteManyDealProducts: (id: number, ids?: string) => Promise<RequestArgs>;
|
128
149
|
/**
|
129
150
|
* Lists discounts attached to a deal.
|
130
151
|
* @summary List discounts added to a deal
|
@@ -201,12 +222,12 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
201
222
|
* @param {number} id The ID of the deal
|
202
223
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
203
224
|
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
204
|
-
* @param {'id' | 'add_time' | 'update_time'} [sort_by] The field to sort by. Supported fields: `id`, `add_time`, `update_time`.
|
225
|
+
* @param {'id' | 'add_time' | 'update_time' | 'order_nr'} [sort_by] The field to sort by. Supported fields: `id`, `add_time`, `update_time`, `order_nr`.
|
205
226
|
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
206
227
|
|
207
228
|
* @throws {RequiredError}
|
208
229
|
*/
|
209
|
-
getDealProducts: (id: number, cursor?: string, limit?: number, sort_by?: 'id' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc') => Promise<RequestArgs>;
|
230
|
+
getDealProducts: (id: number, cursor?: string, limit?: number, sort_by?: 'id' | 'add_time' | 'update_time' | 'order_nr', sort_direction?: 'asc' | 'desc') => Promise<RequestArgs>;
|
210
231
|
/**
|
211
232
|
* Returns data about all not archived deals.
|
212
233
|
* @summary Get all deals
|
@@ -236,12 +257,12 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
236
257
|
* @param {Array<number>} deal_ids An array of integers with the IDs of the deals for which the attached products will be returned. A maximum of 100 deal IDs can be provided.
|
237
258
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
238
259
|
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
239
|
-
* @param {'id' | 'deal_id' | 'add_time' | 'update_time'} [sort_by] The field to sort by. Supported fields: `id`, `deal_id`, `add_time`, `update_time`.
|
260
|
+
* @param {'id' | 'deal_id' | 'add_time' | 'update_time' | 'order_nr'} [sort_by] The field to sort by. Supported fields: `id`, `deal_id`, `add_time`, `update_time`, `order_nr`.
|
240
261
|
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
241
262
|
|
242
263
|
* @throws {RequiredError}
|
243
264
|
*/
|
244
|
-
getDealsProducts: (deal_ids: Array<number>, cursor?: string, limit?: number, sort_by?: 'id' | 'deal_id' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc') => Promise<RequestArgs>;
|
265
|
+
getDealsProducts: (deal_ids: Array<number>, cursor?: string, limit?: number, sort_by?: 'id' | 'deal_id' | 'add_time' | 'update_time' | 'order_nr', sort_direction?: 'asc' | 'desc') => Promise<RequestArgs>;
|
245
266
|
/**
|
246
267
|
* Lists installments attached to a list of deals. Only available in Growth and above plans.
|
247
268
|
* @summary List installments added to a list of deals
|
@@ -292,12 +313,12 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
292
313
|
* Edits a discount added to a deal, changing the deal value if the deal has one-time products attached.
|
293
314
|
* @summary Update a discount added to a deal
|
294
315
|
* @param {number} id The ID of the deal
|
295
|
-
* @param {
|
316
|
+
* @param {string} discount_id The ID of the discount
|
296
317
|
* @param {UpdateAdditionalDiscountRequestBody} [UpdateAdditionalDiscountRequestBody]
|
297
318
|
|
298
319
|
* @throws {RequiredError}
|
299
320
|
*/
|
300
|
-
updateAdditionalDiscount: (id: number, discount_id:
|
321
|
+
updateAdditionalDiscount: (id: number, discount_id: string, UpdateAdditionalDiscountRequestBody?: UpdateAdditionalDiscountRequestBody) => Promise<RequestArgs>;
|
301
322
|
/**
|
302
323
|
* Updates the properties of a deal.
|
303
324
|
* @summary Update a deal
|
@@ -359,6 +380,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
359
380
|
* @throws {RequiredError}
|
360
381
|
*/
|
361
382
|
addDealProduct(id: number, AddDealProductRequest?: AddDealProductRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealProductResponse>>;
|
383
|
+
/**
|
384
|
+
* Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
|
385
|
+
* @summary Add multiple products to a deal
|
386
|
+
* @param {number} id The ID of the deal
|
387
|
+
* @param {CreateManyDealProductRequest} [CreateManyDealProductRequest]
|
388
|
+
|
389
|
+
* @throws {RequiredError}
|
390
|
+
*/
|
391
|
+
addManyDealProducts(id: number, CreateManyDealProductRequest?: CreateManyDealProductRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddManyDealProductResponse>>;
|
362
392
|
/**
|
363
393
|
* Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
|
364
394
|
* @summary Convert a deal to a lead (BETA)
|
@@ -371,11 +401,11 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
371
401
|
* Removes a discount from a deal, changing the deal value if the deal has one-time products attached.
|
372
402
|
* @summary Delete a discount from a deal
|
373
403
|
* @param {number} id The ID of the deal
|
374
|
-
* @param {
|
404
|
+
* @param {string} discount_id The ID of the discount
|
375
405
|
|
376
406
|
* @throws {RequiredError}
|
377
407
|
*/
|
378
|
-
deleteAdditionalDiscount(id: number, discount_id:
|
408
|
+
deleteAdditionalDiscount(id: number, discount_id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteAdditionalDiscountResponse>>;
|
379
409
|
/**
|
380
410
|
* Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
|
381
411
|
* @summary Delete a deal
|
@@ -411,6 +441,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
411
441
|
* @throws {RequiredError}
|
412
442
|
*/
|
413
443
|
deleteInstallment(id: number, installment_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteInstallmentResponse>>;
|
444
|
+
/**
|
445
|
+
* Deletes multiple products from a deal. If no product IDs are specified, up to 100 products will be removed from the deal. A maximum of 100 product IDs can be provided per request.
|
446
|
+
* @summary Delete many products from a deal
|
447
|
+
* @param {number} id The ID of the deal
|
448
|
+
* @param {string} [ids] Comma-separated list of deal product IDs to delete. If not provided, all deal products will be deleted up to 100 items. Maximum 100 IDs allowed.
|
449
|
+
|
450
|
+
* @throws {RequiredError}
|
451
|
+
*/
|
452
|
+
deleteManyDealProducts(id: number, ids?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteManyDealProductResponse>>;
|
414
453
|
/**
|
415
454
|
* Lists discounts attached to a deal.
|
416
455
|
* @summary List discounts added to a deal
|
@@ -487,12 +526,12 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
487
526
|
* @param {number} id The ID of the deal
|
488
527
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
489
528
|
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
490
|
-
* @param {'id' | 'add_time' | 'update_time'} [sort_by] The field to sort by. Supported fields: `id`, `add_time`, `update_time`.
|
529
|
+
* @param {'id' | 'add_time' | 'update_time' | 'order_nr'} [sort_by] The field to sort by. Supported fields: `id`, `add_time`, `update_time`, `order_nr`.
|
491
530
|
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
492
531
|
|
493
532
|
* @throws {RequiredError}
|
494
533
|
*/
|
495
|
-
getDealProducts(id: number, cursor?: string, limit?: number, sort_by?: 'id' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsProductsResponse>>;
|
534
|
+
getDealProducts(id: number, cursor?: string, limit?: number, sort_by?: 'id' | 'add_time' | 'update_time' | 'order_nr', sort_direction?: 'asc' | 'desc'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsProductsResponse>>;
|
496
535
|
/**
|
497
536
|
* Returns data about all not archived deals.
|
498
537
|
* @summary Get all deals
|
@@ -522,12 +561,12 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
522
561
|
* @param {Array<number>} deal_ids An array of integers with the IDs of the deals for which the attached products will be returned. A maximum of 100 deal IDs can be provided.
|
523
562
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
524
563
|
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
525
|
-
* @param {'id' | 'deal_id' | 'add_time' | 'update_time'} [sort_by] The field to sort by. Supported fields: `id`, `deal_id`, `add_time`, `update_time`.
|
564
|
+
* @param {'id' | 'deal_id' | 'add_time' | 'update_time' | 'order_nr'} [sort_by] The field to sort by. Supported fields: `id`, `deal_id`, `add_time`, `update_time`, `order_nr`.
|
526
565
|
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
527
566
|
|
528
567
|
* @throws {RequiredError}
|
529
568
|
*/
|
530
|
-
getDealsProducts(deal_ids: Array<number>, cursor?: string, limit?: number, sort_by?: 'id' | 'deal_id' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsProductsResponse>>;
|
569
|
+
getDealsProducts(deal_ids: Array<number>, cursor?: string, limit?: number, sort_by?: 'id' | 'deal_id' | 'add_time' | 'update_time' | 'order_nr', sort_direction?: 'asc' | 'desc'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsProductsResponse>>;
|
531
570
|
/**
|
532
571
|
* Lists installments attached to a list of deals. Only available in Growth and above plans.
|
533
572
|
* @summary List installments added to a list of deals
|
@@ -578,12 +617,12 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
578
617
|
* Edits a discount added to a deal, changing the deal value if the deal has one-time products attached.
|
579
618
|
* @summary Update a discount added to a deal
|
580
619
|
* @param {number} id The ID of the deal
|
581
|
-
* @param {
|
620
|
+
* @param {string} discount_id The ID of the discount
|
582
621
|
* @param {UpdateAdditionalDiscountRequestBody} [UpdateAdditionalDiscountRequestBody]
|
583
622
|
|
584
623
|
* @throws {RequiredError}
|
585
624
|
*/
|
586
|
-
updateAdditionalDiscount(id: number, discount_id:
|
625
|
+
updateAdditionalDiscount(id: number, discount_id: string, UpdateAdditionalDiscountRequestBody?: UpdateAdditionalDiscountRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpdateAdditionalDiscountResponse>>;
|
587
626
|
/**
|
588
627
|
* Updates the properties of a deal.
|
589
628
|
* @summary Update a deal
|
@@ -643,6 +682,14 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
643
682
|
* @throws {RequiredError}
|
644
683
|
*/
|
645
684
|
addDealProduct(requestParameters: DealsApiAddDealProductRequest): Promise<AddDealProductResponse>;
|
685
|
+
/**
|
686
|
+
* Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
|
687
|
+
* @summary Add multiple products to a deal
|
688
|
+
* @param {DealsApiAddManyDealProductsRequest} requestParameters Request parameters.
|
689
|
+
|
690
|
+
* @throws {RequiredError}
|
691
|
+
*/
|
692
|
+
addManyDealProducts(requestParameters: DealsApiAddManyDealProductsRequest): Promise<AddManyDealProductResponse>;
|
646
693
|
/**
|
647
694
|
* Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
|
648
695
|
* @summary Convert a deal to a lead (BETA)
|
@@ -691,6 +738,14 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
691
738
|
* @throws {RequiredError}
|
692
739
|
*/
|
693
740
|
deleteInstallment(requestParameters: DealsApiDeleteInstallmentRequest): Promise<DeleteInstallmentResponse>;
|
741
|
+
/**
|
742
|
+
* Deletes multiple products from a deal. If no product IDs are specified, up to 100 products will be removed from the deal. A maximum of 100 product IDs can be provided per request.
|
743
|
+
* @summary Delete many products from a deal
|
744
|
+
* @param {DealsApiDeleteManyDealProductsRequest} requestParameters Request parameters.
|
745
|
+
|
746
|
+
* @throws {RequiredError}
|
747
|
+
*/
|
748
|
+
deleteManyDealProducts(requestParameters: DealsApiDeleteManyDealProductsRequest): Promise<DeleteManyDealProductResponse>;
|
694
749
|
/**
|
695
750
|
* Lists discounts attached to a deal.
|
696
751
|
* @summary List discounts added to a deal
|
@@ -879,6 +934,25 @@ export interface DealsApiAddDealProductRequest {
|
|
879
934
|
*/
|
880
935
|
readonly AddDealProductRequest?: AddDealProductRequest;
|
881
936
|
}
|
937
|
+
/**
|
938
|
+
* Request parameters for addManyDealProducts operation in DealsApi.
|
939
|
+
* @export
|
940
|
+
* @interface DealsApiAddManyDealProductsRequest
|
941
|
+
*/
|
942
|
+
export interface DealsApiAddManyDealProductsRequest {
|
943
|
+
/**
|
944
|
+
* The ID of the deal
|
945
|
+
* @type {number}
|
946
|
+
* @memberof DealsApiAddManyDealProducts
|
947
|
+
*/
|
948
|
+
readonly id: number;
|
949
|
+
/**
|
950
|
+
*
|
951
|
+
* @type {CreateManyDealProductRequest}
|
952
|
+
* @memberof DealsApiAddManyDealProducts
|
953
|
+
*/
|
954
|
+
readonly CreateManyDealProductRequest?: CreateManyDealProductRequest;
|
955
|
+
}
|
882
956
|
/**
|
883
957
|
* Request parameters for convertDealToLead operation in DealsApi.
|
884
958
|
* @export
|
@@ -906,10 +980,10 @@ export interface DealsApiDeleteAdditionalDiscountRequest {
|
|
906
980
|
readonly id: number;
|
907
981
|
/**
|
908
982
|
* The ID of the discount
|
909
|
-
* @type {
|
983
|
+
* @type {string}
|
910
984
|
* @memberof DealsApiDeleteAdditionalDiscount
|
911
985
|
*/
|
912
|
-
readonly discount_id:
|
986
|
+
readonly discount_id: string;
|
913
987
|
}
|
914
988
|
/**
|
915
989
|
* Request parameters for deleteDeal operation in DealsApi.
|
@@ -981,6 +1055,25 @@ export interface DealsApiDeleteInstallmentRequest {
|
|
981
1055
|
*/
|
982
1056
|
readonly installment_id: number;
|
983
1057
|
}
|
1058
|
+
/**
|
1059
|
+
* Request parameters for deleteManyDealProducts operation in DealsApi.
|
1060
|
+
* @export
|
1061
|
+
* @interface DealsApiDeleteManyDealProductsRequest
|
1062
|
+
*/
|
1063
|
+
export interface DealsApiDeleteManyDealProductsRequest {
|
1064
|
+
/**
|
1065
|
+
* The ID of the deal
|
1066
|
+
* @type {number}
|
1067
|
+
* @memberof DealsApiDeleteManyDealProducts
|
1068
|
+
*/
|
1069
|
+
readonly id: number;
|
1070
|
+
/**
|
1071
|
+
* Comma-separated list of deal product IDs to delete. If not provided, all deal products will be deleted up to 100 items. Maximum 100 IDs allowed.
|
1072
|
+
* @type {string}
|
1073
|
+
* @memberof DealsApiDeleteManyDealProducts
|
1074
|
+
*/
|
1075
|
+
readonly ids?: string;
|
1076
|
+
}
|
984
1077
|
/**
|
985
1078
|
* Request parameters for getAdditionalDiscounts operation in DealsApi.
|
986
1079
|
* @export
|
@@ -1216,11 +1309,11 @@ export interface DealsApiGetDealProductsRequest {
|
|
1216
1309
|
*/
|
1217
1310
|
readonly limit?: number;
|
1218
1311
|
/**
|
1219
|
-
* The field to sort by. Supported fields: `id`, `add_time`, `update_time`.
|
1220
|
-
* @type {'id' | 'add_time' | 'update_time'}
|
1312
|
+
* The field to sort by. Supported fields: `id`, `add_time`, `update_time`, `order_nr`.
|
1313
|
+
* @type {'id' | 'add_time' | 'update_time' | 'order_nr'}
|
1221
1314
|
* @memberof DealsApiGetDealProducts
|
1222
1315
|
*/
|
1223
|
-
readonly sort_by?: 'id' | 'add_time' | 'update_time';
|
1316
|
+
readonly sort_by?: 'id' | 'add_time' | 'update_time' | 'order_nr';
|
1224
1317
|
/**
|
1225
1318
|
* The sorting direction. Supported values: `asc`, `desc`.
|
1226
1319
|
* @type {'asc' | 'desc'}
|
@@ -1356,11 +1449,11 @@ export interface DealsApiGetDealsProductsRequest {
|
|
1356
1449
|
*/
|
1357
1450
|
readonly limit?: number;
|
1358
1451
|
/**
|
1359
|
-
* The field to sort by. Supported fields: `id`, `deal_id`, `add_time`, `update_time`.
|
1360
|
-
* @type {'id' | 'deal_id' | 'add_time' | 'update_time'}
|
1452
|
+
* The field to sort by. Supported fields: `id`, `deal_id`, `add_time`, `update_time`, `order_nr`.
|
1453
|
+
* @type {'id' | 'deal_id' | 'add_time' | 'update_time' | 'order_nr'}
|
1361
1454
|
* @memberof DealsApiGetDealsProducts
|
1362
1455
|
*/
|
1363
|
-
readonly sort_by?: 'id' | 'deal_id' | 'add_time' | 'update_time';
|
1456
|
+
readonly sort_by?: 'id' | 'deal_id' | 'add_time' | 'update_time' | 'order_nr';
|
1364
1457
|
/**
|
1365
1458
|
* The sorting direction. Supported values: `asc`, `desc`.
|
1366
1459
|
* @type {'asc' | 'desc'}
|
@@ -1518,10 +1611,10 @@ export interface DealsApiUpdateAdditionalDiscountRequest {
|
|
1518
1611
|
readonly id: number;
|
1519
1612
|
/**
|
1520
1613
|
* The ID of the discount
|
1521
|
-
* @type {
|
1614
|
+
* @type {string}
|
1522
1615
|
* @memberof DealsApiUpdateAdditionalDiscount
|
1523
1616
|
*/
|
1524
|
-
readonly discount_id:
|
1617
|
+
readonly discount_id: string;
|
1525
1618
|
/**
|
1526
1619
|
*
|
1527
1620
|
* @type {UpdateAdditionalDiscountRequestBody}
|
@@ -1632,6 +1725,15 @@ export declare class DealsApi extends BaseAPI {
|
|
1632
1725
|
* @memberof DealsApi
|
1633
1726
|
*/
|
1634
1727
|
addDealProduct(requestParameters: DealsApiAddDealProductRequest): Promise<AddDealProductResponse>;
|
1728
|
+
/**
|
1729
|
+
* Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
|
1730
|
+
* @summary Add multiple products to a deal
|
1731
|
+
* @param {DealsApiAddManyDealProductsRequest} requestParameters Request parameters.
|
1732
|
+
|
1733
|
+
* @throws {RequiredError}
|
1734
|
+
* @memberof DealsApi
|
1735
|
+
*/
|
1736
|
+
addManyDealProducts(requestParameters: DealsApiAddManyDealProductsRequest): Promise<AddManyDealProductResponse>;
|
1635
1737
|
/**
|
1636
1738
|
* Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
|
1637
1739
|
* @summary Convert a deal to a lead (BETA)
|
@@ -1686,6 +1788,15 @@ export declare class DealsApi extends BaseAPI {
|
|
1686
1788
|
* @memberof DealsApi
|
1687
1789
|
*/
|
1688
1790
|
deleteInstallment(requestParameters: DealsApiDeleteInstallmentRequest): Promise<DeleteInstallmentResponse>;
|
1791
|
+
/**
|
1792
|
+
* Deletes multiple products from a deal. If no product IDs are specified, up to 100 products will be removed from the deal. A maximum of 100 product IDs can be provided per request.
|
1793
|
+
* @summary Delete many products from a deal
|
1794
|
+
* @param {DealsApiDeleteManyDealProductsRequest} requestParameters Request parameters.
|
1795
|
+
|
1796
|
+
* @throws {RequiredError}
|
1797
|
+
* @memberof DealsApi
|
1798
|
+
*/
|
1799
|
+
deleteManyDealProducts(requestParameters: DealsApiDeleteManyDealProductsRequest): Promise<DeleteManyDealProductResponse>;
|
1689
1800
|
/**
|
1690
1801
|
* Lists discounts attached to a deal.
|
1691
1802
|
* @summary List discounts added to a deal
|