pipedrive 24.1.1 → 25.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/deals-api.d.ts +3 -3
- package/dist/esm/versions/v1/api/deals-api.js +2 -2
- package/dist/esm/versions/v1/api/organizations-api.d.ts +3 -3
- package/dist/esm/versions/v1/api/organizations-api.js +2 -2
- package/dist/esm/versions/v1/api/persons-api.d.ts +3 -3
- package/dist/esm/versions/v1/api/persons-api.js +2 -2
- package/dist/esm/versions/v1/api/subscriptions-api.d.ts +36 -36
- package/dist/esm/versions/v1/api/subscriptions-api.js +36 -36
- package/dist/esm/versions/v1/api/webhooks-api.d.ts +4 -4
- package/dist/esm/versions/v1/api/webhooks-api.js +4 -4
- package/dist/esm/versions/v1/models/add-webhook-request.d.ts +5 -6
- package/dist/esm/versions/v1/models/add-webhook-request.js +4 -5
- package/dist/esm/versions/v1/models/additional-data.d.ts +38 -0
- package/dist/esm/versions/v1/models/additional-data.js +14 -0
- package/dist/esm/versions/v1/models/get-notes-response-additional-data.d.ts +3 -3
- package/dist/esm/versions/v1/models/index.d.ts +1 -1
- package/dist/esm/versions/v1/models/index.js +1 -1
- package/dist/esm/versions/v1/models/user-access.d.ts +3 -2
- package/dist/esm/versions/v1/models/user-access.js +4 -3
- package/dist/esm/versions/v1/models/user-access1.d.ts +3 -2
- package/dist/esm/versions/v1/models/user-access1.js +4 -3
- package/dist/esm/versions/v2/api/activities-api.d.ts +34 -2
- package/dist/esm/versions/v2/api/activities-api.js +25 -5
- package/dist/esm/versions/v2/api/beta-api.d.ts +160 -2424
- package/dist/esm/versions/v2/api/beta-api.js +169 -2788
- package/dist/esm/versions/v2/api/deals-api.d.ts +491 -0
- package/dist/esm/versions/v2/api/deals-api.js +613 -0
- package/dist/esm/versions/v2/api/organizations-api.d.ts +237 -0
- package/dist/esm/versions/v2/api/organizations-api.js +301 -0
- package/dist/esm/versions/v2/api/persons-api.d.ts +237 -0
- package/dist/esm/versions/v2/api/persons-api.js +301 -0
- package/dist/esm/versions/v2/api/products-api.d.ts +237 -0
- package/dist/esm/versions/v2/api/products-api.js +301 -0
- package/dist/esm/versions/v2/api/users-api.d.ts +103 -0
- package/dist/esm/versions/v2/api/users-api.js +140 -0
- package/dist/esm/versions/v2/api.d.ts +1 -0
- package/dist/esm/versions/v2/api.js +1 -0
- package/dist/esm/versions/v2/models/add-ainstallment-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/add-ainstallment-response.js +14 -0
- package/dist/esm/versions/v2/models/add-deal-follower-request.d.ts +23 -0
- package/dist/esm/versions/v2/models/add-deal-follower-request.js +14 -0
- package/dist/esm/versions/v2/models/add-follower-response-all-of.d.ts +24 -0
- package/dist/esm/versions/v2/models/add-follower-response-all-of.js +14 -0
- package/dist/esm/versions/v2/models/add-follower-response.d.ts +18 -0
- package/dist/esm/versions/v2/models/add-follower-response.js +14 -0
- package/dist/esm/versions/v2/models/add-installment-request-body.d.ts +33 -0
- package/dist/esm/versions/v2/models/add-installment-request-body.js +14 -0
- package/dist/esm/versions/v2/models/delete-follower-response-data.d.ts +23 -0
- package/dist/esm/versions/v2/models/delete-follower-response-data.js +14 -0
- package/dist/esm/versions/v2/models/delete-follower-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/delete-follower-response.js +14 -0
- package/dist/esm/versions/v2/models/delete-installment-response-data.d.ts +23 -0
- package/dist/esm/versions/v2/models/delete-installment-response-data.js +14 -0
- package/dist/esm/versions/v2/models/delete-installment-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/delete-installment-response.js +14 -0
- package/dist/esm/versions/v2/models/follower-changelog-item.d.ts +38 -0
- package/dist/esm/versions/v2/models/follower-changelog-item.js +14 -0
- package/dist/esm/versions/v2/models/follower-item.d.ts +28 -0
- package/dist/esm/versions/v2/models/follower-item.js +14 -0
- package/dist/esm/versions/v2/models/follower-item1.d.ts +28 -0
- package/dist/esm/versions/v2/models/follower-item1.js +14 -0
- package/dist/esm/versions/v2/models/get-activities-response-all-of-additional-data.d.ts +23 -0
- package/dist/esm/versions/v2/models/get-activities-response-all-of-additional-data.js +14 -0
- package/dist/esm/versions/v2/models/get-activities-response-all-of.d.ts +6 -0
- package/dist/esm/versions/v2/models/get-deals-response-all-of.d.ts +6 -0
- package/dist/esm/versions/v2/models/get-follower-changelogs-response-all-of.d.ts +30 -0
- package/dist/esm/versions/v2/models/get-follower-changelogs-response-all-of.js +14 -0
- package/dist/esm/versions/v2/models/get-follower-changelogs-response.d.ts +18 -0
- package/dist/esm/versions/v2/models/get-follower-changelogs-response.js +14 -0
- package/dist/esm/versions/v2/models/get-followers-response-all-of.d.ts +30 -0
- package/dist/esm/versions/v2/models/get-followers-response-all-of.js +14 -0
- package/dist/esm/versions/v2/models/get-followers-response.d.ts +18 -0
- package/dist/esm/versions/v2/models/get-followers-response.js +14 -0
- package/dist/esm/versions/v2/models/get-installments-response-data-inner.d.ts +43 -0
- package/dist/esm/versions/v2/models/get-installments-response-data-inner.js +14 -0
- package/dist/esm/versions/v2/models/get-installments-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/get-installments-response.js +14 -0
- package/dist/esm/versions/v2/models/get-organizations-response-all-of.d.ts +6 -0
- package/dist/esm/versions/v2/models/get-persons-response-all-of.d.ts +6 -0
- package/dist/esm/versions/v2/models/get-pipelines-response-all-of.d.ts +6 -0
- package/dist/esm/versions/v2/models/get-stages-response.d.ts +6 -0
- package/dist/esm/versions/v2/models/index.d.ts +21 -0
- package/dist/esm/versions/v2/models/index.js +21 -0
- package/dist/esm/versions/v2/models/update-installment-request-body.d.ts +33 -0
- package/dist/esm/versions/v2/models/update-installment-request-body.js +14 -0
- package/dist/esm/versions/v2/models/update-installment-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/update-installment-response.js +14 -0
- package/dist/versions/v1/api/deals-api.d.ts +3 -3
- package/dist/versions/v1/api/deals-api.js +2 -2
- package/dist/versions/v1/api/organizations-api.d.ts +3 -3
- package/dist/versions/v1/api/organizations-api.js +2 -2
- package/dist/versions/v1/api/persons-api.d.ts +3 -3
- package/dist/versions/v1/api/persons-api.js +2 -2
- package/dist/versions/v1/api/subscriptions-api.d.ts +36 -36
- package/dist/versions/v1/api/subscriptions-api.js +36 -36
- package/dist/versions/v1/api/webhooks-api.d.ts +4 -4
- package/dist/versions/v1/api/webhooks-api.js +4 -4
- package/dist/versions/v1/models/add-webhook-request.d.ts +5 -6
- package/dist/versions/v1/models/add-webhook-request.js +4 -5
- package/dist/versions/v1/models/additional-data.d.ts +38 -0
- package/dist/versions/v1/models/additional-data.js +15 -0
- package/dist/versions/v1/models/get-notes-response-additional-data.d.ts +3 -3
- package/dist/versions/v1/models/index.d.ts +1 -1
- package/dist/versions/v1/models/index.js +1 -1
- package/dist/versions/v1/models/user-access.d.ts +3 -2
- package/dist/versions/v1/models/user-access.js +4 -3
- package/dist/versions/v1/models/user-access1.d.ts +3 -2
- package/dist/versions/v1/models/user-access1.js +4 -3
- package/dist/versions/v2/api/activities-api.d.ts +34 -2
- package/dist/versions/v2/api/activities-api.js +25 -5
- package/dist/versions/v2/api/beta-api.d.ts +160 -2424
- package/dist/versions/v2/api/beta-api.js +171 -2790
- package/dist/versions/v2/api/deals-api.d.ts +491 -0
- package/dist/versions/v2/api/deals-api.js +613 -0
- package/dist/versions/v2/api/organizations-api.d.ts +237 -0
- package/dist/versions/v2/api/organizations-api.js +301 -0
- package/dist/versions/v2/api/persons-api.d.ts +237 -0
- package/dist/versions/v2/api/persons-api.js +301 -0
- package/dist/versions/v2/api/products-api.d.ts +237 -0
- package/dist/versions/v2/api/products-api.js +301 -0
- package/dist/versions/v2/api/users-api.d.ts +103 -0
- package/dist/versions/v2/api/users-api.js +150 -0
- package/dist/versions/v2/api.d.ts +1 -0
- package/dist/versions/v2/api.js +1 -0
- package/dist/versions/v2/models/add-ainstallment-response.d.ts +29 -0
- package/dist/versions/v2/models/add-ainstallment-response.js +15 -0
- package/dist/versions/v2/models/add-deal-follower-request.d.ts +23 -0
- package/dist/versions/v2/models/add-deal-follower-request.js +15 -0
- package/dist/versions/v2/models/add-follower-response-all-of.d.ts +24 -0
- package/dist/versions/v2/models/add-follower-response-all-of.js +15 -0
- package/dist/versions/v2/models/add-follower-response.d.ts +18 -0
- package/dist/versions/v2/models/add-follower-response.js +15 -0
- package/dist/versions/v2/models/add-installment-request-body.d.ts +33 -0
- package/dist/versions/v2/models/add-installment-request-body.js +15 -0
- package/dist/versions/v2/models/delete-follower-response-data.d.ts +23 -0
- package/dist/versions/v2/models/delete-follower-response-data.js +15 -0
- package/dist/versions/v2/models/delete-follower-response.d.ts +29 -0
- package/dist/versions/v2/models/delete-follower-response.js +15 -0
- package/dist/versions/v2/models/delete-installment-response-data.d.ts +23 -0
- package/dist/versions/v2/models/delete-installment-response-data.js +15 -0
- package/dist/versions/v2/models/delete-installment-response.d.ts +29 -0
- package/dist/versions/v2/models/delete-installment-response.js +15 -0
- package/dist/versions/v2/models/follower-changelog-item.d.ts +38 -0
- package/dist/versions/v2/models/follower-changelog-item.js +15 -0
- package/dist/versions/v2/models/follower-item.d.ts +28 -0
- package/dist/versions/v2/models/follower-item.js +15 -0
- package/dist/versions/v2/models/follower-item1.d.ts +28 -0
- package/dist/versions/v2/models/follower-item1.js +15 -0
- package/dist/versions/v2/models/get-activities-response-all-of-additional-data.d.ts +23 -0
- package/dist/versions/v2/models/get-activities-response-all-of-additional-data.js +15 -0
- package/dist/versions/v2/models/get-activities-response-all-of.d.ts +6 -0
- package/dist/versions/v2/models/get-deals-response-all-of.d.ts +6 -0
- package/dist/versions/v2/models/get-follower-changelogs-response-all-of.d.ts +30 -0
- package/dist/versions/v2/models/get-follower-changelogs-response-all-of.js +15 -0
- package/dist/versions/v2/models/get-follower-changelogs-response.d.ts +18 -0
- package/dist/versions/v2/models/get-follower-changelogs-response.js +15 -0
- package/dist/versions/v2/models/get-followers-response-all-of.d.ts +30 -0
- package/dist/versions/v2/models/get-followers-response-all-of.js +15 -0
- package/dist/versions/v2/models/get-followers-response.d.ts +18 -0
- package/dist/versions/v2/models/get-followers-response.js +15 -0
- package/dist/versions/v2/models/get-installments-response-data-inner.d.ts +43 -0
- package/dist/versions/v2/models/get-installments-response-data-inner.js +15 -0
- package/dist/versions/v2/models/get-installments-response.d.ts +29 -0
- package/dist/versions/v2/models/get-installments-response.js +15 -0
- package/dist/versions/v2/models/get-organizations-response-all-of.d.ts +6 -0
- package/dist/versions/v2/models/get-persons-response-all-of.d.ts +6 -0
- package/dist/versions/v2/models/get-pipelines-response-all-of.d.ts +6 -0
- package/dist/versions/v2/models/get-stages-response.d.ts +6 -0
- package/dist/versions/v2/models/index.d.ts +21 -0
- package/dist/versions/v2/models/index.js +21 -0
- package/dist/versions/v2/models/update-installment-request-body.d.ts +33 -0
- package/dist/versions/v2/models/update-installment-request-body.js +15 -0
- package/dist/versions/v2/models/update-installment-response.d.ts +29 -0
- package/dist/versions/v2/models/update-installment-response.js +15 -0
- package/package.json +1 -1
@@ -12,22 +12,33 @@
|
|
12
12
|
import type { Configuration } from '../configuration';
|
13
13
|
import type { AxiosInstance } from 'axios';
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
15
|
+
import { AddAInstallmentResponse } from '../models';
|
15
16
|
import { AddAdditionalDiscountRequestBody } from '../models';
|
16
17
|
import { AddAdditionalDiscountResponse } from '../models';
|
18
|
+
import { AddDealFollowerRequest } from '../models';
|
17
19
|
import { AddDealProductRequest } from '../models';
|
18
20
|
import { AddDealProductResponse } from '../models';
|
19
21
|
import { AddDealRequest } from '../models';
|
22
|
+
import { AddFollowerResponse } from '../models';
|
23
|
+
import { AddInstallmentRequestBody } from '../models';
|
20
24
|
import { DeleteAdditionalDiscountResponse } from '../models';
|
21
25
|
import { DeleteDealProductResponse } from '../models';
|
22
26
|
import { DeleteDealResponse } from '../models';
|
27
|
+
import { DeleteFollowerResponse } from '../models';
|
28
|
+
import { DeleteInstallmentResponse } from '../models';
|
23
29
|
import { GetAdditionalDiscountsResponse } from '../models';
|
24
30
|
import { GetDealSearchResponse } from '../models';
|
25
31
|
import { GetDealsProductsResponse } from '../models';
|
26
32
|
import { GetDealsResponse } from '../models';
|
33
|
+
import { GetFollowerChangelogsResponse } from '../models';
|
34
|
+
import { GetFollowersResponse } from '../models';
|
35
|
+
import { GetInstallmentsResponse } from '../models';
|
27
36
|
import { UpdateAdditionalDiscountRequestBody } from '../models';
|
28
37
|
import { UpdateAdditionalDiscountResponse } from '../models';
|
29
38
|
import { UpdateDealProductRequest } from '../models';
|
30
39
|
import { UpdateDealRequest } from '../models';
|
40
|
+
import { UpdateInstallmentRequestBody } from '../models';
|
41
|
+
import { UpdateInstallmentResponse } from '../models';
|
31
42
|
import { UpsertDealResponse } from '../models';
|
32
43
|
/**
|
33
44
|
* DealsApi - axios parameter creator
|
@@ -42,6 +53,15 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
42
53
|
* @throws {RequiredError}
|
43
54
|
*/
|
44
55
|
addDeal: (AddDealRequest?: AddDealRequest) => Promise<RequestArgs>;
|
56
|
+
/**
|
57
|
+
* Adds a user as a follower to the deal.
|
58
|
+
* @summary Add a follower to a deal
|
59
|
+
* @param {number} id The ID of the deal
|
60
|
+
* @param {AddDealFollowerRequest} [AddDealFollowerRequest]
|
61
|
+
|
62
|
+
* @throws {RequiredError}
|
63
|
+
*/
|
64
|
+
addDealFollower: (id: number, AddDealFollowerRequest?: AddDealFollowerRequest) => Promise<RequestArgs>;
|
45
65
|
/**
|
46
66
|
* Adds a product to a deal, creating a new item called a deal-product.
|
47
67
|
* @summary Add a product to a deal
|
@@ -68,6 +88,15 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
68
88
|
* @throws {RequiredError}
|
69
89
|
*/
|
70
90
|
deleteDeal: (id: number) => Promise<RequestArgs>;
|
91
|
+
/**
|
92
|
+
* Deletes a user follower from the deal.
|
93
|
+
* @summary Delete a follower from a deal
|
94
|
+
* @param {number} id The ID of the deal
|
95
|
+
* @param {number} follower_id The ID of the following user
|
96
|
+
|
97
|
+
* @throws {RequiredError}
|
98
|
+
*/
|
99
|
+
deleteDealFollower: (id: number, follower_id: number) => Promise<RequestArgs>;
|
71
100
|
/**
|
72
101
|
* Deletes a product attachment from a deal, using the `product_attachment_id`.
|
73
102
|
* @summary Delete an attached product from a deal
|
@@ -77,6 +106,15 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
77
106
|
* @throws {RequiredError}
|
78
107
|
*/
|
79
108
|
deleteDealProduct: (id: number, product_attachment_id: number) => Promise<RequestArgs>;
|
109
|
+
/**
|
110
|
+
* Removes an installment from a deal. Only available in Advanced and above plans.
|
111
|
+
* @summary Delete an installment from a deal
|
112
|
+
* @param {number} id The ID of the deal
|
113
|
+
* @param {number} installment_id The ID of the installment
|
114
|
+
|
115
|
+
* @throws {RequiredError}
|
116
|
+
*/
|
117
|
+
deleteInstallment: (id: number, installment_id: number) => Promise<RequestArgs>;
|
80
118
|
/**
|
81
119
|
* Lists discounts attached to a deal.
|
82
120
|
* @summary List discounts added to a deal
|
@@ -95,6 +133,26 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
95
133
|
* @throws {RequiredError}
|
96
134
|
*/
|
97
135
|
getDeal: (id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time', custom_fields?: string) => Promise<RequestArgs>;
|
136
|
+
/**
|
137
|
+
* Lists users who are following the deal.
|
138
|
+
* @summary List followers of a deal
|
139
|
+
* @param {number} id The ID of the deal
|
140
|
+
* @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.
|
141
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
142
|
+
|
143
|
+
* @throws {RequiredError}
|
144
|
+
*/
|
145
|
+
getDealFollowers: (id: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
146
|
+
/**
|
147
|
+
* Lists changelogs about users have followed the deal.
|
148
|
+
* @summary List followers changelog of a deal
|
149
|
+
* @param {number} id The ID of the deal
|
150
|
+
* @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.
|
151
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
152
|
+
|
153
|
+
* @throws {RequiredError}
|
154
|
+
*/
|
155
|
+
getDealFollowersChangelog: (id: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
98
156
|
/**
|
99
157
|
* Lists products attached to a deal.
|
100
158
|
* @summary List products attached to a deal
|
@@ -142,6 +200,18 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
142
200
|
* @throws {RequiredError}
|
143
201
|
*/
|
144
202
|
getDealsProducts: (deal_ids: Array<number>, cursor?: string, limit?: number, sort_by?: 'id' | 'deal_id' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc') => Promise<RequestArgs>;
|
203
|
+
/**
|
204
|
+
* Lists installments attached to a list of deals. Only available in Advanced and above plans.
|
205
|
+
* @summary List installments added to a list of deals
|
206
|
+
* @param {Array<number>} deal_ids An array of integers with the IDs of the deals for which the attached installments will be returned. A maximum of 100 deal IDs can be provided.
|
207
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
208
|
+
* @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.
|
209
|
+
* @param {'id' | 'billing_date' | 'deal_id'} [sort_by] The field to sort by. Supported fields: `id`, `billing_date`, `deal_id`.
|
210
|
+
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
211
|
+
|
212
|
+
* @throws {RequiredError}
|
213
|
+
*/
|
214
|
+
getInstallments: (deal_ids: Array<number>, cursor?: string, limit?: number, sort_by?: 'id' | 'billing_date' | 'deal_id', sort_direction?: 'asc' | 'desc') => Promise<RequestArgs>;
|
145
215
|
/**
|
146
216
|
* Adds a discount to a deal changing, the deal value if the deal has one-time products attached.
|
147
217
|
* @summary Add a discount to a deal
|
@@ -151,6 +221,15 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
151
221
|
* @throws {RequiredError}
|
152
222
|
*/
|
153
223
|
postAdditionalDiscount: (id: number, AddAdditionalDiscountRequestBody?: AddAdditionalDiscountRequestBody) => Promise<RequestArgs>;
|
224
|
+
/**
|
225
|
+
* Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Advanced and above plans.
|
226
|
+
* @summary Add an installment to a deal
|
227
|
+
* @param {number} id The ID of the deal
|
228
|
+
* @param {AddInstallmentRequestBody} [AddInstallmentRequestBody]
|
229
|
+
|
230
|
+
* @throws {RequiredError}
|
231
|
+
*/
|
232
|
+
postInstallment: (id: number, AddInstallmentRequestBody?: AddInstallmentRequestBody) => Promise<RequestArgs>;
|
154
233
|
/**
|
155
234
|
* Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID.
|
156
235
|
* @summary Search deals
|
@@ -196,6 +275,16 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
196
275
|
* @throws {RequiredError}
|
197
276
|
*/
|
198
277
|
updateDealProduct: (id: number, product_attachment_id: number, UpdateDealProductRequest?: UpdateDealProductRequest) => Promise<RequestArgs>;
|
278
|
+
/**
|
279
|
+
* Edits an installment added to a deal. Only available in Advanced and above plans.
|
280
|
+
* @summary Update an installment added to a deal
|
281
|
+
* @param {number} id The ID of the deal
|
282
|
+
* @param {number} installment_id The ID of the installment
|
283
|
+
* @param {UpdateInstallmentRequestBody} [UpdateInstallmentRequestBody]
|
284
|
+
|
285
|
+
* @throws {RequiredError}
|
286
|
+
*/
|
287
|
+
updateInstallment: (id: number, installment_id: number, UpdateInstallmentRequestBody?: UpdateInstallmentRequestBody) => Promise<RequestArgs>;
|
199
288
|
};
|
200
289
|
/**
|
201
290
|
* DealsApi - functional programming interface
|
@@ -210,6 +299,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
210
299
|
* @throws {RequiredError}
|
211
300
|
*/
|
212
301
|
addDeal(AddDealRequest?: AddDealRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertDealResponse>>;
|
302
|
+
/**
|
303
|
+
* Adds a user as a follower to the deal.
|
304
|
+
* @summary Add a follower to a deal
|
305
|
+
* @param {number} id The ID of the deal
|
306
|
+
* @param {AddDealFollowerRequest} [AddDealFollowerRequest]
|
307
|
+
|
308
|
+
* @throws {RequiredError}
|
309
|
+
*/
|
310
|
+
addDealFollower(id: number, AddDealFollowerRequest?: AddDealFollowerRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddFollowerResponse>>;
|
213
311
|
/**
|
214
312
|
* Adds a product to a deal, creating a new item called a deal-product.
|
215
313
|
* @summary Add a product to a deal
|
@@ -236,6 +334,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
236
334
|
* @throws {RequiredError}
|
237
335
|
*/
|
238
336
|
deleteDeal(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteDealResponse>>;
|
337
|
+
/**
|
338
|
+
* Deletes a user follower from the deal.
|
339
|
+
* @summary Delete a follower from a deal
|
340
|
+
* @param {number} id The ID of the deal
|
341
|
+
* @param {number} follower_id The ID of the following user
|
342
|
+
|
343
|
+
* @throws {RequiredError}
|
344
|
+
*/
|
345
|
+
deleteDealFollower(id: number, follower_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteFollowerResponse>>;
|
239
346
|
/**
|
240
347
|
* Deletes a product attachment from a deal, using the `product_attachment_id`.
|
241
348
|
* @summary Delete an attached product from a deal
|
@@ -245,6 +352,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
245
352
|
* @throws {RequiredError}
|
246
353
|
*/
|
247
354
|
deleteDealProduct(id: number, product_attachment_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteDealProductResponse>>;
|
355
|
+
/**
|
356
|
+
* Removes an installment from a deal. Only available in Advanced and above plans.
|
357
|
+
* @summary Delete an installment from a deal
|
358
|
+
* @param {number} id The ID of the deal
|
359
|
+
* @param {number} installment_id The ID of the installment
|
360
|
+
|
361
|
+
* @throws {RequiredError}
|
362
|
+
*/
|
363
|
+
deleteInstallment(id: number, installment_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteInstallmentResponse>>;
|
248
364
|
/**
|
249
365
|
* Lists discounts attached to a deal.
|
250
366
|
* @summary List discounts added to a deal
|
@@ -263,6 +379,26 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
263
379
|
* @throws {RequiredError}
|
264
380
|
*/
|
265
381
|
getDeal(id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time', custom_fields?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertDealResponse>>;
|
382
|
+
/**
|
383
|
+
* Lists users who are following the deal.
|
384
|
+
* @summary List followers of a deal
|
385
|
+
* @param {number} id The ID of the deal
|
386
|
+
* @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.
|
387
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
388
|
+
|
389
|
+
* @throws {RequiredError}
|
390
|
+
*/
|
391
|
+
getDealFollowers(id: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFollowersResponse>>;
|
392
|
+
/**
|
393
|
+
* Lists changelogs about users have followed the deal.
|
394
|
+
* @summary List followers changelog of a deal
|
395
|
+
* @param {number} id The ID of the deal
|
396
|
+
* @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.
|
397
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
398
|
+
|
399
|
+
* @throws {RequiredError}
|
400
|
+
*/
|
401
|
+
getDealFollowersChangelog(id: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFollowerChangelogsResponse>>;
|
266
402
|
/**
|
267
403
|
* Lists products attached to a deal.
|
268
404
|
* @summary List products attached to a deal
|
@@ -310,6 +446,18 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
310
446
|
* @throws {RequiredError}
|
311
447
|
*/
|
312
448
|
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>>;
|
449
|
+
/**
|
450
|
+
* Lists installments attached to a list of deals. Only available in Advanced and above plans.
|
451
|
+
* @summary List installments added to a list of deals
|
452
|
+
* @param {Array<number>} deal_ids An array of integers with the IDs of the deals for which the attached installments will be returned. A maximum of 100 deal IDs can be provided.
|
453
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
454
|
+
* @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.
|
455
|
+
* @param {'id' | 'billing_date' | 'deal_id'} [sort_by] The field to sort by. Supported fields: `id`, `billing_date`, `deal_id`.
|
456
|
+
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
457
|
+
|
458
|
+
* @throws {RequiredError}
|
459
|
+
*/
|
460
|
+
getInstallments(deal_ids: Array<number>, cursor?: string, limit?: number, sort_by?: 'id' | 'billing_date' | 'deal_id', sort_direction?: 'asc' | 'desc'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetInstallmentsResponse>>;
|
313
461
|
/**
|
314
462
|
* Adds a discount to a deal changing, the deal value if the deal has one-time products attached.
|
315
463
|
* @summary Add a discount to a deal
|
@@ -319,6 +467,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
319
467
|
* @throws {RequiredError}
|
320
468
|
*/
|
321
469
|
postAdditionalDiscount(id: number, AddAdditionalDiscountRequestBody?: AddAdditionalDiscountRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddAdditionalDiscountResponse>>;
|
470
|
+
/**
|
471
|
+
* Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Advanced and above plans.
|
472
|
+
* @summary Add an installment to a deal
|
473
|
+
* @param {number} id The ID of the deal
|
474
|
+
* @param {AddInstallmentRequestBody} [AddInstallmentRequestBody]
|
475
|
+
|
476
|
+
* @throws {RequiredError}
|
477
|
+
*/
|
478
|
+
postInstallment(id: number, AddInstallmentRequestBody?: AddInstallmentRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddAInstallmentResponse>>;
|
322
479
|
/**
|
323
480
|
* Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID.
|
324
481
|
* @summary Search deals
|
@@ -364,6 +521,16 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
364
521
|
* @throws {RequiredError}
|
365
522
|
*/
|
366
523
|
updateDealProduct(id: number, product_attachment_id: number, UpdateDealProductRequest?: UpdateDealProductRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealProductResponse>>;
|
524
|
+
/**
|
525
|
+
* Edits an installment added to a deal. Only available in Advanced and above plans.
|
526
|
+
* @summary Update an installment added to a deal
|
527
|
+
* @param {number} id The ID of the deal
|
528
|
+
* @param {number} installment_id The ID of the installment
|
529
|
+
* @param {UpdateInstallmentRequestBody} [UpdateInstallmentRequestBody]
|
530
|
+
|
531
|
+
* @throws {RequiredError}
|
532
|
+
*/
|
533
|
+
updateInstallment(id: number, installment_id: number, UpdateInstallmentRequestBody?: UpdateInstallmentRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpdateInstallmentResponse>>;
|
367
534
|
};
|
368
535
|
/**
|
369
536
|
* DealsApi - factory interface
|
@@ -378,6 +545,14 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
378
545
|
* @throws {RequiredError}
|
379
546
|
*/
|
380
547
|
addDeal(requestParameters?: DealsApiAddDealRequest): Promise<UpsertDealResponse>;
|
548
|
+
/**
|
549
|
+
* Adds a user as a follower to the deal.
|
550
|
+
* @summary Add a follower to a deal
|
551
|
+
* @param {DealsApiAddDealFollowerRequest} requestParameters Request parameters.
|
552
|
+
|
553
|
+
* @throws {RequiredError}
|
554
|
+
*/
|
555
|
+
addDealFollower(requestParameters: DealsApiAddDealFollowerRequest): Promise<AddFollowerResponse>;
|
381
556
|
/**
|
382
557
|
* Adds a product to a deal, creating a new item called a deal-product.
|
383
558
|
* @summary Add a product to a deal
|
@@ -402,6 +577,14 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
402
577
|
* @throws {RequiredError}
|
403
578
|
*/
|
404
579
|
deleteDeal(requestParameters: DealsApiDeleteDealRequest): Promise<DeleteDealResponse>;
|
580
|
+
/**
|
581
|
+
* Deletes a user follower from the deal.
|
582
|
+
* @summary Delete a follower from a deal
|
583
|
+
* @param {DealsApiDeleteDealFollowerRequest} requestParameters Request parameters.
|
584
|
+
|
585
|
+
* @throws {RequiredError}
|
586
|
+
*/
|
587
|
+
deleteDealFollower(requestParameters: DealsApiDeleteDealFollowerRequest): Promise<DeleteFollowerResponse>;
|
405
588
|
/**
|
406
589
|
* Deletes a product attachment from a deal, using the `product_attachment_id`.
|
407
590
|
* @summary Delete an attached product from a deal
|
@@ -410,6 +593,14 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
410
593
|
* @throws {RequiredError}
|
411
594
|
*/
|
412
595
|
deleteDealProduct(requestParameters: DealsApiDeleteDealProductRequest): Promise<DeleteDealProductResponse>;
|
596
|
+
/**
|
597
|
+
* Removes an installment from a deal. Only available in Advanced and above plans.
|
598
|
+
* @summary Delete an installment from a deal
|
599
|
+
* @param {DealsApiDeleteInstallmentRequest} requestParameters Request parameters.
|
600
|
+
|
601
|
+
* @throws {RequiredError}
|
602
|
+
*/
|
603
|
+
deleteInstallment(requestParameters: DealsApiDeleteInstallmentRequest): Promise<DeleteInstallmentResponse>;
|
413
604
|
/**
|
414
605
|
* Lists discounts attached to a deal.
|
415
606
|
* @summary List discounts added to a deal
|
@@ -426,6 +617,22 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
426
617
|
* @throws {RequiredError}
|
427
618
|
*/
|
428
619
|
getDeal(requestParameters: DealsApiGetDealRequest): Promise<UpsertDealResponse>;
|
620
|
+
/**
|
621
|
+
* Lists users who are following the deal.
|
622
|
+
* @summary List followers of a deal
|
623
|
+
* @param {DealsApiGetDealFollowersRequest} requestParameters Request parameters.
|
624
|
+
|
625
|
+
* @throws {RequiredError}
|
626
|
+
*/
|
627
|
+
getDealFollowers(requestParameters: DealsApiGetDealFollowersRequest): Promise<GetFollowersResponse>;
|
628
|
+
/**
|
629
|
+
* Lists changelogs about users have followed the deal.
|
630
|
+
* @summary List followers changelog of a deal
|
631
|
+
* @param {DealsApiGetDealFollowersChangelogRequest} requestParameters Request parameters.
|
632
|
+
|
633
|
+
* @throws {RequiredError}
|
634
|
+
*/
|
635
|
+
getDealFollowersChangelog(requestParameters: DealsApiGetDealFollowersChangelogRequest): Promise<GetFollowerChangelogsResponse>;
|
429
636
|
/**
|
430
637
|
* Lists products attached to a deal.
|
431
638
|
* @summary List products attached to a deal
|
@@ -450,6 +657,14 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
450
657
|
* @throws {RequiredError}
|
451
658
|
*/
|
452
659
|
getDealsProducts(requestParameters: DealsApiGetDealsProductsRequest): Promise<GetDealsProductsResponse>;
|
660
|
+
/**
|
661
|
+
* Lists installments attached to a list of deals. Only available in Advanced and above plans.
|
662
|
+
* @summary List installments added to a list of deals
|
663
|
+
* @param {DealsApiGetInstallmentsRequest} requestParameters Request parameters.
|
664
|
+
|
665
|
+
* @throws {RequiredError}
|
666
|
+
*/
|
667
|
+
getInstallments(requestParameters: DealsApiGetInstallmentsRequest): Promise<GetInstallmentsResponse>;
|
453
668
|
/**
|
454
669
|
* Adds a discount to a deal changing, the deal value if the deal has one-time products attached.
|
455
670
|
* @summary Add a discount to a deal
|
@@ -458,6 +673,14 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
458
673
|
* @throws {RequiredError}
|
459
674
|
*/
|
460
675
|
postAdditionalDiscount(requestParameters: DealsApiPostAdditionalDiscountRequest): Promise<AddAdditionalDiscountResponse>;
|
676
|
+
/**
|
677
|
+
* Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Advanced and above plans.
|
678
|
+
* @summary Add an installment to a deal
|
679
|
+
* @param {DealsApiPostInstallmentRequest} requestParameters Request parameters.
|
680
|
+
|
681
|
+
* @throws {RequiredError}
|
682
|
+
*/
|
683
|
+
postInstallment(requestParameters: DealsApiPostInstallmentRequest): Promise<AddAInstallmentResponse>;
|
461
684
|
/**
|
462
685
|
* Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID.
|
463
686
|
* @summary Search deals
|
@@ -490,6 +713,14 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
490
713
|
* @throws {RequiredError}
|
491
714
|
*/
|
492
715
|
updateDealProduct(requestParameters: DealsApiUpdateDealProductRequest): Promise<AddDealProductResponse>;
|
716
|
+
/**
|
717
|
+
* Edits an installment added to a deal. Only available in Advanced and above plans.
|
718
|
+
* @summary Update an installment added to a deal
|
719
|
+
* @param {DealsApiUpdateInstallmentRequest} requestParameters Request parameters.
|
720
|
+
|
721
|
+
* @throws {RequiredError}
|
722
|
+
*/
|
723
|
+
updateInstallment(requestParameters: DealsApiUpdateInstallmentRequest): Promise<UpdateInstallmentResponse>;
|
493
724
|
};
|
494
725
|
/**
|
495
726
|
* Request parameters for addDeal operation in DealsApi.
|
@@ -504,6 +735,25 @@ export interface DealsApiAddDealRequest {
|
|
504
735
|
*/
|
505
736
|
readonly AddDealRequest?: AddDealRequest;
|
506
737
|
}
|
738
|
+
/**
|
739
|
+
* Request parameters for addDealFollower operation in DealsApi.
|
740
|
+
* @export
|
741
|
+
* @interface DealsApiAddDealFollowerRequest
|
742
|
+
*/
|
743
|
+
export interface DealsApiAddDealFollowerRequest {
|
744
|
+
/**
|
745
|
+
* The ID of the deal
|
746
|
+
* @type {number}
|
747
|
+
* @memberof DealsApiAddDealFollower
|
748
|
+
*/
|
749
|
+
readonly id: number;
|
750
|
+
/**
|
751
|
+
*
|
752
|
+
* @type {AddDealFollowerRequest}
|
753
|
+
* @memberof DealsApiAddDealFollower
|
754
|
+
*/
|
755
|
+
readonly AddDealFollowerRequest?: AddDealFollowerRequest;
|
756
|
+
}
|
507
757
|
/**
|
508
758
|
* Request parameters for addDealProduct operation in DealsApi.
|
509
759
|
* @export
|
@@ -555,6 +805,25 @@ export interface DealsApiDeleteDealRequest {
|
|
555
805
|
*/
|
556
806
|
readonly id: number;
|
557
807
|
}
|
808
|
+
/**
|
809
|
+
* Request parameters for deleteDealFollower operation in DealsApi.
|
810
|
+
* @export
|
811
|
+
* @interface DealsApiDeleteDealFollowerRequest
|
812
|
+
*/
|
813
|
+
export interface DealsApiDeleteDealFollowerRequest {
|
814
|
+
/**
|
815
|
+
* The ID of the deal
|
816
|
+
* @type {number}
|
817
|
+
* @memberof DealsApiDeleteDealFollower
|
818
|
+
*/
|
819
|
+
readonly id: number;
|
820
|
+
/**
|
821
|
+
* The ID of the following user
|
822
|
+
* @type {number}
|
823
|
+
* @memberof DealsApiDeleteDealFollower
|
824
|
+
*/
|
825
|
+
readonly follower_id: number;
|
826
|
+
}
|
558
827
|
/**
|
559
828
|
* Request parameters for deleteDealProduct operation in DealsApi.
|
560
829
|
* @export
|
@@ -574,6 +843,25 @@ export interface DealsApiDeleteDealProductRequest {
|
|
574
843
|
*/
|
575
844
|
readonly product_attachment_id: number;
|
576
845
|
}
|
846
|
+
/**
|
847
|
+
* Request parameters for deleteInstallment operation in DealsApi.
|
848
|
+
* @export
|
849
|
+
* @interface DealsApiDeleteInstallmentRequest
|
850
|
+
*/
|
851
|
+
export interface DealsApiDeleteInstallmentRequest {
|
852
|
+
/**
|
853
|
+
* The ID of the deal
|
854
|
+
* @type {number}
|
855
|
+
* @memberof DealsApiDeleteInstallment
|
856
|
+
*/
|
857
|
+
readonly id: number;
|
858
|
+
/**
|
859
|
+
* The ID of the installment
|
860
|
+
* @type {number}
|
861
|
+
* @memberof DealsApiDeleteInstallment
|
862
|
+
*/
|
863
|
+
readonly installment_id: number;
|
864
|
+
}
|
577
865
|
/**
|
578
866
|
* Request parameters for getAdditionalDiscounts operation in DealsApi.
|
579
867
|
* @export
|
@@ -612,6 +900,56 @@ export interface DealsApiGetDealRequest {
|
|
612
900
|
*/
|
613
901
|
readonly custom_fields?: string;
|
614
902
|
}
|
903
|
+
/**
|
904
|
+
* Request parameters for getDealFollowers operation in DealsApi.
|
905
|
+
* @export
|
906
|
+
* @interface DealsApiGetDealFollowersRequest
|
907
|
+
*/
|
908
|
+
export interface DealsApiGetDealFollowersRequest {
|
909
|
+
/**
|
910
|
+
* The ID of the deal
|
911
|
+
* @type {number}
|
912
|
+
* @memberof DealsApiGetDealFollowers
|
913
|
+
*/
|
914
|
+
readonly id: number;
|
915
|
+
/**
|
916
|
+
* 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.
|
917
|
+
* @type {number}
|
918
|
+
* @memberof DealsApiGetDealFollowers
|
919
|
+
*/
|
920
|
+
readonly limit?: number;
|
921
|
+
/**
|
922
|
+
* For pagination, the marker (an opaque string value) representing the first item on the next page
|
923
|
+
* @type {string}
|
924
|
+
* @memberof DealsApiGetDealFollowers
|
925
|
+
*/
|
926
|
+
readonly cursor?: string;
|
927
|
+
}
|
928
|
+
/**
|
929
|
+
* Request parameters for getDealFollowersChangelog operation in DealsApi.
|
930
|
+
* @export
|
931
|
+
* @interface DealsApiGetDealFollowersChangelogRequest
|
932
|
+
*/
|
933
|
+
export interface DealsApiGetDealFollowersChangelogRequest {
|
934
|
+
/**
|
935
|
+
* The ID of the deal
|
936
|
+
* @type {number}
|
937
|
+
* @memberof DealsApiGetDealFollowersChangelog
|
938
|
+
*/
|
939
|
+
readonly id: number;
|
940
|
+
/**
|
941
|
+
* 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.
|
942
|
+
* @type {number}
|
943
|
+
* @memberof DealsApiGetDealFollowersChangelog
|
944
|
+
*/
|
945
|
+
readonly limit?: number;
|
946
|
+
/**
|
947
|
+
* For pagination, the marker (an opaque string value) representing the first item on the next page
|
948
|
+
* @type {string}
|
949
|
+
* @memberof DealsApiGetDealFollowersChangelog
|
950
|
+
*/
|
951
|
+
readonly cursor?: string;
|
952
|
+
}
|
615
953
|
/**
|
616
954
|
* Request parameters for getDealProducts operation in DealsApi.
|
617
955
|
* @export
|
@@ -789,6 +1127,43 @@ export interface DealsApiGetDealsProductsRequest {
|
|
789
1127
|
*/
|
790
1128
|
readonly sort_direction?: 'asc' | 'desc';
|
791
1129
|
}
|
1130
|
+
/**
|
1131
|
+
* Request parameters for getInstallments operation in DealsApi.
|
1132
|
+
* @export
|
1133
|
+
* @interface DealsApiGetInstallmentsRequest
|
1134
|
+
*/
|
1135
|
+
export interface DealsApiGetInstallmentsRequest {
|
1136
|
+
/**
|
1137
|
+
* An array of integers with the IDs of the deals for which the attached installments will be returned. A maximum of 100 deal IDs can be provided.
|
1138
|
+
* @type {Array<number>}
|
1139
|
+
* @memberof DealsApiGetInstallments
|
1140
|
+
*/
|
1141
|
+
readonly deal_ids: Array<number>;
|
1142
|
+
/**
|
1143
|
+
* For pagination, the marker (an opaque string value) representing the first item on the next page
|
1144
|
+
* @type {string}
|
1145
|
+
* @memberof DealsApiGetInstallments
|
1146
|
+
*/
|
1147
|
+
readonly cursor?: string;
|
1148
|
+
/**
|
1149
|
+
* 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.
|
1150
|
+
* @type {number}
|
1151
|
+
* @memberof DealsApiGetInstallments
|
1152
|
+
*/
|
1153
|
+
readonly limit?: number;
|
1154
|
+
/**
|
1155
|
+
* The field to sort by. Supported fields: `id`, `billing_date`, `deal_id`.
|
1156
|
+
* @type {'id' | 'billing_date' | 'deal_id'}
|
1157
|
+
* @memberof DealsApiGetInstallments
|
1158
|
+
*/
|
1159
|
+
readonly sort_by?: 'id' | 'billing_date' | 'deal_id';
|
1160
|
+
/**
|
1161
|
+
* The sorting direction. Supported values: `asc`, `desc`.
|
1162
|
+
* @type {'asc' | 'desc'}
|
1163
|
+
* @memberof DealsApiGetInstallments
|
1164
|
+
*/
|
1165
|
+
readonly sort_direction?: 'asc' | 'desc';
|
1166
|
+
}
|
792
1167
|
/**
|
793
1168
|
* Request parameters for postAdditionalDiscount operation in DealsApi.
|
794
1169
|
* @export
|
@@ -808,6 +1183,25 @@ export interface DealsApiPostAdditionalDiscountRequest {
|
|
808
1183
|
*/
|
809
1184
|
readonly AddAdditionalDiscountRequestBody?: AddAdditionalDiscountRequestBody;
|
810
1185
|
}
|
1186
|
+
/**
|
1187
|
+
* Request parameters for postInstallment operation in DealsApi.
|
1188
|
+
* @export
|
1189
|
+
* @interface DealsApiPostInstallmentRequest
|
1190
|
+
*/
|
1191
|
+
export interface DealsApiPostInstallmentRequest {
|
1192
|
+
/**
|
1193
|
+
* The ID of the deal
|
1194
|
+
* @type {number}
|
1195
|
+
* @memberof DealsApiPostInstallment
|
1196
|
+
*/
|
1197
|
+
readonly id: number;
|
1198
|
+
/**
|
1199
|
+
*
|
1200
|
+
* @type {AddInstallmentRequestBody}
|
1201
|
+
* @memberof DealsApiPostInstallment
|
1202
|
+
*/
|
1203
|
+
readonly AddInstallmentRequestBody?: AddInstallmentRequestBody;
|
1204
|
+
}
|
811
1205
|
/**
|
812
1206
|
* Request parameters for searchDeals operation in DealsApi.
|
813
1207
|
* @export
|
@@ -938,6 +1332,31 @@ export interface DealsApiUpdateDealProductRequest {
|
|
938
1332
|
*/
|
939
1333
|
readonly UpdateDealProductRequest?: UpdateDealProductRequest;
|
940
1334
|
}
|
1335
|
+
/**
|
1336
|
+
* Request parameters for updateInstallment operation in DealsApi.
|
1337
|
+
* @export
|
1338
|
+
* @interface DealsApiUpdateInstallmentRequest
|
1339
|
+
*/
|
1340
|
+
export interface DealsApiUpdateInstallmentRequest {
|
1341
|
+
/**
|
1342
|
+
* The ID of the deal
|
1343
|
+
* @type {number}
|
1344
|
+
* @memberof DealsApiUpdateInstallment
|
1345
|
+
*/
|
1346
|
+
readonly id: number;
|
1347
|
+
/**
|
1348
|
+
* The ID of the installment
|
1349
|
+
* @type {number}
|
1350
|
+
* @memberof DealsApiUpdateInstallment
|
1351
|
+
*/
|
1352
|
+
readonly installment_id: number;
|
1353
|
+
/**
|
1354
|
+
*
|
1355
|
+
* @type {UpdateInstallmentRequestBody}
|
1356
|
+
* @memberof DealsApiUpdateInstallment
|
1357
|
+
*/
|
1358
|
+
readonly UpdateInstallmentRequestBody?: UpdateInstallmentRequestBody;
|
1359
|
+
}
|
941
1360
|
/**
|
942
1361
|
* DealsApi - object-oriented interface
|
943
1362
|
* @export
|
@@ -954,6 +1373,15 @@ export declare class DealsApi extends BaseAPI {
|
|
954
1373
|
* @memberof DealsApi
|
955
1374
|
*/
|
956
1375
|
addDeal(requestParameters?: DealsApiAddDealRequest): Promise<UpsertDealResponse>;
|
1376
|
+
/**
|
1377
|
+
* Adds a user as a follower to the deal.
|
1378
|
+
* @summary Add a follower to a deal
|
1379
|
+
* @param {DealsApiAddDealFollowerRequest} requestParameters Request parameters.
|
1380
|
+
|
1381
|
+
* @throws {RequiredError}
|
1382
|
+
* @memberof DealsApi
|
1383
|
+
*/
|
1384
|
+
addDealFollower(requestParameters: DealsApiAddDealFollowerRequest): Promise<AddFollowerResponse>;
|
957
1385
|
/**
|
958
1386
|
* Adds a product to a deal, creating a new item called a deal-product.
|
959
1387
|
* @summary Add a product to a deal
|
@@ -981,6 +1409,15 @@ export declare class DealsApi extends BaseAPI {
|
|
981
1409
|
* @memberof DealsApi
|
982
1410
|
*/
|
983
1411
|
deleteDeal(requestParameters: DealsApiDeleteDealRequest): Promise<DeleteDealResponse>;
|
1412
|
+
/**
|
1413
|
+
* Deletes a user follower from the deal.
|
1414
|
+
* @summary Delete a follower from a deal
|
1415
|
+
* @param {DealsApiDeleteDealFollowerRequest} requestParameters Request parameters.
|
1416
|
+
|
1417
|
+
* @throws {RequiredError}
|
1418
|
+
* @memberof DealsApi
|
1419
|
+
*/
|
1420
|
+
deleteDealFollower(requestParameters: DealsApiDeleteDealFollowerRequest): Promise<DeleteFollowerResponse>;
|
984
1421
|
/**
|
985
1422
|
* Deletes a product attachment from a deal, using the `product_attachment_id`.
|
986
1423
|
* @summary Delete an attached product from a deal
|
@@ -990,6 +1427,15 @@ export declare class DealsApi extends BaseAPI {
|
|
990
1427
|
* @memberof DealsApi
|
991
1428
|
*/
|
992
1429
|
deleteDealProduct(requestParameters: DealsApiDeleteDealProductRequest): Promise<DeleteDealProductResponse>;
|
1430
|
+
/**
|
1431
|
+
* Removes an installment from a deal. Only available in Advanced and above plans.
|
1432
|
+
* @summary Delete an installment from a deal
|
1433
|
+
* @param {DealsApiDeleteInstallmentRequest} requestParameters Request parameters.
|
1434
|
+
|
1435
|
+
* @throws {RequiredError}
|
1436
|
+
* @memberof DealsApi
|
1437
|
+
*/
|
1438
|
+
deleteInstallment(requestParameters: DealsApiDeleteInstallmentRequest): Promise<DeleteInstallmentResponse>;
|
993
1439
|
/**
|
994
1440
|
* Lists discounts attached to a deal.
|
995
1441
|
* @summary List discounts added to a deal
|
@@ -1008,6 +1454,24 @@ export declare class DealsApi extends BaseAPI {
|
|
1008
1454
|
* @memberof DealsApi
|
1009
1455
|
*/
|
1010
1456
|
getDeal(requestParameters: DealsApiGetDealRequest): Promise<UpsertDealResponse>;
|
1457
|
+
/**
|
1458
|
+
* Lists users who are following the deal.
|
1459
|
+
* @summary List followers of a deal
|
1460
|
+
* @param {DealsApiGetDealFollowersRequest} requestParameters Request parameters.
|
1461
|
+
|
1462
|
+
* @throws {RequiredError}
|
1463
|
+
* @memberof DealsApi
|
1464
|
+
*/
|
1465
|
+
getDealFollowers(requestParameters: DealsApiGetDealFollowersRequest): Promise<GetFollowersResponse>;
|
1466
|
+
/**
|
1467
|
+
* Lists changelogs about users have followed the deal.
|
1468
|
+
* @summary List followers changelog of a deal
|
1469
|
+
* @param {DealsApiGetDealFollowersChangelogRequest} requestParameters Request parameters.
|
1470
|
+
|
1471
|
+
* @throws {RequiredError}
|
1472
|
+
* @memberof DealsApi
|
1473
|
+
*/
|
1474
|
+
getDealFollowersChangelog(requestParameters: DealsApiGetDealFollowersChangelogRequest): Promise<GetFollowerChangelogsResponse>;
|
1011
1475
|
/**
|
1012
1476
|
* Lists products attached to a deal.
|
1013
1477
|
* @summary List products attached to a deal
|
@@ -1035,6 +1499,15 @@ export declare class DealsApi extends BaseAPI {
|
|
1035
1499
|
* @memberof DealsApi
|
1036
1500
|
*/
|
1037
1501
|
getDealsProducts(requestParameters: DealsApiGetDealsProductsRequest): Promise<GetDealsProductsResponse>;
|
1502
|
+
/**
|
1503
|
+
* Lists installments attached to a list of deals. Only available in Advanced and above plans.
|
1504
|
+
* @summary List installments added to a list of deals
|
1505
|
+
* @param {DealsApiGetInstallmentsRequest} requestParameters Request parameters.
|
1506
|
+
|
1507
|
+
* @throws {RequiredError}
|
1508
|
+
* @memberof DealsApi
|
1509
|
+
*/
|
1510
|
+
getInstallments(requestParameters: DealsApiGetInstallmentsRequest): Promise<GetInstallmentsResponse>;
|
1038
1511
|
/**
|
1039
1512
|
* Adds a discount to a deal changing, the deal value if the deal has one-time products attached.
|
1040
1513
|
* @summary Add a discount to a deal
|
@@ -1044,6 +1517,15 @@ export declare class DealsApi extends BaseAPI {
|
|
1044
1517
|
* @memberof DealsApi
|
1045
1518
|
*/
|
1046
1519
|
postAdditionalDiscount(requestParameters: DealsApiPostAdditionalDiscountRequest): Promise<AddAdditionalDiscountResponse>;
|
1520
|
+
/**
|
1521
|
+
* Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Advanced and above plans.
|
1522
|
+
* @summary Add an installment to a deal
|
1523
|
+
* @param {DealsApiPostInstallmentRequest} requestParameters Request parameters.
|
1524
|
+
|
1525
|
+
* @throws {RequiredError}
|
1526
|
+
* @memberof DealsApi
|
1527
|
+
*/
|
1528
|
+
postInstallment(requestParameters: DealsApiPostInstallmentRequest): Promise<AddAInstallmentResponse>;
|
1047
1529
|
/**
|
1048
1530
|
* Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID.
|
1049
1531
|
* @summary Search deals
|
@@ -1080,4 +1562,13 @@ export declare class DealsApi extends BaseAPI {
|
|
1080
1562
|
* @memberof DealsApi
|
1081
1563
|
*/
|
1082
1564
|
updateDealProduct(requestParameters: DealsApiUpdateDealProductRequest): Promise<AddDealProductResponse>;
|
1565
|
+
/**
|
1566
|
+
* Edits an installment added to a deal. Only available in Advanced and above plans.
|
1567
|
+
* @summary Update an installment added to a deal
|
1568
|
+
* @param {DealsApiUpdateInstallmentRequest} requestParameters Request parameters.
|
1569
|
+
|
1570
|
+
* @throws {RequiredError}
|
1571
|
+
* @memberof DealsApi
|
1572
|
+
*/
|
1573
|
+
updateInstallment(requestParameters: DealsApiUpdateInstallmentRequest): Promise<UpdateInstallmentResponse>;
|
1083
1574
|
}
|