pipedrive 24.2.0 → 26.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/activities-api.d.ts +40 -40
- package/dist/esm/versions/v1/api/activities-api.js +40 -40
- package/dist/esm/versions/v1/api/deals-api.d.ts +413 -91
- package/dist/esm/versions/v1/api/deals-api.js +419 -90
- package/dist/esm/versions/v1/api/item-search-api.d.ts +8 -8
- package/dist/esm/versions/v1/api/item-search-api.js +8 -8
- package/dist/esm/versions/v1/api/leads-api.d.ts +100 -14
- package/dist/esm/versions/v1/api/leads-api.js +107 -14
- package/dist/esm/versions/v1/api/notes-api.d.ts +18 -2
- package/dist/esm/versions/v1/api/notes-api.js +15 -5
- package/dist/esm/versions/v1/api/organizations-api.d.ts +71 -71
- package/dist/esm/versions/v1/api/organizations-api.js +70 -70
- package/dist/esm/versions/v1/api/persons-api.d.ts +59 -59
- package/dist/esm/versions/v1/api/persons-api.js +58 -58
- package/dist/esm/versions/v1/api/pipelines-api.d.ts +28 -28
- package/dist/esm/versions/v1/api/pipelines-api.js +28 -28
- package/dist/esm/versions/v1/api/products-api.d.ts +24 -24
- package/dist/esm/versions/v1/api/products-api.js +24 -24
- package/dist/esm/versions/v1/api/stages-api.d.ts +36 -36
- package/dist/esm/versions/v1/api/stages-api.js +36 -36
- 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/base.d.ts +2 -3
- package/dist/esm/versions/v1/configuration.d.ts +2 -2
- package/dist/esm/versions/v1/models/add-note-request-all-of.d.ts +9 -4
- package/dist/esm/versions/v1/models/add-note-request-all-of1.d.ts +10 -0
- package/dist/esm/versions/v1/models/add-note-request-all-of1.js +4 -0
- 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/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -0
- package/dist/esm/versions/v1/models/index.d.ts +1 -0
- package/dist/esm/versions/v1/models/index.js +1 -0
- package/dist/esm/versions/v1/models/note-project.d.ts +23 -0
- package/dist/esm/versions/v1/models/note-project.js +14 -0
- package/dist/esm/versions/v1/models/note-request-all-of1.d.ts +5 -0
- package/dist/esm/versions/v1/models/note.d.ts +16 -0
- 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 +15 -7
- package/dist/esm/versions/v2/api/activities-api.js +12 -7
- package/dist/esm/versions/v2/api/beta-api.d.ts +194 -2532
- package/dist/esm/versions/v2/api/beta-api.js +263 -2928
- package/dist/esm/versions/v2/api/deals-api.d.ts +509 -4
- package/dist/esm/versions/v2/api/deals-api.js +589 -4
- package/dist/esm/versions/v2/api/leads-api.d.ts +111 -0
- package/dist/esm/versions/v2/api/leads-api.js +146 -1
- 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 +245 -8
- package/dist/esm/versions/v2/api/persons-api.js +309 -8
- 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/base.d.ts +2 -3
- package/dist/esm/versions/v2/configuration.d.ts +2 -2
- package/dist/esm/versions/v2/models/activity-item.d.ts +5 -0
- package/dist/esm/versions/v2/models/activity-item1.d.ts +5 -0
- package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response-data.d.ts +23 -0
- package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response-data.js +14 -0
- package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response.d.ts +34 -0
- package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response.js +14 -0
- package/dist/esm/versions/v2/models/add-convert-lead-to-deal-response.d.ts +34 -0
- package/dist/esm/versions/v2/models/add-convert-lead-to-deal-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-person-request.d.ts +12 -0
- package/dist/esm/versions/v2/models/add-person-request.js +6 -1
- package/dist/esm/versions/v2/models/convert-lead-to-deal-request.d.ts +28 -0
- package/dist/esm/versions/v2/models/convert-lead-to-deal-request.js +14 -0
- package/dist/esm/versions/v2/models/deal-item.d.ts +5 -0
- package/dist/esm/versions/v2/models/deal-item1.d.ts +5 -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/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-convert-response.d.ts +43 -0
- package/dist/esm/versions/v2/models/get-convert-response.js +14 -0
- package/dist/esm/versions/v2/models/get-convert-response1-data.d.ts +46 -0
- package/dist/esm/versions/v2/models/get-convert-response1-data.js +20 -0
- package/dist/esm/versions/v2/models/get-convert-response1.d.ts +34 -0
- package/dist/esm/versions/v2/models/get-convert-response1.js +14 -0
- package/dist/esm/versions/v2/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -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/index.d.ts +19 -0
- package/dist/esm/versions/v2/models/index.js +19 -0
- package/dist/esm/versions/v2/models/update-person-request.d.ts +12 -0
- package/dist/esm/versions/v2/models/update-person-request.js +6 -1
- package/dist/versions/v1/api/activities-api.d.ts +40 -40
- package/dist/versions/v1/api/activities-api.js +40 -40
- package/dist/versions/v1/api/deals-api.d.ts +413 -91
- package/dist/versions/v1/api/deals-api.js +419 -90
- package/dist/versions/v1/api/item-search-api.d.ts +8 -8
- package/dist/versions/v1/api/item-search-api.js +8 -8
- package/dist/versions/v1/api/leads-api.d.ts +100 -14
- package/dist/versions/v1/api/leads-api.js +107 -14
- package/dist/versions/v1/api/notes-api.d.ts +18 -2
- package/dist/versions/v1/api/notes-api.js +15 -5
- package/dist/versions/v1/api/organizations-api.d.ts +71 -71
- package/dist/versions/v1/api/organizations-api.js +70 -70
- package/dist/versions/v1/api/persons-api.d.ts +59 -59
- package/dist/versions/v1/api/persons-api.js +58 -58
- package/dist/versions/v1/api/pipelines-api.d.ts +28 -28
- package/dist/versions/v1/api/pipelines-api.js +28 -28
- package/dist/versions/v1/api/products-api.d.ts +24 -24
- package/dist/versions/v1/api/products-api.js +24 -24
- package/dist/versions/v1/api/stages-api.d.ts +36 -36
- package/dist/versions/v1/api/stages-api.js +36 -36
- 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/base.d.ts +2 -3
- package/dist/versions/v1/configuration.d.ts +2 -2
- package/dist/versions/v1/models/add-note-request-all-of.d.ts +9 -4
- package/dist/versions/v1/models/add-note-request-all-of1.d.ts +10 -0
- package/dist/versions/v1/models/add-note-request-all-of1.js +5 -1
- 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/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -0
- package/dist/versions/v1/models/index.d.ts +1 -0
- package/dist/versions/v1/models/index.js +1 -0
- package/dist/versions/v1/models/note-project.d.ts +23 -0
- package/dist/versions/v1/models/note-project.js +15 -0
- package/dist/versions/v1/models/note-request-all-of1.d.ts +5 -0
- package/dist/versions/v1/models/note.d.ts +16 -0
- 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 +15 -7
- package/dist/versions/v2/api/activities-api.js +12 -7
- package/dist/versions/v2/api/beta-api.d.ts +194 -2532
- package/dist/versions/v2/api/beta-api.js +265 -2930
- package/dist/versions/v2/api/deals-api.d.ts +509 -4
- package/dist/versions/v2/api/deals-api.js +589 -4
- package/dist/versions/v2/api/leads-api.d.ts +111 -0
- package/dist/versions/v2/api/leads-api.js +145 -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 +245 -8
- package/dist/versions/v2/api/persons-api.js +309 -8
- 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/base.d.ts +2 -3
- package/dist/versions/v2/configuration.d.ts +2 -2
- package/dist/versions/v2/models/activity-item.d.ts +5 -0
- package/dist/versions/v2/models/activity-item1.d.ts +5 -0
- package/dist/versions/v2/models/add-convert-deal-to-lead-response-data.d.ts +23 -0
- package/dist/versions/v2/models/add-convert-deal-to-lead-response-data.js +15 -0
- package/dist/versions/v2/models/add-convert-deal-to-lead-response.d.ts +34 -0
- package/dist/versions/v2/models/add-convert-deal-to-lead-response.js +15 -0
- package/dist/versions/v2/models/add-convert-lead-to-deal-response.d.ts +34 -0
- package/dist/versions/v2/models/add-convert-lead-to-deal-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-person-request.d.ts +12 -0
- package/dist/versions/v2/models/add-person-request.js +7 -0
- package/dist/versions/v2/models/convert-lead-to-deal-request.d.ts +28 -0
- package/dist/versions/v2/models/convert-lead-to-deal-request.js +15 -0
- package/dist/versions/v2/models/deal-item.d.ts +5 -0
- package/dist/versions/v2/models/deal-item1.d.ts +5 -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/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-convert-response.d.ts +43 -0
- package/dist/versions/v2/models/get-convert-response.js +15 -0
- package/dist/versions/v2/models/get-convert-response1-data.d.ts +46 -0
- package/dist/versions/v2/models/get-convert-response1-data.js +23 -0
- package/dist/versions/v2/models/get-convert-response1.d.ts +34 -0
- package/dist/versions/v2/models/get-convert-response1.js +15 -0
- package/dist/versions/v2/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -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/index.d.ts +19 -0
- package/dist/versions/v2/models/index.js +19 -0
- package/dist/versions/v2/models/update-person-request.d.ts +12 -0
- package/dist/versions/v2/models/update-person-request.js +7 -0
- package/package.json +1 -1
@@ -36,7 +36,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
36
36
|
* Adds a new deal. All deals created through the Pipedrive API will have a `origin` set to `API`. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the dealFields and look for `key` values. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/creating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">adding a deal</a>.
|
37
37
|
* @summary Add a deal
|
38
38
|
* @param {AddDealRequest} [AddDealRequest]
|
39
|
-
|
39
|
+
* @deprecated
|
40
40
|
* @throws {RequiredError}
|
41
41
|
*/
|
42
42
|
addDeal: (AddDealRequest) => __awaiter(this, void 0, void 0, function* () {
|
@@ -144,7 +144,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
144
144
|
* @summary Add a product to a deal
|
145
145
|
* @param {number} id The ID of the deal
|
146
146
|
* @param {AddDealProductRequest} [AddDealProductRequest]
|
147
|
-
|
147
|
+
* @deprecated
|
148
148
|
* @throws {RequiredError}
|
149
149
|
*/
|
150
150
|
addDealProduct: (id, AddDealProductRequest) => __awaiter(this, void 0, void 0, function* () {
|
@@ -180,7 +180,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
180
180
|
* Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
|
181
181
|
* @summary Delete a deal
|
182
182
|
* @param {number} id The ID of the deal
|
183
|
-
|
183
|
+
* @deprecated
|
184
184
|
* @throws {RequiredError}
|
185
185
|
*/
|
186
186
|
deleteDeal: (id) => __awaiter(this, void 0, void 0, function* () {
|
@@ -214,7 +214,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
214
214
|
* Deletes a follower from a deal.
|
215
215
|
* @summary Delete a follower from a deal
|
216
216
|
* @param {number} id The ID of the deal
|
217
|
-
* @param {number} follower_id The ID of the follower
|
217
|
+
* @param {number} follower_id The ID of the relationship between the follower and the deal
|
218
218
|
|
219
219
|
* @throws {RequiredError}
|
220
220
|
*/
|
@@ -291,7 +291,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
291
291
|
* @summary Delete an attached product from a deal
|
292
292
|
* @param {number} id The ID of the deal
|
293
293
|
* @param {number} product_attachment_id The product attachment ID
|
294
|
-
|
294
|
+
* @deprecated
|
295
295
|
* @throws {RequiredError}
|
296
296
|
*/
|
297
297
|
deleteDealProduct: (id, product_attachment_id) => __awaiter(this, void 0, void 0, function* () {
|
@@ -325,10 +325,10 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
325
325
|
};
|
326
326
|
}),
|
327
327
|
/**
|
328
|
-
* Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.
|
328
|
+
* Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#deleteDeal\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/deals/{id}</a> instead.
|
329
329
|
* @summary Delete multiple deals in bulk
|
330
330
|
* @param {string} ids The comma-separated IDs that will be deleted
|
331
|
-
|
331
|
+
* @deprecated
|
332
332
|
* @throws {RequiredError}
|
333
333
|
*/
|
334
334
|
deleteDeals: (ids) => __awaiter(this, void 0, void 0, function* () {
|
@@ -394,11 +394,215 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
394
394
|
options: localVarRequestOptions,
|
395
395
|
};
|
396
396
|
}),
|
397
|
+
/**
|
398
|
+
* Returns all archived deals.
|
399
|
+
* @summary Get all archived deals
|
400
|
+
* @param {number} [user_id] If supplied, only deals matching the given user will be returned. However, `filter_id` and `owned_by_you` takes precedence over `user_id` when supplied.
|
401
|
+
* @param {number} [filter_id] The ID of the filter to use
|
402
|
+
* @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
|
403
|
+
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
404
|
+
* @param {number} [product_id] If supplied, only deals linked to the specified product are returned. If filter_id is provided, this is ignored.
|
405
|
+
* @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
|
406
|
+
* @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
|
407
|
+
* @param {'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted'} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included.
|
408
|
+
* @param {number} [start] Pagination start
|
409
|
+
* @param {number} [limit] Items shown per page
|
410
|
+
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
411
|
+
* @param {0 | 1} [owned_by_you] When supplied, only deals owned by you are returned. However, `filter_id` takes precedence over `owned_by_you` when both are supplied.
|
412
|
+
* @deprecated
|
413
|
+
* @throws {RequiredError}
|
414
|
+
*/
|
415
|
+
getArchivedDeals: (user_id, filter_id, person_id, org_id, product_id, pipeline_id, stage_id, status, start, limit, sort, owned_by_you) => __awaiter(this, void 0, void 0, function* () {
|
416
|
+
const localVarPath = `/deals/archived`;
|
417
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
418
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
419
|
+
let baseOptions;
|
420
|
+
if (configuration) {
|
421
|
+
baseOptions = configuration.baseOptions;
|
422
|
+
}
|
423
|
+
const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
|
424
|
+
const localVarHeaderParameter = {};
|
425
|
+
const localVarQueryParameter = {};
|
426
|
+
// authentication api_key required
|
427
|
+
yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
|
428
|
+
// authentication oauth2 required
|
429
|
+
// oauth required
|
430
|
+
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration);
|
431
|
+
if (user_id !== undefined) {
|
432
|
+
localVarQueryParameter['user_id'] = user_id;
|
433
|
+
}
|
434
|
+
if (filter_id !== undefined) {
|
435
|
+
localVarQueryParameter['filter_id'] = filter_id;
|
436
|
+
}
|
437
|
+
if (person_id !== undefined) {
|
438
|
+
localVarQueryParameter['person_id'] = person_id;
|
439
|
+
}
|
440
|
+
if (org_id !== undefined) {
|
441
|
+
localVarQueryParameter['org_id'] = org_id;
|
442
|
+
}
|
443
|
+
if (product_id !== undefined) {
|
444
|
+
localVarQueryParameter['product_id'] = product_id;
|
445
|
+
}
|
446
|
+
if (pipeline_id !== undefined) {
|
447
|
+
localVarQueryParameter['pipeline_id'] = pipeline_id;
|
448
|
+
}
|
449
|
+
if (stage_id !== undefined) {
|
450
|
+
localVarQueryParameter['stage_id'] = stage_id;
|
451
|
+
}
|
452
|
+
if (status !== undefined) {
|
453
|
+
localVarQueryParameter['status'] = status;
|
454
|
+
}
|
455
|
+
if (start !== undefined) {
|
456
|
+
localVarQueryParameter['start'] = start;
|
457
|
+
}
|
458
|
+
if (limit !== undefined) {
|
459
|
+
localVarQueryParameter['limit'] = limit;
|
460
|
+
}
|
461
|
+
if (sort !== undefined) {
|
462
|
+
localVarQueryParameter['sort'] = sort;
|
463
|
+
}
|
464
|
+
if (owned_by_you !== undefined) {
|
465
|
+
localVarQueryParameter['owned_by_you'] = owned_by_you;
|
466
|
+
}
|
467
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
468
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
469
|
+
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
470
|
+
return {
|
471
|
+
url: toPathString(localVarUrlObj),
|
472
|
+
options: localVarRequestOptions,
|
473
|
+
};
|
474
|
+
}),
|
475
|
+
/**
|
476
|
+
* Returns a summary of all archived deals.
|
477
|
+
* @summary Get archived deals summary
|
478
|
+
* @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.
|
479
|
+
* @param {number} [filter_id] <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
|
480
|
+
* @param {number} [user_id] Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.
|
481
|
+
* @param {number} [pipeline_id] Only deals within the given pipeline will be returned
|
482
|
+
* @param {number} [stage_id] Only deals within the given stage will be returned
|
483
|
+
* @deprecated
|
484
|
+
* @throws {RequiredError}
|
485
|
+
*/
|
486
|
+
getArchivedDealsSummary: (status, filter_id, user_id, pipeline_id, stage_id) => __awaiter(this, void 0, void 0, function* () {
|
487
|
+
const localVarPath = `/deals/summary/archived`;
|
488
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
489
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
490
|
+
let baseOptions;
|
491
|
+
if (configuration) {
|
492
|
+
baseOptions = configuration.baseOptions;
|
493
|
+
}
|
494
|
+
const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
|
495
|
+
const localVarHeaderParameter = {};
|
496
|
+
const localVarQueryParameter = {};
|
497
|
+
// authentication api_key required
|
498
|
+
yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
|
499
|
+
// authentication oauth2 required
|
500
|
+
// oauth required
|
501
|
+
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration);
|
502
|
+
if (status !== undefined) {
|
503
|
+
localVarQueryParameter['status'] = status;
|
504
|
+
}
|
505
|
+
if (filter_id !== undefined) {
|
506
|
+
localVarQueryParameter['filter_id'] = filter_id;
|
507
|
+
}
|
508
|
+
if (user_id !== undefined) {
|
509
|
+
localVarQueryParameter['user_id'] = user_id;
|
510
|
+
}
|
511
|
+
if (pipeline_id !== undefined) {
|
512
|
+
localVarQueryParameter['pipeline_id'] = pipeline_id;
|
513
|
+
}
|
514
|
+
if (stage_id !== undefined) {
|
515
|
+
localVarQueryParameter['stage_id'] = stage_id;
|
516
|
+
}
|
517
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
518
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
519
|
+
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
520
|
+
return {
|
521
|
+
url: toPathString(localVarUrlObj),
|
522
|
+
options: localVarRequestOptions,
|
523
|
+
};
|
524
|
+
}),
|
525
|
+
/**
|
526
|
+
* Returns archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
|
527
|
+
* @summary Get archived deals timeline
|
528
|
+
* @param {string} start_date The date when the first interval starts. Format: YYYY-MM-DD.
|
529
|
+
* @param {'day' | 'week' | 'month' | 'quarter'} interval The type of the interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>`day`</td><td>Day</td></tr><tr><td>`week`</td><td>A full week (7 days) starting from `start_date`</td></tr><tr><td>`month`</td><td>A full month (depending on the number of days in given month) starting from `start_date`</td></tr><tr><td>`quarter`</td><td>A full quarter (3 months) starting from `start_date`</td></tr></table>
|
530
|
+
* @param {number} amount The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months).
|
531
|
+
* @param {string} field_key The date field key which deals will be retrieved from
|
532
|
+
* @param {number} [user_id] If supplied, only deals matching the given user will be returned
|
533
|
+
* @param {number} [pipeline_id] If supplied, only deals matching the given pipeline will be returned
|
534
|
+
* @param {number} [filter_id] If supplied, only deals matching the given filter will be returned
|
535
|
+
* @param {0 | 1} [exclude_deals] Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned.
|
536
|
+
* @param {string} [totals_convert_currency] The 3-letter currency code of any of the supported currencies. When supplied, `totals_converted` is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to `default_currency` in which case the user\'s default currency is used.
|
537
|
+
* @deprecated
|
538
|
+
* @throws {RequiredError}
|
539
|
+
*/
|
540
|
+
getArchivedDealsTimeline: (start_date, interval, amount, field_key, user_id, pipeline_id, filter_id, exclude_deals, totals_convert_currency) => __awaiter(this, void 0, void 0, function* () {
|
541
|
+
// verify required parameter 'start_date' is not null or undefined
|
542
|
+
assertParamExists('getArchivedDealsTimeline', 'start_date', start_date);
|
543
|
+
// verify required parameter 'interval' is not null or undefined
|
544
|
+
assertParamExists('getArchivedDealsTimeline', 'interval', interval);
|
545
|
+
// verify required parameter 'amount' is not null or undefined
|
546
|
+
assertParamExists('getArchivedDealsTimeline', 'amount', amount);
|
547
|
+
// verify required parameter 'field_key' is not null or undefined
|
548
|
+
assertParamExists('getArchivedDealsTimeline', 'field_key', field_key);
|
549
|
+
const localVarPath = `/deals/timeline/archived`;
|
550
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
551
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
552
|
+
let baseOptions;
|
553
|
+
if (configuration) {
|
554
|
+
baseOptions = configuration.baseOptions;
|
555
|
+
}
|
556
|
+
const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
|
557
|
+
const localVarHeaderParameter = {};
|
558
|
+
const localVarQueryParameter = {};
|
559
|
+
// authentication api_key required
|
560
|
+
yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
|
561
|
+
// authentication oauth2 required
|
562
|
+
// oauth required
|
563
|
+
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration);
|
564
|
+
if (start_date !== undefined) {
|
565
|
+
localVarQueryParameter['start_date'] = (start_date instanceof Date) ?
|
566
|
+
start_date.toISOString().substr(0, 10) :
|
567
|
+
start_date;
|
568
|
+
}
|
569
|
+
if (interval !== undefined) {
|
570
|
+
localVarQueryParameter['interval'] = interval;
|
571
|
+
}
|
572
|
+
if (amount !== undefined) {
|
573
|
+
localVarQueryParameter['amount'] = amount;
|
574
|
+
}
|
575
|
+
if (field_key !== undefined) {
|
576
|
+
localVarQueryParameter['field_key'] = field_key;
|
577
|
+
}
|
578
|
+
if (user_id !== undefined) {
|
579
|
+
localVarQueryParameter['user_id'] = user_id;
|
580
|
+
}
|
581
|
+
if (pipeline_id !== undefined) {
|
582
|
+
localVarQueryParameter['pipeline_id'] = pipeline_id;
|
583
|
+
}
|
584
|
+
if (filter_id !== undefined) {
|
585
|
+
localVarQueryParameter['filter_id'] = filter_id;
|
586
|
+
}
|
587
|
+
if (exclude_deals !== undefined) {
|
588
|
+
localVarQueryParameter['exclude_deals'] = exclude_deals;
|
589
|
+
}
|
590
|
+
if (totals_convert_currency !== undefined) {
|
591
|
+
localVarQueryParameter['totals_convert_currency'] = totals_convert_currency;
|
592
|
+
}
|
593
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
594
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
595
|
+
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
596
|
+
return {
|
597
|
+
url: toPathString(localVarUrlObj),
|
598
|
+
options: localVarRequestOptions,
|
599
|
+
};
|
600
|
+
}),
|
397
601
|
/**
|
398
602
|
* Returns the details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of dealFields. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-details-of-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">getting details of a deal</a>.
|
399
603
|
* @summary Get details of a deal
|
400
604
|
* @param {number} id The ID of the deal
|
401
|
-
|
605
|
+
* @deprecated
|
402
606
|
* @throws {RequiredError}
|
403
607
|
*/
|
404
608
|
getDeal: (id) => __awaiter(this, void 0, void 0, function* () {
|
@@ -429,14 +633,14 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
429
633
|
};
|
430
634
|
}),
|
431
635
|
/**
|
432
|
-
* Lists activities associated with a deal.
|
636
|
+
* Lists activities associated with a deal. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivities\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/activities?deal_id={id}</a> instead.
|
433
637
|
* @summary List activities associated with a deal
|
434
638
|
* @param {number} id The ID of the deal
|
435
639
|
* @param {number} [start] Pagination start
|
436
640
|
* @param {number} [limit] Items shown per page
|
437
641
|
* @param {0 | 1} [done] Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted, returns both Done and Not done activities.
|
438
642
|
* @param {string} [exclude] A comma-separated string of activity IDs to exclude from result
|
439
|
-
|
643
|
+
* @deprecated
|
440
644
|
* @throws {RequiredError}
|
441
645
|
*/
|
442
646
|
getDealActivities: (id, start, limit, done, exclude) => __awaiter(this, void 0, void 0, function* () {
|
@@ -727,12 +931,12 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
727
931
|
};
|
728
932
|
}),
|
729
933
|
/**
|
730
|
-
* Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
|
934
|
+
* Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersons\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/persons?deal_id={id}</a> instead.
|
731
935
|
* @summary List all persons associated with a deal
|
732
936
|
* @param {number} id The ID of the deal
|
733
937
|
* @param {number} [start] Pagination start
|
734
938
|
* @param {number} [limit] Items shown per page
|
735
|
-
|
939
|
+
* @deprecated
|
736
940
|
* @throws {RequiredError}
|
737
941
|
*/
|
738
942
|
getDealPersons: (id, start, limit) => __awaiter(this, void 0, void 0, function* () {
|
@@ -775,7 +979,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
775
979
|
* @param {number} [start] Pagination start
|
776
980
|
* @param {number} [limit] Items shown per page
|
777
981
|
* @param {0 | 1} [include_product_data] Whether to fetch product data along with each attached product (1) or not (0, default)
|
778
|
-
|
982
|
+
* @deprecated
|
779
983
|
* @throws {RequiredError}
|
780
984
|
*/
|
781
985
|
getDealProducts: (id, start, limit, include_product_data) => __awaiter(this, void 0, void 0, function* () {
|
@@ -899,7 +1103,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
899
1103
|
};
|
900
1104
|
}),
|
901
1105
|
/**
|
902
|
-
* Returns all deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
|
1106
|
+
* Returns all not archived deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
|
903
1107
|
* @summary Get all deals
|
904
1108
|
* @param {number} [user_id] If supplied, only deals matching the given user will be returned. However, `filter_id` and `owned_by_you` takes precedence over `user_id` when supplied.
|
905
1109
|
* @param {number} [filter_id] The ID of the filter to use
|
@@ -909,7 +1113,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
909
1113
|
* @param {number} [limit] Items shown per page
|
910
1114
|
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
911
1115
|
* @param {0 | 1} [owned_by_you] When supplied, only deals owned by you are returned. However, `filter_id` takes precedence over `owned_by_you` when both are supplied.
|
912
|
-
|
1116
|
+
* @deprecated
|
913
1117
|
* @throws {RequiredError}
|
914
1118
|
*/
|
915
1119
|
getDeals: (user_id, filter_id, stage_id, status, start, limit, sort, owned_by_you) => __awaiter(this, void 0, void 0, function* () {
|
@@ -961,8 +1165,8 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
961
1165
|
};
|
962
1166
|
}),
|
963
1167
|
/**
|
964
|
-
* Returns all deals.
|
965
|
-
* @summary Get all deals
|
1168
|
+
* Returns all deals. Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeals\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/deals</a> instead.
|
1169
|
+
* @summary Get all deals collection
|
966
1170
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
967
1171
|
* @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.
|
968
1172
|
* @param {string} [since] The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
|
@@ -970,7 +1174,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
970
1174
|
* @param {number} [user_id] If supplied, only deals matching the given user will be returned
|
971
1175
|
* @param {number} [stage_id] If supplied, only deals within the given stage will be returned
|
972
1176
|
* @param {'open' | 'won' | 'lost' | 'deleted'} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included.
|
973
|
-
|
1177
|
+
* @deprecated
|
974
1178
|
* @throws {RequiredError}
|
975
1179
|
*/
|
976
1180
|
getDealsCollection: (cursor, limit, since, until, user_id, stage_id, status) => __awaiter(this, void 0, void 0, function* () {
|
@@ -1019,7 +1223,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
1019
1223
|
};
|
1020
1224
|
}),
|
1021
1225
|
/**
|
1022
|
-
* Returns a summary of all
|
1226
|
+
* Returns a summary of all not archived deals.
|
1023
1227
|
* @summary Get deals summary
|
1024
1228
|
* @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.
|
1025
1229
|
* @param {number} [filter_id] <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
|
@@ -1069,7 +1273,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
1069
1273
|
};
|
1070
1274
|
}),
|
1071
1275
|
/**
|
1072
|
-
* Returns open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
|
1276
|
+
* Returns not archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
|
1073
1277
|
* @summary Get deals timeline
|
1074
1278
|
* @param {string} start_date The date when the first interval starts. Format: YYYY-MM-DD.
|
1075
1279
|
* @param {'day' | 'week' | 'month' | 'quarter'} interval The type of the interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>`day`</td><td>Day</td></tr><tr><td>`week`</td><td>A full week (7 days) starting from `start_date`</td></tr><tr><td>`month`</td><td>A full month (depending on the number of days in given month) starting from `start_date`</td></tr><tr><td>`quarter`</td><td>A full quarter (3 months) starting from `start_date`</td></tr></table>
|
@@ -1193,7 +1397,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
1193
1397
|
* @param {'deal.cc_email'} [include_fields] Supports including optional fields in the results which are not provided by default
|
1194
1398
|
* @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
|
1195
1399
|
* @param {number} [limit] Items shown per page
|
1196
|
-
|
1400
|
+
* @deprecated
|
1197
1401
|
* @throws {RequiredError}
|
1198
1402
|
*/
|
1199
1403
|
searchDeals: (term, fields, exact_match, person_id, organization_id, status, include_fields, start, limit) => __awaiter(this, void 0, void 0, function* () {
|
@@ -1254,7 +1458,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
1254
1458
|
* @summary Update a deal
|
1255
1459
|
* @param {number} id The ID of the deal
|
1256
1460
|
* @param {UpdateDealRequest} [UpdateDealRequest]
|
1257
|
-
|
1461
|
+
* @deprecated
|
1258
1462
|
* @throws {RequiredError}
|
1259
1463
|
*/
|
1260
1464
|
updateDeal: (id, UpdateDealRequest) => __awaiter(this, void 0, void 0, function* () {
|
@@ -1292,7 +1496,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
1292
1496
|
* @param {number} id The ID of the deal
|
1293
1497
|
* @param {number} product_attachment_id The ID of the deal-product (the ID of the product attached to the deal)
|
1294
1498
|
* @param {UpdateDealProductRequest} [UpdateDealProductRequest]
|
1295
|
-
|
1499
|
+
* @deprecated
|
1296
1500
|
* @throws {RequiredError}
|
1297
1501
|
*/
|
1298
1502
|
updateDealProduct: (id, product_attachment_id, UpdateDealProductRequest) => __awaiter(this, void 0, void 0, function* () {
|
@@ -1340,7 +1544,7 @@ export const DealsApiFp = function (configuration) {
|
|
1340
1544
|
* Adds a new deal. All deals created through the Pipedrive API will have a `origin` set to `API`. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the dealFields and look for `key` values. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/creating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">adding a deal</a>.
|
1341
1545
|
* @summary Add a deal
|
1342
1546
|
* @param {AddDealRequest} [AddDealRequest]
|
1343
|
-
|
1547
|
+
* @deprecated
|
1344
1548
|
* @throws {RequiredError}
|
1345
1549
|
*/
|
1346
1550
|
addDeal(AddDealRequest) {
|
@@ -1382,7 +1586,7 @@ export const DealsApiFp = function (configuration) {
|
|
1382
1586
|
* @summary Add a product to a deal
|
1383
1587
|
* @param {number} id The ID of the deal
|
1384
1588
|
* @param {AddDealProductRequest} [AddDealProductRequest]
|
1385
|
-
|
1589
|
+
* @deprecated
|
1386
1590
|
* @throws {RequiredError}
|
1387
1591
|
*/
|
1388
1592
|
addDealProduct(id, AddDealProductRequest) {
|
@@ -1395,7 +1599,7 @@ export const DealsApiFp = function (configuration) {
|
|
1395
1599
|
* Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
|
1396
1600
|
* @summary Delete a deal
|
1397
1601
|
* @param {number} id The ID of the deal
|
1398
|
-
|
1602
|
+
* @deprecated
|
1399
1603
|
* @throws {RequiredError}
|
1400
1604
|
*/
|
1401
1605
|
deleteDeal(id) {
|
@@ -1408,7 +1612,7 @@ export const DealsApiFp = function (configuration) {
|
|
1408
1612
|
* Deletes a follower from a deal.
|
1409
1613
|
* @summary Delete a follower from a deal
|
1410
1614
|
* @param {number} id The ID of the deal
|
1411
|
-
* @param {number} follower_id The ID of the follower
|
1615
|
+
* @param {number} follower_id The ID of the relationship between the follower and the deal
|
1412
1616
|
|
1413
1617
|
* @throws {RequiredError}
|
1414
1618
|
*/
|
@@ -1437,7 +1641,7 @@ export const DealsApiFp = function (configuration) {
|
|
1437
1641
|
* @summary Delete an attached product from a deal
|
1438
1642
|
* @param {number} id The ID of the deal
|
1439
1643
|
* @param {number} product_attachment_id The product attachment ID
|
1440
|
-
|
1644
|
+
* @deprecated
|
1441
1645
|
* @throws {RequiredError}
|
1442
1646
|
*/
|
1443
1647
|
deleteDealProduct(id, product_attachment_id) {
|
@@ -1447,10 +1651,10 @@ export const DealsApiFp = function (configuration) {
|
|
1447
1651
|
});
|
1448
1652
|
},
|
1449
1653
|
/**
|
1450
|
-
* Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.
|
1654
|
+
* Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#deleteDeal\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/deals/{id}</a> instead.
|
1451
1655
|
* @summary Delete multiple deals in bulk
|
1452
1656
|
* @param {string} ids The comma-separated IDs that will be deleted
|
1453
|
-
|
1657
|
+
* @deprecated
|
1454
1658
|
* @throws {RequiredError}
|
1455
1659
|
*/
|
1456
1660
|
deleteDeals(ids) {
|
@@ -1472,11 +1676,73 @@ export const DealsApiFp = function (configuration) {
|
|
1472
1676
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
1473
1677
|
});
|
1474
1678
|
},
|
1679
|
+
/**
|
1680
|
+
* Returns all archived deals.
|
1681
|
+
* @summary Get all archived deals
|
1682
|
+
* @param {number} [user_id] If supplied, only deals matching the given user will be returned. However, `filter_id` and `owned_by_you` takes precedence over `user_id` when supplied.
|
1683
|
+
* @param {number} [filter_id] The ID of the filter to use
|
1684
|
+
* @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
|
1685
|
+
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
1686
|
+
* @param {number} [product_id] If supplied, only deals linked to the specified product are returned. If filter_id is provided, this is ignored.
|
1687
|
+
* @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
|
1688
|
+
* @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
|
1689
|
+
* @param {'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted'} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included.
|
1690
|
+
* @param {number} [start] Pagination start
|
1691
|
+
* @param {number} [limit] Items shown per page
|
1692
|
+
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
1693
|
+
* @param {0 | 1} [owned_by_you] When supplied, only deals owned by you are returned. However, `filter_id` takes precedence over `owned_by_you` when both are supplied.
|
1694
|
+
* @deprecated
|
1695
|
+
* @throws {RequiredError}
|
1696
|
+
*/
|
1697
|
+
getArchivedDeals(user_id, filter_id, person_id, org_id, product_id, pipeline_id, stage_id, status, start, limit, sort, owned_by_you) {
|
1698
|
+
return __awaiter(this, void 0, void 0, function* () {
|
1699
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getArchivedDeals(user_id, filter_id, person_id, org_id, product_id, pipeline_id, stage_id, status, start, limit, sort, owned_by_you);
|
1700
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
1701
|
+
});
|
1702
|
+
},
|
1703
|
+
/**
|
1704
|
+
* Returns a summary of all archived deals.
|
1705
|
+
* @summary Get archived deals summary
|
1706
|
+
* @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.
|
1707
|
+
* @param {number} [filter_id] <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
|
1708
|
+
* @param {number} [user_id] Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.
|
1709
|
+
* @param {number} [pipeline_id] Only deals within the given pipeline will be returned
|
1710
|
+
* @param {number} [stage_id] Only deals within the given stage will be returned
|
1711
|
+
* @deprecated
|
1712
|
+
* @throws {RequiredError}
|
1713
|
+
*/
|
1714
|
+
getArchivedDealsSummary(status, filter_id, user_id, pipeline_id, stage_id) {
|
1715
|
+
return __awaiter(this, void 0, void 0, function* () {
|
1716
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getArchivedDealsSummary(status, filter_id, user_id, pipeline_id, stage_id);
|
1717
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
1718
|
+
});
|
1719
|
+
},
|
1720
|
+
/**
|
1721
|
+
* Returns archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
|
1722
|
+
* @summary Get archived deals timeline
|
1723
|
+
* @param {string} start_date The date when the first interval starts. Format: YYYY-MM-DD.
|
1724
|
+
* @param {'day' | 'week' | 'month' | 'quarter'} interval The type of the interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>`day`</td><td>Day</td></tr><tr><td>`week`</td><td>A full week (7 days) starting from `start_date`</td></tr><tr><td>`month`</td><td>A full month (depending on the number of days in given month) starting from `start_date`</td></tr><tr><td>`quarter`</td><td>A full quarter (3 months) starting from `start_date`</td></tr></table>
|
1725
|
+
* @param {number} amount The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months).
|
1726
|
+
* @param {string} field_key The date field key which deals will be retrieved from
|
1727
|
+
* @param {number} [user_id] If supplied, only deals matching the given user will be returned
|
1728
|
+
* @param {number} [pipeline_id] If supplied, only deals matching the given pipeline will be returned
|
1729
|
+
* @param {number} [filter_id] If supplied, only deals matching the given filter will be returned
|
1730
|
+
* @param {0 | 1} [exclude_deals] Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned.
|
1731
|
+
* @param {string} [totals_convert_currency] The 3-letter currency code of any of the supported currencies. When supplied, `totals_converted` is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to `default_currency` in which case the user\'s default currency is used.
|
1732
|
+
* @deprecated
|
1733
|
+
* @throws {RequiredError}
|
1734
|
+
*/
|
1735
|
+
getArchivedDealsTimeline(start_date, interval, amount, field_key, user_id, pipeline_id, filter_id, exclude_deals, totals_convert_currency) {
|
1736
|
+
return __awaiter(this, void 0, void 0, function* () {
|
1737
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getArchivedDealsTimeline(start_date, interval, amount, field_key, user_id, pipeline_id, filter_id, exclude_deals, totals_convert_currency);
|
1738
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
1739
|
+
});
|
1740
|
+
},
|
1475
1741
|
/**
|
1476
1742
|
* Returns the details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of dealFields. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-details-of-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">getting details of a deal</a>.
|
1477
1743
|
* @summary Get details of a deal
|
1478
1744
|
* @param {number} id The ID of the deal
|
1479
|
-
|
1745
|
+
* @deprecated
|
1480
1746
|
* @throws {RequiredError}
|
1481
1747
|
*/
|
1482
1748
|
getDeal(id) {
|
@@ -1486,14 +1752,14 @@ export const DealsApiFp = function (configuration) {
|
|
1486
1752
|
});
|
1487
1753
|
},
|
1488
1754
|
/**
|
1489
|
-
* Lists activities associated with a deal.
|
1755
|
+
* Lists activities associated with a deal. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivities\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/activities?deal_id={id}</a> instead.
|
1490
1756
|
* @summary List activities associated with a deal
|
1491
1757
|
* @param {number} id The ID of the deal
|
1492
1758
|
* @param {number} [start] Pagination start
|
1493
1759
|
* @param {number} [limit] Items shown per page
|
1494
1760
|
* @param {0 | 1} [done] Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted, returns both Done and Not done activities.
|
1495
1761
|
* @param {string} [exclude] A comma-separated string of activity IDs to exclude from result
|
1496
|
-
|
1762
|
+
* @deprecated
|
1497
1763
|
* @throws {RequiredError}
|
1498
1764
|
*/
|
1499
1765
|
getDealActivities(id, start, limit, done, exclude) {
|
@@ -1592,12 +1858,12 @@ export const DealsApiFp = function (configuration) {
|
|
1592
1858
|
});
|
1593
1859
|
},
|
1594
1860
|
/**
|
1595
|
-
* Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
|
1861
|
+
* Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersons\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/persons?deal_id={id}</a> instead.
|
1596
1862
|
* @summary List all persons associated with a deal
|
1597
1863
|
* @param {number} id The ID of the deal
|
1598
1864
|
* @param {number} [start] Pagination start
|
1599
1865
|
* @param {number} [limit] Items shown per page
|
1600
|
-
|
1866
|
+
* @deprecated
|
1601
1867
|
* @throws {RequiredError}
|
1602
1868
|
*/
|
1603
1869
|
getDealPersons(id, start, limit) {
|
@@ -1613,7 +1879,7 @@ export const DealsApiFp = function (configuration) {
|
|
1613
1879
|
* @param {number} [start] Pagination start
|
1614
1880
|
* @param {number} [limit] Items shown per page
|
1615
1881
|
* @param {0 | 1} [include_product_data] Whether to fetch product data along with each attached product (1) or not (0, default)
|
1616
|
-
|
1882
|
+
* @deprecated
|
1617
1883
|
* @throws {RequiredError}
|
1618
1884
|
*/
|
1619
1885
|
getDealProducts(id, start, limit, include_product_data) {
|
@@ -1653,7 +1919,7 @@ export const DealsApiFp = function (configuration) {
|
|
1653
1919
|
});
|
1654
1920
|
},
|
1655
1921
|
/**
|
1656
|
-
* Returns all deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
|
1922
|
+
* Returns all not archived deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
|
1657
1923
|
* @summary Get all deals
|
1658
1924
|
* @param {number} [user_id] If supplied, only deals matching the given user will be returned. However, `filter_id` and `owned_by_you` takes precedence over `user_id` when supplied.
|
1659
1925
|
* @param {number} [filter_id] The ID of the filter to use
|
@@ -1663,7 +1929,7 @@ export const DealsApiFp = function (configuration) {
|
|
1663
1929
|
* @param {number} [limit] Items shown per page
|
1664
1930
|
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
1665
1931
|
* @param {0 | 1} [owned_by_you] When supplied, only deals owned by you are returned. However, `filter_id` takes precedence over `owned_by_you` when both are supplied.
|
1666
|
-
|
1932
|
+
* @deprecated
|
1667
1933
|
* @throws {RequiredError}
|
1668
1934
|
*/
|
1669
1935
|
getDeals(user_id, filter_id, stage_id, status, start, limit, sort, owned_by_you) {
|
@@ -1673,8 +1939,8 @@ export const DealsApiFp = function (configuration) {
|
|
1673
1939
|
});
|
1674
1940
|
},
|
1675
1941
|
/**
|
1676
|
-
* Returns all deals.
|
1677
|
-
* @summary Get all deals
|
1942
|
+
* Returns all deals. Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeals\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/deals</a> instead.
|
1943
|
+
* @summary Get all deals collection
|
1678
1944
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
1679
1945
|
* @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.
|
1680
1946
|
* @param {string} [since] The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
|
@@ -1682,7 +1948,7 @@ export const DealsApiFp = function (configuration) {
|
|
1682
1948
|
* @param {number} [user_id] If supplied, only deals matching the given user will be returned
|
1683
1949
|
* @param {number} [stage_id] If supplied, only deals within the given stage will be returned
|
1684
1950
|
* @param {'open' | 'won' | 'lost' | 'deleted'} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included.
|
1685
|
-
|
1951
|
+
* @deprecated
|
1686
1952
|
* @throws {RequiredError}
|
1687
1953
|
*/
|
1688
1954
|
getDealsCollection(cursor, limit, since, until, user_id, stage_id, status) {
|
@@ -1692,7 +1958,7 @@ export const DealsApiFp = function (configuration) {
|
|
1692
1958
|
});
|
1693
1959
|
},
|
1694
1960
|
/**
|
1695
|
-
* Returns a summary of all
|
1961
|
+
* Returns a summary of all not archived deals.
|
1696
1962
|
* @summary Get deals summary
|
1697
1963
|
* @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.
|
1698
1964
|
* @param {number} [filter_id] <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
|
@@ -1709,7 +1975,7 @@ export const DealsApiFp = function (configuration) {
|
|
1709
1975
|
});
|
1710
1976
|
},
|
1711
1977
|
/**
|
1712
|
-
* Returns open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
|
1978
|
+
* Returns not archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
|
1713
1979
|
* @summary Get deals timeline
|
1714
1980
|
* @param {string} start_date The date when the first interval starts. Format: YYYY-MM-DD.
|
1715
1981
|
* @param {'day' | 'week' | 'month' | 'quarter'} interval The type of the interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>`day`</td><td>Day</td></tr><tr><td>`week`</td><td>A full week (7 days) starting from `start_date`</td></tr><tr><td>`month`</td><td>A full month (depending on the number of days in given month) starting from `start_date`</td></tr><tr><td>`quarter`</td><td>A full quarter (3 months) starting from `start_date`</td></tr></table>
|
@@ -1755,7 +2021,7 @@ export const DealsApiFp = function (configuration) {
|
|
1755
2021
|
* @param {'deal.cc_email'} [include_fields] Supports including optional fields in the results which are not provided by default
|
1756
2022
|
* @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
|
1757
2023
|
* @param {number} [limit] Items shown per page
|
1758
|
-
|
2024
|
+
* @deprecated
|
1759
2025
|
* @throws {RequiredError}
|
1760
2026
|
*/
|
1761
2027
|
searchDeals(term, fields, exact_match, person_id, organization_id, status, include_fields, start, limit) {
|
@@ -1769,7 +2035,7 @@ export const DealsApiFp = function (configuration) {
|
|
1769
2035
|
* @summary Update a deal
|
1770
2036
|
* @param {number} id The ID of the deal
|
1771
2037
|
* @param {UpdateDealRequest} [UpdateDealRequest]
|
1772
|
-
|
2038
|
+
* @deprecated
|
1773
2039
|
* @throws {RequiredError}
|
1774
2040
|
*/
|
1775
2041
|
updateDeal(id, UpdateDealRequest) {
|
@@ -1784,7 +2050,7 @@ export const DealsApiFp = function (configuration) {
|
|
1784
2050
|
* @param {number} id The ID of the deal
|
1785
2051
|
* @param {number} product_attachment_id The ID of the deal-product (the ID of the product attached to the deal)
|
1786
2052
|
* @param {UpdateDealProductRequest} [UpdateDealProductRequest]
|
1787
|
-
|
2053
|
+
* @deprecated
|
1788
2054
|
* @throws {RequiredError}
|
1789
2055
|
*/
|
1790
2056
|
updateDealProduct(id, product_attachment_id, UpdateDealProductRequest) {
|
@@ -1806,7 +2072,7 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
1806
2072
|
* Adds a new deal. All deals created through the Pipedrive API will have a `origin` set to `API`. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the dealFields and look for `key` values. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/creating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">adding a deal</a>.
|
1807
2073
|
* @summary Add a deal
|
1808
2074
|
* @param {DealsApiAddDealRequest} requestParameters Request parameters.
|
1809
|
-
|
2075
|
+
* @deprecated
|
1810
2076
|
* @throws {RequiredError}
|
1811
2077
|
*/
|
1812
2078
|
addDeal(requestParameters = {}) {
|
@@ -1836,7 +2102,7 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
1836
2102
|
* Adds a product to a deal, creating a new item called a deal-product.
|
1837
2103
|
* @summary Add a product to a deal
|
1838
2104
|
* @param {DealsApiAddDealProductRequest} requestParameters Request parameters.
|
1839
|
-
|
2105
|
+
* @deprecated
|
1840
2106
|
* @throws {RequiredError}
|
1841
2107
|
*/
|
1842
2108
|
addDealProduct(requestParameters) {
|
@@ -1846,7 +2112,7 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
1846
2112
|
* Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
|
1847
2113
|
* @summary Delete a deal
|
1848
2114
|
* @param {DealsApiDeleteDealRequest} requestParameters Request parameters.
|
1849
|
-
|
2115
|
+
* @deprecated
|
1850
2116
|
* @throws {RequiredError}
|
1851
2117
|
*/
|
1852
2118
|
deleteDeal(requestParameters) {
|
@@ -1876,17 +2142,17 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
1876
2142
|
* Deletes a product attachment from a deal, using the `product_attachment_id` Not possible to delete the attached product if the deal has installments associated and the product is the last one enabled
|
1877
2143
|
* @summary Delete an attached product from a deal
|
1878
2144
|
* @param {DealsApiDeleteDealProductRequest} requestParameters Request parameters.
|
1879
|
-
|
2145
|
+
* @deprecated
|
1880
2146
|
* @throws {RequiredError}
|
1881
2147
|
*/
|
1882
2148
|
deleteDealProduct(requestParameters) {
|
1883
2149
|
return localVarFp.deleteDealProduct(requestParameters.id, requestParameters.product_attachment_id).then((request) => request(axios, basePath));
|
1884
2150
|
},
|
1885
2151
|
/**
|
1886
|
-
* Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.
|
2152
|
+
* Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#deleteDeal\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/deals/{id}</a> instead.
|
1887
2153
|
* @summary Delete multiple deals in bulk
|
1888
2154
|
* @param {DealsApiDeleteDealsRequest} requestParameters Request parameters.
|
1889
|
-
|
2155
|
+
* @deprecated
|
1890
2156
|
* @throws {RequiredError}
|
1891
2157
|
*/
|
1892
2158
|
deleteDeals(requestParameters) {
|
@@ -1902,21 +2168,51 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
1902
2168
|
duplicateDeal(requestParameters) {
|
1903
2169
|
return localVarFp.duplicateDeal(requestParameters.id).then((request) => request(axios, basePath));
|
1904
2170
|
},
|
2171
|
+
/**
|
2172
|
+
* Returns all archived deals.
|
2173
|
+
* @summary Get all archived deals
|
2174
|
+
* @param {DealsApiGetArchivedDealsRequest} requestParameters Request parameters.
|
2175
|
+
* @deprecated
|
2176
|
+
* @throws {RequiredError}
|
2177
|
+
*/
|
2178
|
+
getArchivedDeals(requestParameters = {}) {
|
2179
|
+
return localVarFp.getArchivedDeals(requestParameters.user_id, requestParameters.filter_id, requestParameters.person_id, requestParameters.org_id, requestParameters.product_id, requestParameters.pipeline_id, requestParameters.stage_id, requestParameters.status, requestParameters.start, requestParameters.limit, requestParameters.sort, requestParameters.owned_by_you).then((request) => request(axios, basePath));
|
2180
|
+
},
|
2181
|
+
/**
|
2182
|
+
* Returns a summary of all archived deals.
|
2183
|
+
* @summary Get archived deals summary
|
2184
|
+
* @param {DealsApiGetArchivedDealsSummaryRequest} requestParameters Request parameters.
|
2185
|
+
* @deprecated
|
2186
|
+
* @throws {RequiredError}
|
2187
|
+
*/
|
2188
|
+
getArchivedDealsSummary(requestParameters = {}) {
|
2189
|
+
return localVarFp.getArchivedDealsSummary(requestParameters.status, requestParameters.filter_id, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.stage_id).then((request) => request(axios, basePath));
|
2190
|
+
},
|
2191
|
+
/**
|
2192
|
+
* Returns archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
|
2193
|
+
* @summary Get archived deals timeline
|
2194
|
+
* @param {DealsApiGetArchivedDealsTimelineRequest} requestParameters Request parameters.
|
2195
|
+
* @deprecated
|
2196
|
+
* @throws {RequiredError}
|
2197
|
+
*/
|
2198
|
+
getArchivedDealsTimeline(requestParameters) {
|
2199
|
+
return localVarFp.getArchivedDealsTimeline(requestParameters.start_date, requestParameters.interval, requestParameters.amount, requestParameters.field_key, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.filter_id, requestParameters.exclude_deals, requestParameters.totals_convert_currency).then((request) => request(axios, basePath));
|
2200
|
+
},
|
1905
2201
|
/**
|
1906
2202
|
* Returns the details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of dealFields. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-details-of-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">getting details of a deal</a>.
|
1907
2203
|
* @summary Get details of a deal
|
1908
2204
|
* @param {DealsApiGetDealRequest} requestParameters Request parameters.
|
1909
|
-
|
2205
|
+
* @deprecated
|
1910
2206
|
* @throws {RequiredError}
|
1911
2207
|
*/
|
1912
2208
|
getDeal(requestParameters) {
|
1913
2209
|
return localVarFp.getDeal(requestParameters.id).then((request) => request(axios, basePath));
|
1914
2210
|
},
|
1915
2211
|
/**
|
1916
|
-
* Lists activities associated with a deal.
|
2212
|
+
* Lists activities associated with a deal. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivities\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/activities?deal_id={id}</a> instead.
|
1917
2213
|
* @summary List activities associated with a deal
|
1918
2214
|
* @param {DealsApiGetDealActivitiesRequest} requestParameters Request parameters.
|
1919
|
-
|
2215
|
+
* @deprecated
|
1920
2216
|
* @throws {RequiredError}
|
1921
2217
|
*/
|
1922
2218
|
getDealActivities(requestParameters) {
|
@@ -1983,10 +2279,10 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
1983
2279
|
return localVarFp.getDealParticipantsChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
1984
2280
|
},
|
1985
2281
|
/**
|
1986
|
-
* Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
|
2282
|
+
* Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersons\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/persons?deal_id={id}</a> instead.
|
1987
2283
|
* @summary List all persons associated with a deal
|
1988
2284
|
* @param {DealsApiGetDealPersonsRequest} requestParameters Request parameters.
|
1989
|
-
|
2285
|
+
* @deprecated
|
1990
2286
|
* @throws {RequiredError}
|
1991
2287
|
*/
|
1992
2288
|
getDealPersons(requestParameters) {
|
@@ -1996,7 +2292,7 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
1996
2292
|
* Lists products attached to a deal.
|
1997
2293
|
* @summary List products attached to a deal
|
1998
2294
|
* @param {DealsApiGetDealProductsRequest} requestParameters Request parameters.
|
1999
|
-
|
2295
|
+
* @deprecated
|
2000
2296
|
* @throws {RequiredError}
|
2001
2297
|
*/
|
2002
2298
|
getDealProducts(requestParameters) {
|
@@ -2023,27 +2319,27 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
2023
2319
|
return localVarFp.getDealUsers(requestParameters.id).then((request) => request(axios, basePath));
|
2024
2320
|
},
|
2025
2321
|
/**
|
2026
|
-
* Returns all deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
|
2322
|
+
* Returns all not archived deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
|
2027
2323
|
* @summary Get all deals
|
2028
2324
|
* @param {DealsApiGetDealsRequest} requestParameters Request parameters.
|
2029
|
-
|
2325
|
+
* @deprecated
|
2030
2326
|
* @throws {RequiredError}
|
2031
2327
|
*/
|
2032
2328
|
getDeals(requestParameters = {}) {
|
2033
2329
|
return localVarFp.getDeals(requestParameters.user_id, requestParameters.filter_id, requestParameters.stage_id, requestParameters.status, requestParameters.start, requestParameters.limit, requestParameters.sort, requestParameters.owned_by_you).then((request) => request(axios, basePath));
|
2034
2330
|
},
|
2035
2331
|
/**
|
2036
|
-
* Returns all deals.
|
2037
|
-
* @summary Get all deals
|
2332
|
+
* Returns all deals. Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeals\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/deals</a> instead.
|
2333
|
+
* @summary Get all deals collection
|
2038
2334
|
* @param {DealsApiGetDealsCollectionRequest} requestParameters Request parameters.
|
2039
|
-
|
2335
|
+
* @deprecated
|
2040
2336
|
* @throws {RequiredError}
|
2041
2337
|
*/
|
2042
2338
|
getDealsCollection(requestParameters = {}) {
|
2043
2339
|
return localVarFp.getDealsCollection(requestParameters.cursor, requestParameters.limit, requestParameters.since, requestParameters.until, requestParameters.user_id, requestParameters.stage_id, requestParameters.status).then((request) => request(axios, basePath));
|
2044
2340
|
},
|
2045
2341
|
/**
|
2046
|
-
* Returns a summary of all
|
2342
|
+
* Returns a summary of all not archived deals.
|
2047
2343
|
* @summary Get deals summary
|
2048
2344
|
* @param {DealsApiGetDealsSummaryRequest} requestParameters Request parameters.
|
2049
2345
|
|
@@ -2053,7 +2349,7 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
2053
2349
|
return localVarFp.getDealsSummary(requestParameters.status, requestParameters.filter_id, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.stage_id).then((request) => request(axios, basePath));
|
2054
2350
|
},
|
2055
2351
|
/**
|
2056
|
-
* Returns open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
|
2352
|
+
* Returns not archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
|
2057
2353
|
* @summary Get deals timeline
|
2058
2354
|
* @param {DealsApiGetDealsTimelineRequest} requestParameters Request parameters.
|
2059
2355
|
|
@@ -2076,7 +2372,7 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
2076
2372
|
* 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.
|
2077
2373
|
* @summary Search deals
|
2078
2374
|
* @param {DealsApiSearchDealsRequest} requestParameters Request parameters.
|
2079
|
-
|
2375
|
+
* @deprecated
|
2080
2376
|
* @throws {RequiredError}
|
2081
2377
|
*/
|
2082
2378
|
searchDeals(requestParameters) {
|
@@ -2086,7 +2382,7 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
2086
2382
|
* Updates the properties of a deal. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/updating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">updating a deal</a>.
|
2087
2383
|
* @summary Update a deal
|
2088
2384
|
* @param {DealsApiUpdateDealRequest} requestParameters Request parameters.
|
2089
|
-
|
2385
|
+
* @deprecated
|
2090
2386
|
* @throws {RequiredError}
|
2091
2387
|
*/
|
2092
2388
|
updateDeal(requestParameters) {
|
@@ -2096,7 +2392,7 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
2096
2392
|
* Updates the details of the product that has been attached to a deal.
|
2097
2393
|
* @summary Update the product attached to a deal
|
2098
2394
|
* @param {DealsApiUpdateDealProductRequest} requestParameters Request parameters.
|
2099
|
-
|
2395
|
+
* @deprecated
|
2100
2396
|
* @throws {RequiredError}
|
2101
2397
|
*/
|
2102
2398
|
updateDealProduct(requestParameters) {
|
@@ -2115,7 +2411,7 @@ export class DealsApi extends BaseAPI {
|
|
2115
2411
|
* Adds a new deal. All deals created through the Pipedrive API will have a `origin` set to `API`. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the dealFields and look for `key` values. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/creating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">adding a deal</a>.
|
2116
2412
|
* @summary Add a deal
|
2117
2413
|
* @param {DealsApiAddDealRequest} requestParameters Request parameters.
|
2118
|
-
|
2414
|
+
* @deprecated
|
2119
2415
|
* @throws {RequiredError}
|
2120
2416
|
* @memberof DealsApi
|
2121
2417
|
*/
|
@@ -2148,7 +2444,7 @@ export class DealsApi extends BaseAPI {
|
|
2148
2444
|
* Adds a product to a deal, creating a new item called a deal-product.
|
2149
2445
|
* @summary Add a product to a deal
|
2150
2446
|
* @param {DealsApiAddDealProductRequest} requestParameters Request parameters.
|
2151
|
-
|
2447
|
+
* @deprecated
|
2152
2448
|
* @throws {RequiredError}
|
2153
2449
|
* @memberof DealsApi
|
2154
2450
|
*/
|
@@ -2159,7 +2455,7 @@ export class DealsApi extends BaseAPI {
|
|
2159
2455
|
* Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
|
2160
2456
|
* @summary Delete a deal
|
2161
2457
|
* @param {DealsApiDeleteDealRequest} requestParameters Request parameters.
|
2162
|
-
|
2458
|
+
* @deprecated
|
2163
2459
|
* @throws {RequiredError}
|
2164
2460
|
* @memberof DealsApi
|
2165
2461
|
*/
|
@@ -2192,7 +2488,7 @@ export class DealsApi extends BaseAPI {
|
|
2192
2488
|
* Deletes a product attachment from a deal, using the `product_attachment_id` Not possible to delete the attached product if the deal has installments associated and the product is the last one enabled
|
2193
2489
|
* @summary Delete an attached product from a deal
|
2194
2490
|
* @param {DealsApiDeleteDealProductRequest} requestParameters Request parameters.
|
2195
|
-
|
2491
|
+
* @deprecated
|
2196
2492
|
* @throws {RequiredError}
|
2197
2493
|
* @memberof DealsApi
|
2198
2494
|
*/
|
@@ -2200,10 +2496,10 @@ export class DealsApi extends BaseAPI {
|
|
2200
2496
|
return DealsApiFp(this.configuration).deleteDealProduct(requestParameters.id, requestParameters.product_attachment_id).then((request) => request(this.axios, this.basePath));
|
2201
2497
|
}
|
2202
2498
|
/**
|
2203
|
-
* Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.
|
2499
|
+
* Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#deleteDeal\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/deals/{id}</a> instead.
|
2204
2500
|
* @summary Delete multiple deals in bulk
|
2205
2501
|
* @param {DealsApiDeleteDealsRequest} requestParameters Request parameters.
|
2206
|
-
|
2502
|
+
* @deprecated
|
2207
2503
|
* @throws {RequiredError}
|
2208
2504
|
* @memberof DealsApi
|
2209
2505
|
*/
|
@@ -2221,11 +2517,44 @@ export class DealsApi extends BaseAPI {
|
|
2221
2517
|
duplicateDeal(requestParameters) {
|
2222
2518
|
return DealsApiFp(this.configuration).duplicateDeal(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
2223
2519
|
}
|
2520
|
+
/**
|
2521
|
+
* Returns all archived deals.
|
2522
|
+
* @summary Get all archived deals
|
2523
|
+
* @param {DealsApiGetArchivedDealsRequest} requestParameters Request parameters.
|
2524
|
+
* @deprecated
|
2525
|
+
* @throws {RequiredError}
|
2526
|
+
* @memberof DealsApi
|
2527
|
+
*/
|
2528
|
+
getArchivedDeals(requestParameters = {}) {
|
2529
|
+
return DealsApiFp(this.configuration).getArchivedDeals(requestParameters.user_id, requestParameters.filter_id, requestParameters.person_id, requestParameters.org_id, requestParameters.product_id, requestParameters.pipeline_id, requestParameters.stage_id, requestParameters.status, requestParameters.start, requestParameters.limit, requestParameters.sort, requestParameters.owned_by_you).then((request) => request(this.axios, this.basePath));
|
2530
|
+
}
|
2531
|
+
/**
|
2532
|
+
* Returns a summary of all archived deals.
|
2533
|
+
* @summary Get archived deals summary
|
2534
|
+
* @param {DealsApiGetArchivedDealsSummaryRequest} requestParameters Request parameters.
|
2535
|
+
* @deprecated
|
2536
|
+
* @throws {RequiredError}
|
2537
|
+
* @memberof DealsApi
|
2538
|
+
*/
|
2539
|
+
getArchivedDealsSummary(requestParameters = {}) {
|
2540
|
+
return DealsApiFp(this.configuration).getArchivedDealsSummary(requestParameters.status, requestParameters.filter_id, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.stage_id).then((request) => request(this.axios, this.basePath));
|
2541
|
+
}
|
2542
|
+
/**
|
2543
|
+
* Returns archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
|
2544
|
+
* @summary Get archived deals timeline
|
2545
|
+
* @param {DealsApiGetArchivedDealsTimelineRequest} requestParameters Request parameters.
|
2546
|
+
* @deprecated
|
2547
|
+
* @throws {RequiredError}
|
2548
|
+
* @memberof DealsApi
|
2549
|
+
*/
|
2550
|
+
getArchivedDealsTimeline(requestParameters) {
|
2551
|
+
return DealsApiFp(this.configuration).getArchivedDealsTimeline(requestParameters.start_date, requestParameters.interval, requestParameters.amount, requestParameters.field_key, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.filter_id, requestParameters.exclude_deals, requestParameters.totals_convert_currency).then((request) => request(this.axios, this.basePath));
|
2552
|
+
}
|
2224
2553
|
/**
|
2225
2554
|
* Returns the details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of dealFields. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-details-of-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">getting details of a deal</a>.
|
2226
2555
|
* @summary Get details of a deal
|
2227
2556
|
* @param {DealsApiGetDealRequest} requestParameters Request parameters.
|
2228
|
-
|
2557
|
+
* @deprecated
|
2229
2558
|
* @throws {RequiredError}
|
2230
2559
|
* @memberof DealsApi
|
2231
2560
|
*/
|
@@ -2233,10 +2562,10 @@ export class DealsApi extends BaseAPI {
|
|
2233
2562
|
return DealsApiFp(this.configuration).getDeal(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
2234
2563
|
}
|
2235
2564
|
/**
|
2236
|
-
* Lists activities associated with a deal.
|
2565
|
+
* Lists activities associated with a deal. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivities\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/activities?deal_id={id}</a> instead.
|
2237
2566
|
* @summary List activities associated with a deal
|
2238
2567
|
* @param {DealsApiGetDealActivitiesRequest} requestParameters Request parameters.
|
2239
|
-
|
2568
|
+
* @deprecated
|
2240
2569
|
* @throws {RequiredError}
|
2241
2570
|
* @memberof DealsApi
|
2242
2571
|
*/
|
@@ -2310,10 +2639,10 @@ export class DealsApi extends BaseAPI {
|
|
2310
2639
|
return DealsApiFp(this.configuration).getDealParticipantsChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
2311
2640
|
}
|
2312
2641
|
/**
|
2313
|
-
* Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
|
2642
|
+
* Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersons\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/persons?deal_id={id}</a> instead.
|
2314
2643
|
* @summary List all persons associated with a deal
|
2315
2644
|
* @param {DealsApiGetDealPersonsRequest} requestParameters Request parameters.
|
2316
|
-
|
2645
|
+
* @deprecated
|
2317
2646
|
* @throws {RequiredError}
|
2318
2647
|
* @memberof DealsApi
|
2319
2648
|
*/
|
@@ -2324,7 +2653,7 @@ export class DealsApi extends BaseAPI {
|
|
2324
2653
|
* Lists products attached to a deal.
|
2325
2654
|
* @summary List products attached to a deal
|
2326
2655
|
* @param {DealsApiGetDealProductsRequest} requestParameters Request parameters.
|
2327
|
-
|
2656
|
+
* @deprecated
|
2328
2657
|
* @throws {RequiredError}
|
2329
2658
|
* @memberof DealsApi
|
2330
2659
|
*/
|
@@ -2354,10 +2683,10 @@ export class DealsApi extends BaseAPI {
|
|
2354
2683
|
return DealsApiFp(this.configuration).getDealUsers(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
2355
2684
|
}
|
2356
2685
|
/**
|
2357
|
-
* Returns all deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
|
2686
|
+
* Returns all not archived deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
|
2358
2687
|
* @summary Get all deals
|
2359
2688
|
* @param {DealsApiGetDealsRequest} requestParameters Request parameters.
|
2360
|
-
|
2689
|
+
* @deprecated
|
2361
2690
|
* @throws {RequiredError}
|
2362
2691
|
* @memberof DealsApi
|
2363
2692
|
*/
|
@@ -2365,10 +2694,10 @@ export class DealsApi extends BaseAPI {
|
|
2365
2694
|
return DealsApiFp(this.configuration).getDeals(requestParameters.user_id, requestParameters.filter_id, requestParameters.stage_id, requestParameters.status, requestParameters.start, requestParameters.limit, requestParameters.sort, requestParameters.owned_by_you).then((request) => request(this.axios, this.basePath));
|
2366
2695
|
}
|
2367
2696
|
/**
|
2368
|
-
* Returns all deals.
|
2369
|
-
* @summary Get all deals
|
2697
|
+
* Returns all deals. Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeals\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/deals</a> instead.
|
2698
|
+
* @summary Get all deals collection
|
2370
2699
|
* @param {DealsApiGetDealsCollectionRequest} requestParameters Request parameters.
|
2371
|
-
|
2700
|
+
* @deprecated
|
2372
2701
|
* @throws {RequiredError}
|
2373
2702
|
* @memberof DealsApi
|
2374
2703
|
*/
|
@@ -2376,7 +2705,7 @@ export class DealsApi extends BaseAPI {
|
|
2376
2705
|
return DealsApiFp(this.configuration).getDealsCollection(requestParameters.cursor, requestParameters.limit, requestParameters.since, requestParameters.until, requestParameters.user_id, requestParameters.stage_id, requestParameters.status).then((request) => request(this.axios, this.basePath));
|
2377
2706
|
}
|
2378
2707
|
/**
|
2379
|
-
* Returns a summary of all
|
2708
|
+
* Returns a summary of all not archived deals.
|
2380
2709
|
* @summary Get deals summary
|
2381
2710
|
* @param {DealsApiGetDealsSummaryRequest} requestParameters Request parameters.
|
2382
2711
|
|
@@ -2387,7 +2716,7 @@ export class DealsApi extends BaseAPI {
|
|
2387
2716
|
return DealsApiFp(this.configuration).getDealsSummary(requestParameters.status, requestParameters.filter_id, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.stage_id).then((request) => request(this.axios, this.basePath));
|
2388
2717
|
}
|
2389
2718
|
/**
|
2390
|
-
* Returns open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
|
2719
|
+
* Returns not archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
|
2391
2720
|
* @summary Get deals timeline
|
2392
2721
|
* @param {DealsApiGetDealsTimelineRequest} requestParameters Request parameters.
|
2393
2722
|
|
@@ -2412,7 +2741,7 @@ export class DealsApi extends BaseAPI {
|
|
2412
2741
|
* 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.
|
2413
2742
|
* @summary Search deals
|
2414
2743
|
* @param {DealsApiSearchDealsRequest} requestParameters Request parameters.
|
2415
|
-
|
2744
|
+
* @deprecated
|
2416
2745
|
* @throws {RequiredError}
|
2417
2746
|
* @memberof DealsApi
|
2418
2747
|
*/
|
@@ -2423,7 +2752,7 @@ export class DealsApi extends BaseAPI {
|
|
2423
2752
|
* Updates the properties of a deal. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/updating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">updating a deal</a>.
|
2424
2753
|
* @summary Update a deal
|
2425
2754
|
* @param {DealsApiUpdateDealRequest} requestParameters Request parameters.
|
2426
|
-
|
2755
|
+
* @deprecated
|
2427
2756
|
* @throws {RequiredError}
|
2428
2757
|
* @memberof DealsApi
|
2429
2758
|
*/
|
@@ -2434,7 +2763,7 @@ export class DealsApi extends BaseAPI {
|
|
2434
2763
|
* Updates the details of the product that has been attached to a deal.
|
2435
2764
|
* @summary Update the product attached to a deal
|
2436
2765
|
* @param {DealsApiUpdateDealProductRequest} requestParameters Request parameters.
|
2437
|
-
|
2766
|
+
* @deprecated
|
2438
2767
|
* @throws {RequiredError}
|
2439
2768
|
* @memberof DealsApi
|
2440
2769
|
*/
|