pipedrive 25.0.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.
Files changed (141) hide show
  1. package/dist/esm/versions/v1/api/activities-api.d.ts +40 -40
  2. package/dist/esm/versions/v1/api/activities-api.js +40 -40
  3. package/dist/esm/versions/v1/api/deals-api.d.ts +410 -88
  4. package/dist/esm/versions/v1/api/deals-api.js +417 -88
  5. package/dist/esm/versions/v1/api/item-search-api.d.ts +8 -8
  6. package/dist/esm/versions/v1/api/item-search-api.js +8 -8
  7. package/dist/esm/versions/v1/api/leads-api.d.ts +100 -14
  8. package/dist/esm/versions/v1/api/leads-api.js +107 -14
  9. package/dist/esm/versions/v1/api/notes-api.d.ts +18 -2
  10. package/dist/esm/versions/v1/api/notes-api.js +15 -5
  11. package/dist/esm/versions/v1/api/organizations-api.d.ts +68 -68
  12. package/dist/esm/versions/v1/api/organizations-api.js +68 -68
  13. package/dist/esm/versions/v1/api/persons-api.d.ts +56 -56
  14. package/dist/esm/versions/v1/api/persons-api.js +56 -56
  15. package/dist/esm/versions/v1/api/pipelines-api.d.ts +28 -28
  16. package/dist/esm/versions/v1/api/pipelines-api.js +28 -28
  17. package/dist/esm/versions/v1/api/products-api.d.ts +24 -24
  18. package/dist/esm/versions/v1/api/products-api.js +24 -24
  19. package/dist/esm/versions/v1/api/stages-api.d.ts +36 -36
  20. package/dist/esm/versions/v1/api/stages-api.js +36 -36
  21. package/dist/esm/versions/v1/base.d.ts +2 -3
  22. package/dist/esm/versions/v1/configuration.d.ts +2 -2
  23. package/dist/esm/versions/v1/models/add-note-request-all-of.d.ts +9 -4
  24. package/dist/esm/versions/v1/models/add-note-request-all-of1.d.ts +10 -0
  25. package/dist/esm/versions/v1/models/add-note-request-all-of1.js +4 -0
  26. package/dist/esm/versions/v1/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -0
  27. package/dist/esm/versions/v1/models/index.d.ts +1 -0
  28. package/dist/esm/versions/v1/models/index.js +1 -0
  29. package/dist/esm/versions/v1/models/note-project.d.ts +23 -0
  30. package/dist/esm/versions/v1/models/note-project.js +14 -0
  31. package/dist/esm/versions/v1/models/note-request-all-of1.d.ts +5 -0
  32. package/dist/esm/versions/v1/models/note.d.ts +16 -0
  33. package/dist/esm/versions/v2/api/activities-api.d.ts +15 -7
  34. package/dist/esm/versions/v2/api/activities-api.js +12 -7
  35. package/dist/esm/versions/v2/api/beta-api.d.ts +212 -0
  36. package/dist/esm/versions/v2/api/beta-api.js +286 -0
  37. package/dist/esm/versions/v2/api/deals-api.d.ts +272 -4
  38. package/dist/esm/versions/v2/api/deals-api.js +288 -4
  39. package/dist/esm/versions/v2/api/leads-api.d.ts +111 -0
  40. package/dist/esm/versions/v2/api/leads-api.js +146 -1
  41. package/dist/esm/versions/v2/api/persons-api.d.ts +8 -8
  42. package/dist/esm/versions/v2/api/persons-api.js +8 -8
  43. package/dist/esm/versions/v2/api/products-api.js +1 -1
  44. package/dist/esm/versions/v2/base.d.ts +2 -3
  45. package/dist/esm/versions/v2/configuration.d.ts +2 -2
  46. package/dist/esm/versions/v2/models/activity-item.d.ts +5 -0
  47. package/dist/esm/versions/v2/models/activity-item1.d.ts +5 -0
  48. package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response-data.d.ts +23 -0
  49. package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response-data.js +14 -0
  50. package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response.d.ts +34 -0
  51. package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response.js +14 -0
  52. package/dist/esm/versions/v2/models/add-convert-lead-to-deal-response.d.ts +34 -0
  53. package/dist/esm/versions/v2/models/add-convert-lead-to-deal-response.js +14 -0
  54. package/dist/esm/versions/v2/models/add-person-request.d.ts +12 -0
  55. package/dist/esm/versions/v2/models/add-person-request.js +6 -1
  56. package/dist/esm/versions/v2/models/convert-lead-to-deal-request.d.ts +28 -0
  57. package/dist/esm/versions/v2/models/convert-lead-to-deal-request.js +14 -0
  58. package/dist/esm/versions/v2/models/deal-item.d.ts +5 -0
  59. package/dist/esm/versions/v2/models/deal-item1.d.ts +5 -0
  60. package/dist/esm/versions/v2/models/get-convert-response.d.ts +43 -0
  61. package/dist/esm/versions/v2/models/get-convert-response.js +14 -0
  62. package/dist/esm/versions/v2/models/get-convert-response1-data.d.ts +46 -0
  63. package/dist/esm/versions/v2/models/get-convert-response1-data.js +20 -0
  64. package/dist/esm/versions/v2/models/get-convert-response1.d.ts +34 -0
  65. package/dist/esm/versions/v2/models/get-convert-response1.js +14 -0
  66. package/dist/esm/versions/v2/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -0
  67. package/dist/esm/versions/v2/models/index.d.ts +7 -0
  68. package/dist/esm/versions/v2/models/index.js +7 -0
  69. package/dist/esm/versions/v2/models/update-person-request.d.ts +12 -0
  70. package/dist/esm/versions/v2/models/update-person-request.js +6 -1
  71. package/dist/versions/v1/api/activities-api.d.ts +40 -40
  72. package/dist/versions/v1/api/activities-api.js +40 -40
  73. package/dist/versions/v1/api/deals-api.d.ts +410 -88
  74. package/dist/versions/v1/api/deals-api.js +417 -88
  75. package/dist/versions/v1/api/item-search-api.d.ts +8 -8
  76. package/dist/versions/v1/api/item-search-api.js +8 -8
  77. package/dist/versions/v1/api/leads-api.d.ts +100 -14
  78. package/dist/versions/v1/api/leads-api.js +107 -14
  79. package/dist/versions/v1/api/notes-api.d.ts +18 -2
  80. package/dist/versions/v1/api/notes-api.js +15 -5
  81. package/dist/versions/v1/api/organizations-api.d.ts +68 -68
  82. package/dist/versions/v1/api/organizations-api.js +68 -68
  83. package/dist/versions/v1/api/persons-api.d.ts +56 -56
  84. package/dist/versions/v1/api/persons-api.js +56 -56
  85. package/dist/versions/v1/api/pipelines-api.d.ts +28 -28
  86. package/dist/versions/v1/api/pipelines-api.js +28 -28
  87. package/dist/versions/v1/api/products-api.d.ts +24 -24
  88. package/dist/versions/v1/api/products-api.js +24 -24
  89. package/dist/versions/v1/api/stages-api.d.ts +36 -36
  90. package/dist/versions/v1/api/stages-api.js +36 -36
  91. package/dist/versions/v1/base.d.ts +2 -3
  92. package/dist/versions/v1/configuration.d.ts +2 -2
  93. package/dist/versions/v1/models/add-note-request-all-of.d.ts +9 -4
  94. package/dist/versions/v1/models/add-note-request-all-of1.d.ts +10 -0
  95. package/dist/versions/v1/models/add-note-request-all-of1.js +5 -1
  96. package/dist/versions/v1/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -0
  97. package/dist/versions/v1/models/index.d.ts +1 -0
  98. package/dist/versions/v1/models/index.js +1 -0
  99. package/dist/versions/v1/models/note-project.d.ts +23 -0
  100. package/dist/versions/v1/models/note-project.js +15 -0
  101. package/dist/versions/v1/models/note-request-all-of1.d.ts +5 -0
  102. package/dist/versions/v1/models/note.d.ts +16 -0
  103. package/dist/versions/v2/api/activities-api.d.ts +15 -7
  104. package/dist/versions/v2/api/activities-api.js +12 -7
  105. package/dist/versions/v2/api/beta-api.d.ts +212 -0
  106. package/dist/versions/v2/api/beta-api.js +286 -0
  107. package/dist/versions/v2/api/deals-api.d.ts +272 -4
  108. package/dist/versions/v2/api/deals-api.js +288 -4
  109. package/dist/versions/v2/api/leads-api.d.ts +111 -0
  110. package/dist/versions/v2/api/leads-api.js +145 -0
  111. package/dist/versions/v2/api/persons-api.d.ts +8 -8
  112. package/dist/versions/v2/api/persons-api.js +8 -8
  113. package/dist/versions/v2/api/products-api.js +1 -1
  114. package/dist/versions/v2/base.d.ts +2 -3
  115. package/dist/versions/v2/configuration.d.ts +2 -2
  116. package/dist/versions/v2/models/activity-item.d.ts +5 -0
  117. package/dist/versions/v2/models/activity-item1.d.ts +5 -0
  118. package/dist/versions/v2/models/add-convert-deal-to-lead-response-data.d.ts +23 -0
  119. package/dist/versions/v2/models/add-convert-deal-to-lead-response-data.js +15 -0
  120. package/dist/versions/v2/models/add-convert-deal-to-lead-response.d.ts +34 -0
  121. package/dist/versions/v2/models/add-convert-deal-to-lead-response.js +15 -0
  122. package/dist/versions/v2/models/add-convert-lead-to-deal-response.d.ts +34 -0
  123. package/dist/versions/v2/models/add-convert-lead-to-deal-response.js +15 -0
  124. package/dist/versions/v2/models/add-person-request.d.ts +12 -0
  125. package/dist/versions/v2/models/add-person-request.js +7 -0
  126. package/dist/versions/v2/models/convert-lead-to-deal-request.d.ts +28 -0
  127. package/dist/versions/v2/models/convert-lead-to-deal-request.js +15 -0
  128. package/dist/versions/v2/models/deal-item.d.ts +5 -0
  129. package/dist/versions/v2/models/deal-item1.d.ts +5 -0
  130. package/dist/versions/v2/models/get-convert-response.d.ts +43 -0
  131. package/dist/versions/v2/models/get-convert-response.js +15 -0
  132. package/dist/versions/v2/models/get-convert-response1-data.d.ts +46 -0
  133. package/dist/versions/v2/models/get-convert-response1-data.js +23 -0
  134. package/dist/versions/v2/models/get-convert-response1.d.ts +34 -0
  135. package/dist/versions/v2/models/get-convert-response1.js +15 -0
  136. package/dist/versions/v2/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -0
  137. package/dist/versions/v2/models/index.d.ts +7 -0
  138. package/dist/versions/v2/models/index.js +7 -0
  139. package/dist/versions/v2/models/update-person-request.d.ts +12 -0
  140. package/dist/versions/v2/models/update-person-request.js +7 -0
  141. package/package.json +1 -1
@@ -42,7 +42,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
42
42
  * 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>.
43
43
  * @summary Add a deal
44
44
  * @param {AddDealRequest} [AddDealRequest]
45
-
45
+ * @deprecated
46
46
  * @throws {RequiredError}
47
47
  */
48
48
  addDeal: (AddDealRequest) => __awaiter(this, void 0, void 0, function* () {
@@ -150,7 +150,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
150
150
  * @summary Add a product to a deal
151
151
  * @param {number} id The ID of the deal
152
152
  * @param {AddDealProductRequest} [AddDealProductRequest]
153
-
153
+ * @deprecated
154
154
  * @throws {RequiredError}
155
155
  */
156
156
  addDealProduct: (id, AddDealProductRequest) => __awaiter(this, void 0, void 0, function* () {
@@ -186,7 +186,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
186
186
  * Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
187
187
  * @summary Delete a deal
188
188
  * @param {number} id The ID of the deal
189
-
189
+ * @deprecated
190
190
  * @throws {RequiredError}
191
191
  */
192
192
  deleteDeal: (id) => __awaiter(this, void 0, void 0, function* () {
@@ -297,7 +297,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
297
297
  * @summary Delete an attached product from a deal
298
298
  * @param {number} id The ID of the deal
299
299
  * @param {number} product_attachment_id The product attachment ID
300
-
300
+ * @deprecated
301
301
  * @throws {RequiredError}
302
302
  */
303
303
  deleteDealProduct: (id, product_attachment_id) => __awaiter(this, void 0, void 0, function* () {
@@ -331,10 +331,10 @@ const DealsApiAxiosParamCreator = function (configuration) {
331
331
  };
332
332
  }),
333
333
  /**
334
- * Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.
334
+ * 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.
335
335
  * @summary Delete multiple deals in bulk
336
336
  * @param {string} ids The comma-separated IDs that will be deleted
337
-
337
+ * @deprecated
338
338
  * @throws {RequiredError}
339
339
  */
340
340
  deleteDeals: (ids) => __awaiter(this, void 0, void 0, function* () {
@@ -400,11 +400,215 @@ const DealsApiAxiosParamCreator = function (configuration) {
400
400
  options: localVarRequestOptions,
401
401
  };
402
402
  }),
403
+ /**
404
+ * Returns all archived deals.
405
+ * @summary Get all archived deals
406
+ * @param {number} [user_id] If supplied, only deals matching the given user will be returned. However, &#x60;filter_id&#x60; and &#x60;owned_by_you&#x60; takes precedence over &#x60;user_id&#x60; when supplied.
407
+ * @param {number} [filter_id] The ID of the filter to use
408
+ * @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
409
+ * @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
410
+ * @param {number} [product_id] If supplied, only deals linked to the specified product are returned. If filter_id is provided, this is ignored.
411
+ * @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
412
+ * @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
413
+ * @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.
414
+ * @param {number} [start] Pagination start
415
+ * @param {number} [limit] Items shown per page
416
+ * @param {string} [sort] The field names and sorting mode separated by a comma (&#x60;field_name_1 ASC&#x60;, &#x60;field_name_2 DESC&#x60;). Only first-level field keys are supported (no nested keys).
417
+ * @param {0 | 1} [owned_by_you] When supplied, only deals owned by you are returned. However, &#x60;filter_id&#x60; takes precedence over &#x60;owned_by_you&#x60; when both are supplied.
418
+ * @deprecated
419
+ * @throws {RequiredError}
420
+ */
421
+ 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* () {
422
+ const localVarPath = `/deals/archived`;
423
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
424
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
425
+ let baseOptions;
426
+ if (configuration) {
427
+ baseOptions = configuration.baseOptions;
428
+ }
429
+ const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
430
+ const localVarHeaderParameter = {};
431
+ const localVarQueryParameter = {};
432
+ // authentication api_key required
433
+ yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
434
+ // authentication oauth2 required
435
+ // oauth required
436
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration);
437
+ if (user_id !== undefined) {
438
+ localVarQueryParameter['user_id'] = user_id;
439
+ }
440
+ if (filter_id !== undefined) {
441
+ localVarQueryParameter['filter_id'] = filter_id;
442
+ }
443
+ if (person_id !== undefined) {
444
+ localVarQueryParameter['person_id'] = person_id;
445
+ }
446
+ if (org_id !== undefined) {
447
+ localVarQueryParameter['org_id'] = org_id;
448
+ }
449
+ if (product_id !== undefined) {
450
+ localVarQueryParameter['product_id'] = product_id;
451
+ }
452
+ if (pipeline_id !== undefined) {
453
+ localVarQueryParameter['pipeline_id'] = pipeline_id;
454
+ }
455
+ if (stage_id !== undefined) {
456
+ localVarQueryParameter['stage_id'] = stage_id;
457
+ }
458
+ if (status !== undefined) {
459
+ localVarQueryParameter['status'] = status;
460
+ }
461
+ if (start !== undefined) {
462
+ localVarQueryParameter['start'] = start;
463
+ }
464
+ if (limit !== undefined) {
465
+ localVarQueryParameter['limit'] = limit;
466
+ }
467
+ if (sort !== undefined) {
468
+ localVarQueryParameter['sort'] = sort;
469
+ }
470
+ if (owned_by_you !== undefined) {
471
+ localVarQueryParameter['owned_by_you'] = owned_by_you;
472
+ }
473
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
474
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
475
+ localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
476
+ return {
477
+ url: (0, common_1.toPathString)(localVarUrlObj),
478
+ options: localVarRequestOptions,
479
+ };
480
+ }),
481
+ /**
482
+ * Returns a summary of all archived deals.
483
+ * @summary Get archived deals summary
484
+ * @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost.
485
+ * @param {number} [filter_id] &lt;code&gt;user_id&lt;/code&gt; will not be considered. Only deals matching the given filter will be returned.
486
+ * @param {number} [user_id] Only deals matching the given user will be returned. &#x60;user_id&#x60; will not be considered if you use &#x60;filter_id&#x60;.
487
+ * @param {number} [pipeline_id] Only deals within the given pipeline will be returned
488
+ * @param {number} [stage_id] Only deals within the given stage will be returned
489
+ * @deprecated
490
+ * @throws {RequiredError}
491
+ */
492
+ getArchivedDealsSummary: (status, filter_id, user_id, pipeline_id, stage_id) => __awaiter(this, void 0, void 0, function* () {
493
+ const localVarPath = `/deals/summary/archived`;
494
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
495
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
496
+ let baseOptions;
497
+ if (configuration) {
498
+ baseOptions = configuration.baseOptions;
499
+ }
500
+ const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
501
+ const localVarHeaderParameter = {};
502
+ const localVarQueryParameter = {};
503
+ // authentication api_key required
504
+ yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
505
+ // authentication oauth2 required
506
+ // oauth required
507
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration);
508
+ if (status !== undefined) {
509
+ localVarQueryParameter['status'] = status;
510
+ }
511
+ if (filter_id !== undefined) {
512
+ localVarQueryParameter['filter_id'] = filter_id;
513
+ }
514
+ if (user_id !== undefined) {
515
+ localVarQueryParameter['user_id'] = user_id;
516
+ }
517
+ if (pipeline_id !== undefined) {
518
+ localVarQueryParameter['pipeline_id'] = pipeline_id;
519
+ }
520
+ if (stage_id !== undefined) {
521
+ localVarQueryParameter['stage_id'] = stage_id;
522
+ }
523
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
524
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
525
+ localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
526
+ return {
527
+ url: (0, common_1.toPathString)(localVarUrlObj),
528
+ options: localVarRequestOptions,
529
+ };
530
+ }),
531
+ /**
532
+ * 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`.
533
+ * @summary Get archived deals timeline
534
+ * @param {string} start_date The date when the first interval starts. Format: YYYY-MM-DD.
535
+ * @param {'day' | 'week' | 'month' | 'quarter'} interval The type of the interval&lt;table&gt;&lt;tr&gt;&lt;th&gt;Value&lt;/th&gt;&lt;th&gt;Description&lt;/th&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;day&#x60;&lt;/td&gt;&lt;td&gt;Day&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;week&#x60;&lt;/td&gt;&lt;td&gt;A full week (7 days) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;month&#x60;&lt;/td&gt;&lt;td&gt;A full month (depending on the number of days in given month) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;quarter&#x60;&lt;/td&gt;&lt;td&gt;A full quarter (3 months) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;
536
+ * @param {number} amount The number of given intervals, starting from &#x60;start_date&#x60;, to fetch. E.g. 3 (months).
537
+ * @param {string} field_key The date field key which deals will be retrieved from
538
+ * @param {number} [user_id] If supplied, only deals matching the given user will be returned
539
+ * @param {number} [pipeline_id] If supplied, only deals matching the given pipeline will be returned
540
+ * @param {number} [filter_id] If supplied, only deals matching the given filter will be returned
541
+ * @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.
542
+ * @param {string} [totals_convert_currency] The 3-letter currency code of any of the supported currencies. When supplied, &#x60;totals_converted&#x60; is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to &#x60;default_currency&#x60; in which case the user\&#39;s default currency is used.
543
+ * @deprecated
544
+ * @throws {RequiredError}
545
+ */
546
+ 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* () {
547
+ // verify required parameter 'start_date' is not null or undefined
548
+ (0, common_1.assertParamExists)('getArchivedDealsTimeline', 'start_date', start_date);
549
+ // verify required parameter 'interval' is not null or undefined
550
+ (0, common_1.assertParamExists)('getArchivedDealsTimeline', 'interval', interval);
551
+ // verify required parameter 'amount' is not null or undefined
552
+ (0, common_1.assertParamExists)('getArchivedDealsTimeline', 'amount', amount);
553
+ // verify required parameter 'field_key' is not null or undefined
554
+ (0, common_1.assertParamExists)('getArchivedDealsTimeline', 'field_key', field_key);
555
+ const localVarPath = `/deals/timeline/archived`;
556
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
557
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
558
+ let baseOptions;
559
+ if (configuration) {
560
+ baseOptions = configuration.baseOptions;
561
+ }
562
+ const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
563
+ const localVarHeaderParameter = {};
564
+ const localVarQueryParameter = {};
565
+ // authentication api_key required
566
+ yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
567
+ // authentication oauth2 required
568
+ // oauth required
569
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration);
570
+ if (start_date !== undefined) {
571
+ localVarQueryParameter['start_date'] = (start_date instanceof Date) ?
572
+ start_date.toISOString().substr(0, 10) :
573
+ start_date;
574
+ }
575
+ if (interval !== undefined) {
576
+ localVarQueryParameter['interval'] = interval;
577
+ }
578
+ if (amount !== undefined) {
579
+ localVarQueryParameter['amount'] = amount;
580
+ }
581
+ if (field_key !== undefined) {
582
+ localVarQueryParameter['field_key'] = field_key;
583
+ }
584
+ if (user_id !== undefined) {
585
+ localVarQueryParameter['user_id'] = user_id;
586
+ }
587
+ if (pipeline_id !== undefined) {
588
+ localVarQueryParameter['pipeline_id'] = pipeline_id;
589
+ }
590
+ if (filter_id !== undefined) {
591
+ localVarQueryParameter['filter_id'] = filter_id;
592
+ }
593
+ if (exclude_deals !== undefined) {
594
+ localVarQueryParameter['exclude_deals'] = exclude_deals;
595
+ }
596
+ if (totals_convert_currency !== undefined) {
597
+ localVarQueryParameter['totals_convert_currency'] = totals_convert_currency;
598
+ }
599
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
600
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
601
+ localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
602
+ return {
603
+ url: (0, common_1.toPathString)(localVarUrlObj),
604
+ options: localVarRequestOptions,
605
+ };
606
+ }),
403
607
  /**
404
608
  * 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>.
405
609
  * @summary Get details of a deal
406
610
  * @param {number} id The ID of the deal
407
-
611
+ * @deprecated
408
612
  * @throws {RequiredError}
409
613
  */
410
614
  getDeal: (id) => __awaiter(this, void 0, void 0, function* () {
@@ -435,14 +639,14 @@ const DealsApiAxiosParamCreator = function (configuration) {
435
639
  };
436
640
  }),
437
641
  /**
438
- * Lists activities associated with a deal.
642
+ * 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.
439
643
  * @summary List activities associated with a deal
440
644
  * @param {number} id The ID of the deal
441
645
  * @param {number} [start] Pagination start
442
646
  * @param {number} [limit] Items shown per page
443
647
  * @param {0 | 1} [done] Whether the activity is done or not. 0 &#x3D; Not done, 1 &#x3D; Done. If omitted, returns both Done and Not done activities.
444
648
  * @param {string} [exclude] A comma-separated string of activity IDs to exclude from result
445
-
649
+ * @deprecated
446
650
  * @throws {RequiredError}
447
651
  */
448
652
  getDealActivities: (id, start, limit, done, exclude) => __awaiter(this, void 0, void 0, function* () {
@@ -733,12 +937,12 @@ const DealsApiAxiosParamCreator = function (configuration) {
733
937
  };
734
938
  }),
735
939
  /**
736
- * 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.
940
+ * 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.
737
941
  * @summary List all persons associated with a deal
738
942
  * @param {number} id The ID of the deal
739
943
  * @param {number} [start] Pagination start
740
944
  * @param {number} [limit] Items shown per page
741
-
945
+ * @deprecated
742
946
  * @throws {RequiredError}
743
947
  */
744
948
  getDealPersons: (id, start, limit) => __awaiter(this, void 0, void 0, function* () {
@@ -781,7 +985,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
781
985
  * @param {number} [start] Pagination start
782
986
  * @param {number} [limit] Items shown per page
783
987
  * @param {0 | 1} [include_product_data] Whether to fetch product data along with each attached product (1) or not (0, default)
784
-
988
+ * @deprecated
785
989
  * @throws {RequiredError}
786
990
  */
787
991
  getDealProducts: (id, start, limit, include_product_data) => __awaiter(this, void 0, void 0, function* () {
@@ -905,7 +1109,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
905
1109
  };
906
1110
  }),
907
1111
  /**
908
- * 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>.
1112
+ * 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>.
909
1113
  * @summary Get all deals
910
1114
  * @param {number} [user_id] If supplied, only deals matching the given user will be returned. However, &#x60;filter_id&#x60; and &#x60;owned_by_you&#x60; takes precedence over &#x60;user_id&#x60; when supplied.
911
1115
  * @param {number} [filter_id] The ID of the filter to use
@@ -915,7 +1119,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
915
1119
  * @param {number} [limit] Items shown per page
916
1120
  * @param {string} [sort] The field names and sorting mode separated by a comma (&#x60;field_name_1 ASC&#x60;, &#x60;field_name_2 DESC&#x60;). Only first-level field keys are supported (no nested keys).
917
1121
  * @param {0 | 1} [owned_by_you] When supplied, only deals owned by you are returned. However, &#x60;filter_id&#x60; takes precedence over &#x60;owned_by_you&#x60; when both are supplied.
918
-
1122
+ * @deprecated
919
1123
  * @throws {RequiredError}
920
1124
  */
921
1125
  getDeals: (user_id, filter_id, stage_id, status, start, limit, sort, owned_by_you) => __awaiter(this, void 0, void 0, function* () {
@@ -967,8 +1171,8 @@ const DealsApiAxiosParamCreator = function (configuration) {
967
1171
  };
968
1172
  }),
969
1173
  /**
970
- * Returns all deals. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>. Please note that only global admins (those with global permissions) can access these endpoints. 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>.
971
- * @summary Get all deals (BETA)
1174
+ * 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.
1175
+ * @summary Get all deals collection
972
1176
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
973
1177
  * @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.
974
1178
  * @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 &#x60;update_time&#x60; field.
@@ -976,7 +1180,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
976
1180
  * @param {number} [user_id] If supplied, only deals matching the given user will be returned
977
1181
  * @param {number} [stage_id] If supplied, only deals within the given stage will be returned
978
1182
  * @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.
979
-
1183
+ * @deprecated
980
1184
  * @throws {RequiredError}
981
1185
  */
982
1186
  getDealsCollection: (cursor, limit, since, until, user_id, stage_id, status) => __awaiter(this, void 0, void 0, function* () {
@@ -1025,7 +1229,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
1025
1229
  };
1026
1230
  }),
1027
1231
  /**
1028
- * Returns a summary of all the deals.
1232
+ * Returns a summary of all not archived deals.
1029
1233
  * @summary Get deals summary
1030
1234
  * @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost.
1031
1235
  * @param {number} [filter_id] &lt;code&gt;user_id&lt;/code&gt; will not be considered. Only deals matching the given filter will be returned.
@@ -1075,7 +1279,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
1075
1279
  };
1076
1280
  }),
1077
1281
  /**
1078
- * 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`.
1282
+ * 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`.
1079
1283
  * @summary Get deals timeline
1080
1284
  * @param {string} start_date The date when the first interval starts. Format: YYYY-MM-DD.
1081
1285
  * @param {'day' | 'week' | 'month' | 'quarter'} interval The type of the interval&lt;table&gt;&lt;tr&gt;&lt;th&gt;Value&lt;/th&gt;&lt;th&gt;Description&lt;/th&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;day&#x60;&lt;/td&gt;&lt;td&gt;Day&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;week&#x60;&lt;/td&gt;&lt;td&gt;A full week (7 days) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;month&#x60;&lt;/td&gt;&lt;td&gt;A full month (depending on the number of days in given month) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;quarter&#x60;&lt;/td&gt;&lt;td&gt;A full quarter (3 months) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;
@@ -1199,7 +1403,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
1199
1403
  * @param {'deal.cc_email'} [include_fields] Supports including optional fields in the results which are not provided by default
1200
1404
  * @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using &#x60;search_for_related_items&#x60; parameter.
1201
1405
  * @param {number} [limit] Items shown per page
1202
-
1406
+ * @deprecated
1203
1407
  * @throws {RequiredError}
1204
1408
  */
1205
1409
  searchDeals: (term, fields, exact_match, person_id, organization_id, status, include_fields, start, limit) => __awaiter(this, void 0, void 0, function* () {
@@ -1260,7 +1464,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
1260
1464
  * @summary Update a deal
1261
1465
  * @param {number} id The ID of the deal
1262
1466
  * @param {UpdateDealRequest} [UpdateDealRequest]
1263
-
1467
+ * @deprecated
1264
1468
  * @throws {RequiredError}
1265
1469
  */
1266
1470
  updateDeal: (id, UpdateDealRequest) => __awaiter(this, void 0, void 0, function* () {
@@ -1298,7 +1502,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
1298
1502
  * @param {number} id The ID of the deal
1299
1503
  * @param {number} product_attachment_id The ID of the deal-product (the ID of the product attached to the deal)
1300
1504
  * @param {UpdateDealProductRequest} [UpdateDealProductRequest]
1301
-
1505
+ * @deprecated
1302
1506
  * @throws {RequiredError}
1303
1507
  */
1304
1508
  updateDealProduct: (id, product_attachment_id, UpdateDealProductRequest) => __awaiter(this, void 0, void 0, function* () {
@@ -1347,7 +1551,7 @@ const DealsApiFp = function (configuration) {
1347
1551
  * 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>.
1348
1552
  * @summary Add a deal
1349
1553
  * @param {AddDealRequest} [AddDealRequest]
1350
-
1554
+ * @deprecated
1351
1555
  * @throws {RequiredError}
1352
1556
  */
1353
1557
  addDeal(AddDealRequest) {
@@ -1389,7 +1593,7 @@ const DealsApiFp = function (configuration) {
1389
1593
  * @summary Add a product to a deal
1390
1594
  * @param {number} id The ID of the deal
1391
1595
  * @param {AddDealProductRequest} [AddDealProductRequest]
1392
-
1596
+ * @deprecated
1393
1597
  * @throws {RequiredError}
1394
1598
  */
1395
1599
  addDealProduct(id, AddDealProductRequest) {
@@ -1402,7 +1606,7 @@ const DealsApiFp = function (configuration) {
1402
1606
  * Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
1403
1607
  * @summary Delete a deal
1404
1608
  * @param {number} id The ID of the deal
1405
-
1609
+ * @deprecated
1406
1610
  * @throws {RequiredError}
1407
1611
  */
1408
1612
  deleteDeal(id) {
@@ -1444,7 +1648,7 @@ const DealsApiFp = function (configuration) {
1444
1648
  * @summary Delete an attached product from a deal
1445
1649
  * @param {number} id The ID of the deal
1446
1650
  * @param {number} product_attachment_id The product attachment ID
1447
-
1651
+ * @deprecated
1448
1652
  * @throws {RequiredError}
1449
1653
  */
1450
1654
  deleteDealProduct(id, product_attachment_id) {
@@ -1454,10 +1658,10 @@ const DealsApiFp = function (configuration) {
1454
1658
  });
1455
1659
  },
1456
1660
  /**
1457
- * Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.
1661
+ * 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.
1458
1662
  * @summary Delete multiple deals in bulk
1459
1663
  * @param {string} ids The comma-separated IDs that will be deleted
1460
-
1664
+ * @deprecated
1461
1665
  * @throws {RequiredError}
1462
1666
  */
1463
1667
  deleteDeals(ids) {
@@ -1479,11 +1683,73 @@ const DealsApiFp = function (configuration) {
1479
1683
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1480
1684
  });
1481
1685
  },
1686
+ /**
1687
+ * Returns all archived deals.
1688
+ * @summary Get all archived deals
1689
+ * @param {number} [user_id] If supplied, only deals matching the given user will be returned. However, &#x60;filter_id&#x60; and &#x60;owned_by_you&#x60; takes precedence over &#x60;user_id&#x60; when supplied.
1690
+ * @param {number} [filter_id] The ID of the filter to use
1691
+ * @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
1692
+ * @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
1693
+ * @param {number} [product_id] If supplied, only deals linked to the specified product are returned. If filter_id is provided, this is ignored.
1694
+ * @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
1695
+ * @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
1696
+ * @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.
1697
+ * @param {number} [start] Pagination start
1698
+ * @param {number} [limit] Items shown per page
1699
+ * @param {string} [sort] The field names and sorting mode separated by a comma (&#x60;field_name_1 ASC&#x60;, &#x60;field_name_2 DESC&#x60;). Only first-level field keys are supported (no nested keys).
1700
+ * @param {0 | 1} [owned_by_you] When supplied, only deals owned by you are returned. However, &#x60;filter_id&#x60; takes precedence over &#x60;owned_by_you&#x60; when both are supplied.
1701
+ * @deprecated
1702
+ * @throws {RequiredError}
1703
+ */
1704
+ getArchivedDeals(user_id, filter_id, person_id, org_id, product_id, pipeline_id, stage_id, status, start, limit, sort, owned_by_you) {
1705
+ return __awaiter(this, void 0, void 0, function* () {
1706
+ 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);
1707
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1708
+ });
1709
+ },
1710
+ /**
1711
+ * Returns a summary of all archived deals.
1712
+ * @summary Get archived deals summary
1713
+ * @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost.
1714
+ * @param {number} [filter_id] &lt;code&gt;user_id&lt;/code&gt; will not be considered. Only deals matching the given filter will be returned.
1715
+ * @param {number} [user_id] Only deals matching the given user will be returned. &#x60;user_id&#x60; will not be considered if you use &#x60;filter_id&#x60;.
1716
+ * @param {number} [pipeline_id] Only deals within the given pipeline will be returned
1717
+ * @param {number} [stage_id] Only deals within the given stage will be returned
1718
+ * @deprecated
1719
+ * @throws {RequiredError}
1720
+ */
1721
+ getArchivedDealsSummary(status, filter_id, user_id, pipeline_id, stage_id) {
1722
+ return __awaiter(this, void 0, void 0, function* () {
1723
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getArchivedDealsSummary(status, filter_id, user_id, pipeline_id, stage_id);
1724
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1725
+ });
1726
+ },
1727
+ /**
1728
+ * 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`.
1729
+ * @summary Get archived deals timeline
1730
+ * @param {string} start_date The date when the first interval starts. Format: YYYY-MM-DD.
1731
+ * @param {'day' | 'week' | 'month' | 'quarter'} interval The type of the interval&lt;table&gt;&lt;tr&gt;&lt;th&gt;Value&lt;/th&gt;&lt;th&gt;Description&lt;/th&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;day&#x60;&lt;/td&gt;&lt;td&gt;Day&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;week&#x60;&lt;/td&gt;&lt;td&gt;A full week (7 days) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;month&#x60;&lt;/td&gt;&lt;td&gt;A full month (depending on the number of days in given month) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;quarter&#x60;&lt;/td&gt;&lt;td&gt;A full quarter (3 months) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;
1732
+ * @param {number} amount The number of given intervals, starting from &#x60;start_date&#x60;, to fetch. E.g. 3 (months).
1733
+ * @param {string} field_key The date field key which deals will be retrieved from
1734
+ * @param {number} [user_id] If supplied, only deals matching the given user will be returned
1735
+ * @param {number} [pipeline_id] If supplied, only deals matching the given pipeline will be returned
1736
+ * @param {number} [filter_id] If supplied, only deals matching the given filter will be returned
1737
+ * @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.
1738
+ * @param {string} [totals_convert_currency] The 3-letter currency code of any of the supported currencies. When supplied, &#x60;totals_converted&#x60; is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to &#x60;default_currency&#x60; in which case the user\&#39;s default currency is used.
1739
+ * @deprecated
1740
+ * @throws {RequiredError}
1741
+ */
1742
+ getArchivedDealsTimeline(start_date, interval, amount, field_key, user_id, pipeline_id, filter_id, exclude_deals, totals_convert_currency) {
1743
+ return __awaiter(this, void 0, void 0, function* () {
1744
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getArchivedDealsTimeline(start_date, interval, amount, field_key, user_id, pipeline_id, filter_id, exclude_deals, totals_convert_currency);
1745
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1746
+ });
1747
+ },
1482
1748
  /**
1483
1749
  * 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>.
1484
1750
  * @summary Get details of a deal
1485
1751
  * @param {number} id The ID of the deal
1486
-
1752
+ * @deprecated
1487
1753
  * @throws {RequiredError}
1488
1754
  */
1489
1755
  getDeal(id) {
@@ -1493,14 +1759,14 @@ const DealsApiFp = function (configuration) {
1493
1759
  });
1494
1760
  },
1495
1761
  /**
1496
- * Lists activities associated with a deal.
1762
+ * 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.
1497
1763
  * @summary List activities associated with a deal
1498
1764
  * @param {number} id The ID of the deal
1499
1765
  * @param {number} [start] Pagination start
1500
1766
  * @param {number} [limit] Items shown per page
1501
1767
  * @param {0 | 1} [done] Whether the activity is done or not. 0 &#x3D; Not done, 1 &#x3D; Done. If omitted, returns both Done and Not done activities.
1502
1768
  * @param {string} [exclude] A comma-separated string of activity IDs to exclude from result
1503
-
1769
+ * @deprecated
1504
1770
  * @throws {RequiredError}
1505
1771
  */
1506
1772
  getDealActivities(id, start, limit, done, exclude) {
@@ -1599,12 +1865,12 @@ const DealsApiFp = function (configuration) {
1599
1865
  });
1600
1866
  },
1601
1867
  /**
1602
- * 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.
1868
+ * 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.
1603
1869
  * @summary List all persons associated with a deal
1604
1870
  * @param {number} id The ID of the deal
1605
1871
  * @param {number} [start] Pagination start
1606
1872
  * @param {number} [limit] Items shown per page
1607
-
1873
+ * @deprecated
1608
1874
  * @throws {RequiredError}
1609
1875
  */
1610
1876
  getDealPersons(id, start, limit) {
@@ -1620,7 +1886,7 @@ const DealsApiFp = function (configuration) {
1620
1886
  * @param {number} [start] Pagination start
1621
1887
  * @param {number} [limit] Items shown per page
1622
1888
  * @param {0 | 1} [include_product_data] Whether to fetch product data along with each attached product (1) or not (0, default)
1623
-
1889
+ * @deprecated
1624
1890
  * @throws {RequiredError}
1625
1891
  */
1626
1892
  getDealProducts(id, start, limit, include_product_data) {
@@ -1660,7 +1926,7 @@ const DealsApiFp = function (configuration) {
1660
1926
  });
1661
1927
  },
1662
1928
  /**
1663
- * 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>.
1929
+ * 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>.
1664
1930
  * @summary Get all deals
1665
1931
  * @param {number} [user_id] If supplied, only deals matching the given user will be returned. However, &#x60;filter_id&#x60; and &#x60;owned_by_you&#x60; takes precedence over &#x60;user_id&#x60; when supplied.
1666
1932
  * @param {number} [filter_id] The ID of the filter to use
@@ -1670,7 +1936,7 @@ const DealsApiFp = function (configuration) {
1670
1936
  * @param {number} [limit] Items shown per page
1671
1937
  * @param {string} [sort] The field names and sorting mode separated by a comma (&#x60;field_name_1 ASC&#x60;, &#x60;field_name_2 DESC&#x60;). Only first-level field keys are supported (no nested keys).
1672
1938
  * @param {0 | 1} [owned_by_you] When supplied, only deals owned by you are returned. However, &#x60;filter_id&#x60; takes precedence over &#x60;owned_by_you&#x60; when both are supplied.
1673
-
1939
+ * @deprecated
1674
1940
  * @throws {RequiredError}
1675
1941
  */
1676
1942
  getDeals(user_id, filter_id, stage_id, status, start, limit, sort, owned_by_you) {
@@ -1680,8 +1946,8 @@ const DealsApiFp = function (configuration) {
1680
1946
  });
1681
1947
  },
1682
1948
  /**
1683
- * Returns all deals. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>. Please note that only global admins (those with global permissions) can access these endpoints. 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>.
1684
- * @summary Get all deals (BETA)
1949
+ * 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.
1950
+ * @summary Get all deals collection
1685
1951
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
1686
1952
  * @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.
1687
1953
  * @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 &#x60;update_time&#x60; field.
@@ -1689,7 +1955,7 @@ const DealsApiFp = function (configuration) {
1689
1955
  * @param {number} [user_id] If supplied, only deals matching the given user will be returned
1690
1956
  * @param {number} [stage_id] If supplied, only deals within the given stage will be returned
1691
1957
  * @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.
1692
-
1958
+ * @deprecated
1693
1959
  * @throws {RequiredError}
1694
1960
  */
1695
1961
  getDealsCollection(cursor, limit, since, until, user_id, stage_id, status) {
@@ -1699,7 +1965,7 @@ const DealsApiFp = function (configuration) {
1699
1965
  });
1700
1966
  },
1701
1967
  /**
1702
- * Returns a summary of all the deals.
1968
+ * Returns a summary of all not archived deals.
1703
1969
  * @summary Get deals summary
1704
1970
  * @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost.
1705
1971
  * @param {number} [filter_id] &lt;code&gt;user_id&lt;/code&gt; will not be considered. Only deals matching the given filter will be returned.
@@ -1716,7 +1982,7 @@ const DealsApiFp = function (configuration) {
1716
1982
  });
1717
1983
  },
1718
1984
  /**
1719
- * 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`.
1985
+ * 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`.
1720
1986
  * @summary Get deals timeline
1721
1987
  * @param {string} start_date The date when the first interval starts. Format: YYYY-MM-DD.
1722
1988
  * @param {'day' | 'week' | 'month' | 'quarter'} interval The type of the interval&lt;table&gt;&lt;tr&gt;&lt;th&gt;Value&lt;/th&gt;&lt;th&gt;Description&lt;/th&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;day&#x60;&lt;/td&gt;&lt;td&gt;Day&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;week&#x60;&lt;/td&gt;&lt;td&gt;A full week (7 days) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;month&#x60;&lt;/td&gt;&lt;td&gt;A full month (depending on the number of days in given month) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;quarter&#x60;&lt;/td&gt;&lt;td&gt;A full quarter (3 months) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;
@@ -1762,7 +2028,7 @@ const DealsApiFp = function (configuration) {
1762
2028
  * @param {'deal.cc_email'} [include_fields] Supports including optional fields in the results which are not provided by default
1763
2029
  * @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using &#x60;search_for_related_items&#x60; parameter.
1764
2030
  * @param {number} [limit] Items shown per page
1765
-
2031
+ * @deprecated
1766
2032
  * @throws {RequiredError}
1767
2033
  */
1768
2034
  searchDeals(term, fields, exact_match, person_id, organization_id, status, include_fields, start, limit) {
@@ -1776,7 +2042,7 @@ const DealsApiFp = function (configuration) {
1776
2042
  * @summary Update a deal
1777
2043
  * @param {number} id The ID of the deal
1778
2044
  * @param {UpdateDealRequest} [UpdateDealRequest]
1779
-
2045
+ * @deprecated
1780
2046
  * @throws {RequiredError}
1781
2047
  */
1782
2048
  updateDeal(id, UpdateDealRequest) {
@@ -1791,7 +2057,7 @@ const DealsApiFp = function (configuration) {
1791
2057
  * @param {number} id The ID of the deal
1792
2058
  * @param {number} product_attachment_id The ID of the deal-product (the ID of the product attached to the deal)
1793
2059
  * @param {UpdateDealProductRequest} [UpdateDealProductRequest]
1794
-
2060
+ * @deprecated
1795
2061
  * @throws {RequiredError}
1796
2062
  */
1797
2063
  updateDealProduct(id, product_attachment_id, UpdateDealProductRequest) {
@@ -1814,7 +2080,7 @@ const DealsApiFactory = function (configuration, basePath, axios) {
1814
2080
  * 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>.
1815
2081
  * @summary Add a deal
1816
2082
  * @param {DealsApiAddDealRequest} requestParameters Request parameters.
1817
-
2083
+ * @deprecated
1818
2084
  * @throws {RequiredError}
1819
2085
  */
1820
2086
  addDeal(requestParameters = {}) {
@@ -1844,7 +2110,7 @@ const DealsApiFactory = function (configuration, basePath, axios) {
1844
2110
  * Adds a product to a deal, creating a new item called a deal-product.
1845
2111
  * @summary Add a product to a deal
1846
2112
  * @param {DealsApiAddDealProductRequest} requestParameters Request parameters.
1847
-
2113
+ * @deprecated
1848
2114
  * @throws {RequiredError}
1849
2115
  */
1850
2116
  addDealProduct(requestParameters) {
@@ -1854,7 +2120,7 @@ const DealsApiFactory = function (configuration, basePath, axios) {
1854
2120
  * Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
1855
2121
  * @summary Delete a deal
1856
2122
  * @param {DealsApiDeleteDealRequest} requestParameters Request parameters.
1857
-
2123
+ * @deprecated
1858
2124
  * @throws {RequiredError}
1859
2125
  */
1860
2126
  deleteDeal(requestParameters) {
@@ -1884,17 +2150,17 @@ const DealsApiFactory = function (configuration, basePath, axios) {
1884
2150
  * 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
1885
2151
  * @summary Delete an attached product from a deal
1886
2152
  * @param {DealsApiDeleteDealProductRequest} requestParameters Request parameters.
1887
-
2153
+ * @deprecated
1888
2154
  * @throws {RequiredError}
1889
2155
  */
1890
2156
  deleteDealProduct(requestParameters) {
1891
2157
  return localVarFp.deleteDealProduct(requestParameters.id, requestParameters.product_attachment_id).then((request) => request(axios, basePath));
1892
2158
  },
1893
2159
  /**
1894
- * Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.
2160
+ * 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.
1895
2161
  * @summary Delete multiple deals in bulk
1896
2162
  * @param {DealsApiDeleteDealsRequest} requestParameters Request parameters.
1897
-
2163
+ * @deprecated
1898
2164
  * @throws {RequiredError}
1899
2165
  */
1900
2166
  deleteDeals(requestParameters) {
@@ -1910,21 +2176,51 @@ const DealsApiFactory = function (configuration, basePath, axios) {
1910
2176
  duplicateDeal(requestParameters) {
1911
2177
  return localVarFp.duplicateDeal(requestParameters.id).then((request) => request(axios, basePath));
1912
2178
  },
2179
+ /**
2180
+ * Returns all archived deals.
2181
+ * @summary Get all archived deals
2182
+ * @param {DealsApiGetArchivedDealsRequest} requestParameters Request parameters.
2183
+ * @deprecated
2184
+ * @throws {RequiredError}
2185
+ */
2186
+ getArchivedDeals(requestParameters = {}) {
2187
+ 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));
2188
+ },
2189
+ /**
2190
+ * Returns a summary of all archived deals.
2191
+ * @summary Get archived deals summary
2192
+ * @param {DealsApiGetArchivedDealsSummaryRequest} requestParameters Request parameters.
2193
+ * @deprecated
2194
+ * @throws {RequiredError}
2195
+ */
2196
+ getArchivedDealsSummary(requestParameters = {}) {
2197
+ return localVarFp.getArchivedDealsSummary(requestParameters.status, requestParameters.filter_id, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.stage_id).then((request) => request(axios, basePath));
2198
+ },
2199
+ /**
2200
+ * 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`.
2201
+ * @summary Get archived deals timeline
2202
+ * @param {DealsApiGetArchivedDealsTimelineRequest} requestParameters Request parameters.
2203
+ * @deprecated
2204
+ * @throws {RequiredError}
2205
+ */
2206
+ getArchivedDealsTimeline(requestParameters) {
2207
+ 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));
2208
+ },
1913
2209
  /**
1914
2210
  * 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>.
1915
2211
  * @summary Get details of a deal
1916
2212
  * @param {DealsApiGetDealRequest} requestParameters Request parameters.
1917
-
2213
+ * @deprecated
1918
2214
  * @throws {RequiredError}
1919
2215
  */
1920
2216
  getDeal(requestParameters) {
1921
2217
  return localVarFp.getDeal(requestParameters.id).then((request) => request(axios, basePath));
1922
2218
  },
1923
2219
  /**
1924
- * Lists activities associated with a deal.
2220
+ * 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.
1925
2221
  * @summary List activities associated with a deal
1926
2222
  * @param {DealsApiGetDealActivitiesRequest} requestParameters Request parameters.
1927
-
2223
+ * @deprecated
1928
2224
  * @throws {RequiredError}
1929
2225
  */
1930
2226
  getDealActivities(requestParameters) {
@@ -1991,10 +2287,10 @@ const DealsApiFactory = function (configuration, basePath, axios) {
1991
2287
  return localVarFp.getDealParticipantsChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
1992
2288
  },
1993
2289
  /**
1994
- * 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.
2290
+ * 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.
1995
2291
  * @summary List all persons associated with a deal
1996
2292
  * @param {DealsApiGetDealPersonsRequest} requestParameters Request parameters.
1997
-
2293
+ * @deprecated
1998
2294
  * @throws {RequiredError}
1999
2295
  */
2000
2296
  getDealPersons(requestParameters) {
@@ -2004,7 +2300,7 @@ const DealsApiFactory = function (configuration, basePath, axios) {
2004
2300
  * Lists products attached to a deal.
2005
2301
  * @summary List products attached to a deal
2006
2302
  * @param {DealsApiGetDealProductsRequest} requestParameters Request parameters.
2007
-
2303
+ * @deprecated
2008
2304
  * @throws {RequiredError}
2009
2305
  */
2010
2306
  getDealProducts(requestParameters) {
@@ -2031,27 +2327,27 @@ const DealsApiFactory = function (configuration, basePath, axios) {
2031
2327
  return localVarFp.getDealUsers(requestParameters.id).then((request) => request(axios, basePath));
2032
2328
  },
2033
2329
  /**
2034
- * 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>.
2330
+ * 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>.
2035
2331
  * @summary Get all deals
2036
2332
  * @param {DealsApiGetDealsRequest} requestParameters Request parameters.
2037
-
2333
+ * @deprecated
2038
2334
  * @throws {RequiredError}
2039
2335
  */
2040
2336
  getDeals(requestParameters = {}) {
2041
2337
  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));
2042
2338
  },
2043
2339
  /**
2044
- * Returns all deals. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>. Please note that only global admins (those with global permissions) can access these endpoints. 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>.
2045
- * @summary Get all deals (BETA)
2340
+ * 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.
2341
+ * @summary Get all deals collection
2046
2342
  * @param {DealsApiGetDealsCollectionRequest} requestParameters Request parameters.
2047
-
2343
+ * @deprecated
2048
2344
  * @throws {RequiredError}
2049
2345
  */
2050
2346
  getDealsCollection(requestParameters = {}) {
2051
2347
  return localVarFp.getDealsCollection(requestParameters.cursor, requestParameters.limit, requestParameters.since, requestParameters.until, requestParameters.user_id, requestParameters.stage_id, requestParameters.status).then((request) => request(axios, basePath));
2052
2348
  },
2053
2349
  /**
2054
- * Returns a summary of all the deals.
2350
+ * Returns a summary of all not archived deals.
2055
2351
  * @summary Get deals summary
2056
2352
  * @param {DealsApiGetDealsSummaryRequest} requestParameters Request parameters.
2057
2353
 
@@ -2061,7 +2357,7 @@ const DealsApiFactory = function (configuration, basePath, axios) {
2061
2357
  return localVarFp.getDealsSummary(requestParameters.status, requestParameters.filter_id, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.stage_id).then((request) => request(axios, basePath));
2062
2358
  },
2063
2359
  /**
2064
- * 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`.
2360
+ * 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`.
2065
2361
  * @summary Get deals timeline
2066
2362
  * @param {DealsApiGetDealsTimelineRequest} requestParameters Request parameters.
2067
2363
 
@@ -2084,7 +2380,7 @@ const DealsApiFactory = function (configuration, basePath, axios) {
2084
2380
  * 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.
2085
2381
  * @summary Search deals
2086
2382
  * @param {DealsApiSearchDealsRequest} requestParameters Request parameters.
2087
-
2383
+ * @deprecated
2088
2384
  * @throws {RequiredError}
2089
2385
  */
2090
2386
  searchDeals(requestParameters) {
@@ -2094,7 +2390,7 @@ const DealsApiFactory = function (configuration, basePath, axios) {
2094
2390
  * 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>.
2095
2391
  * @summary Update a deal
2096
2392
  * @param {DealsApiUpdateDealRequest} requestParameters Request parameters.
2097
-
2393
+ * @deprecated
2098
2394
  * @throws {RequiredError}
2099
2395
  */
2100
2396
  updateDeal(requestParameters) {
@@ -2104,7 +2400,7 @@ const DealsApiFactory = function (configuration, basePath, axios) {
2104
2400
  * Updates the details of the product that has been attached to a deal.
2105
2401
  * @summary Update the product attached to a deal
2106
2402
  * @param {DealsApiUpdateDealProductRequest} requestParameters Request parameters.
2107
-
2403
+ * @deprecated
2108
2404
  * @throws {RequiredError}
2109
2405
  */
2110
2406
  updateDealProduct(requestParameters) {
@@ -2124,7 +2420,7 @@ class DealsApi extends base_1.BaseAPI {
2124
2420
  * 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>.
2125
2421
  * @summary Add a deal
2126
2422
  * @param {DealsApiAddDealRequest} requestParameters Request parameters.
2127
-
2423
+ * @deprecated
2128
2424
  * @throws {RequiredError}
2129
2425
  * @memberof DealsApi
2130
2426
  */
@@ -2157,7 +2453,7 @@ class DealsApi extends base_1.BaseAPI {
2157
2453
  * Adds a product to a deal, creating a new item called a deal-product.
2158
2454
  * @summary Add a product to a deal
2159
2455
  * @param {DealsApiAddDealProductRequest} requestParameters Request parameters.
2160
-
2456
+ * @deprecated
2161
2457
  * @throws {RequiredError}
2162
2458
  * @memberof DealsApi
2163
2459
  */
@@ -2168,7 +2464,7 @@ class DealsApi extends base_1.BaseAPI {
2168
2464
  * Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
2169
2465
  * @summary Delete a deal
2170
2466
  * @param {DealsApiDeleteDealRequest} requestParameters Request parameters.
2171
-
2467
+ * @deprecated
2172
2468
  * @throws {RequiredError}
2173
2469
  * @memberof DealsApi
2174
2470
  */
@@ -2201,7 +2497,7 @@ class DealsApi extends base_1.BaseAPI {
2201
2497
  * 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
2202
2498
  * @summary Delete an attached product from a deal
2203
2499
  * @param {DealsApiDeleteDealProductRequest} requestParameters Request parameters.
2204
-
2500
+ * @deprecated
2205
2501
  * @throws {RequiredError}
2206
2502
  * @memberof DealsApi
2207
2503
  */
@@ -2209,10 +2505,10 @@ class DealsApi extends base_1.BaseAPI {
2209
2505
  return (0, exports.DealsApiFp)(this.configuration).deleteDealProduct(requestParameters.id, requestParameters.product_attachment_id).then((request) => request(this.axios, this.basePath));
2210
2506
  }
2211
2507
  /**
2212
- * Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.
2508
+ * 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.
2213
2509
  * @summary Delete multiple deals in bulk
2214
2510
  * @param {DealsApiDeleteDealsRequest} requestParameters Request parameters.
2215
-
2511
+ * @deprecated
2216
2512
  * @throws {RequiredError}
2217
2513
  * @memberof DealsApi
2218
2514
  */
@@ -2230,11 +2526,44 @@ class DealsApi extends base_1.BaseAPI {
2230
2526
  duplicateDeal(requestParameters) {
2231
2527
  return (0, exports.DealsApiFp)(this.configuration).duplicateDeal(requestParameters.id).then((request) => request(this.axios, this.basePath));
2232
2528
  }
2529
+ /**
2530
+ * Returns all archived deals.
2531
+ * @summary Get all archived deals
2532
+ * @param {DealsApiGetArchivedDealsRequest} requestParameters Request parameters.
2533
+ * @deprecated
2534
+ * @throws {RequiredError}
2535
+ * @memberof DealsApi
2536
+ */
2537
+ getArchivedDeals(requestParameters = {}) {
2538
+ return (0, exports.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));
2539
+ }
2540
+ /**
2541
+ * Returns a summary of all archived deals.
2542
+ * @summary Get archived deals summary
2543
+ * @param {DealsApiGetArchivedDealsSummaryRequest} requestParameters Request parameters.
2544
+ * @deprecated
2545
+ * @throws {RequiredError}
2546
+ * @memberof DealsApi
2547
+ */
2548
+ getArchivedDealsSummary(requestParameters = {}) {
2549
+ return (0, exports.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));
2550
+ }
2551
+ /**
2552
+ * 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`.
2553
+ * @summary Get archived deals timeline
2554
+ * @param {DealsApiGetArchivedDealsTimelineRequest} requestParameters Request parameters.
2555
+ * @deprecated
2556
+ * @throws {RequiredError}
2557
+ * @memberof DealsApi
2558
+ */
2559
+ getArchivedDealsTimeline(requestParameters) {
2560
+ return (0, exports.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));
2561
+ }
2233
2562
  /**
2234
2563
  * 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>.
2235
2564
  * @summary Get details of a deal
2236
2565
  * @param {DealsApiGetDealRequest} requestParameters Request parameters.
2237
-
2566
+ * @deprecated
2238
2567
  * @throws {RequiredError}
2239
2568
  * @memberof DealsApi
2240
2569
  */
@@ -2242,10 +2571,10 @@ class DealsApi extends base_1.BaseAPI {
2242
2571
  return (0, exports.DealsApiFp)(this.configuration).getDeal(requestParameters.id).then((request) => request(this.axios, this.basePath));
2243
2572
  }
2244
2573
  /**
2245
- * Lists activities associated with a deal.
2574
+ * 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.
2246
2575
  * @summary List activities associated with a deal
2247
2576
  * @param {DealsApiGetDealActivitiesRequest} requestParameters Request parameters.
2248
-
2577
+ * @deprecated
2249
2578
  * @throws {RequiredError}
2250
2579
  * @memberof DealsApi
2251
2580
  */
@@ -2319,10 +2648,10 @@ class DealsApi extends base_1.BaseAPI {
2319
2648
  return (0, exports.DealsApiFp)(this.configuration).getDealParticipantsChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
2320
2649
  }
2321
2650
  /**
2322
- * 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.
2651
+ * 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.
2323
2652
  * @summary List all persons associated with a deal
2324
2653
  * @param {DealsApiGetDealPersonsRequest} requestParameters Request parameters.
2325
-
2654
+ * @deprecated
2326
2655
  * @throws {RequiredError}
2327
2656
  * @memberof DealsApi
2328
2657
  */
@@ -2333,7 +2662,7 @@ class DealsApi extends base_1.BaseAPI {
2333
2662
  * Lists products attached to a deal.
2334
2663
  * @summary List products attached to a deal
2335
2664
  * @param {DealsApiGetDealProductsRequest} requestParameters Request parameters.
2336
-
2665
+ * @deprecated
2337
2666
  * @throws {RequiredError}
2338
2667
  * @memberof DealsApi
2339
2668
  */
@@ -2363,10 +2692,10 @@ class DealsApi extends base_1.BaseAPI {
2363
2692
  return (0, exports.DealsApiFp)(this.configuration).getDealUsers(requestParameters.id).then((request) => request(this.axios, this.basePath));
2364
2693
  }
2365
2694
  /**
2366
- * 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>.
2695
+ * 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>.
2367
2696
  * @summary Get all deals
2368
2697
  * @param {DealsApiGetDealsRequest} requestParameters Request parameters.
2369
-
2698
+ * @deprecated
2370
2699
  * @throws {RequiredError}
2371
2700
  * @memberof DealsApi
2372
2701
  */
@@ -2374,10 +2703,10 @@ class DealsApi extends base_1.BaseAPI {
2374
2703
  return (0, exports.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));
2375
2704
  }
2376
2705
  /**
2377
- * Returns all deals. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>. Please note that only global admins (those with global permissions) can access these endpoints. 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>.
2378
- * @summary Get all deals (BETA)
2706
+ * 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.
2707
+ * @summary Get all deals collection
2379
2708
  * @param {DealsApiGetDealsCollectionRequest} requestParameters Request parameters.
2380
-
2709
+ * @deprecated
2381
2710
  * @throws {RequiredError}
2382
2711
  * @memberof DealsApi
2383
2712
  */
@@ -2385,7 +2714,7 @@ class DealsApi extends base_1.BaseAPI {
2385
2714
  return (0, exports.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));
2386
2715
  }
2387
2716
  /**
2388
- * Returns a summary of all the deals.
2717
+ * Returns a summary of all not archived deals.
2389
2718
  * @summary Get deals summary
2390
2719
  * @param {DealsApiGetDealsSummaryRequest} requestParameters Request parameters.
2391
2720
 
@@ -2396,7 +2725,7 @@ class DealsApi extends base_1.BaseAPI {
2396
2725
  return (0, exports.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));
2397
2726
  }
2398
2727
  /**
2399
- * 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`.
2728
+ * 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`.
2400
2729
  * @summary Get deals timeline
2401
2730
  * @param {DealsApiGetDealsTimelineRequest} requestParameters Request parameters.
2402
2731
 
@@ -2421,7 +2750,7 @@ class DealsApi extends base_1.BaseAPI {
2421
2750
  * 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.
2422
2751
  * @summary Search deals
2423
2752
  * @param {DealsApiSearchDealsRequest} requestParameters Request parameters.
2424
-
2753
+ * @deprecated
2425
2754
  * @throws {RequiredError}
2426
2755
  * @memberof DealsApi
2427
2756
  */
@@ -2432,7 +2761,7 @@ class DealsApi extends base_1.BaseAPI {
2432
2761
  * 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>.
2433
2762
  * @summary Update a deal
2434
2763
  * @param {DealsApiUpdateDealRequest} requestParameters Request parameters.
2435
-
2764
+ * @deprecated
2436
2765
  * @throws {RequiredError}
2437
2766
  * @memberof DealsApi
2438
2767
  */
@@ -2443,7 +2772,7 @@ class DealsApi extends base_1.BaseAPI {
2443
2772
  * Updates the details of the product that has been attached to a deal.
2444
2773
  * @summary Update the product attached to a deal
2445
2774
  * @param {DealsApiUpdateDealProductRequest} requestParameters Request parameters.
2446
-
2775
+ * @deprecated
2447
2776
  * @throws {RequiredError}
2448
2777
  * @memberof DealsApi
2449
2778
  */