pipedrive 25.0.0 → 27.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 (213) 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 +47 -47
  3. package/dist/esm/versions/v1/api/activity-fields-api.js +1 -1
  4. package/dist/esm/versions/v1/api/activity-types-api.js +5 -5
  5. package/dist/esm/versions/v1/api/billing-api.js +1 -1
  6. package/dist/esm/versions/v1/api/call-logs-api.js +5 -5
  7. package/dist/esm/versions/v1/api/channels-api.js +4 -4
  8. package/dist/esm/versions/v1/api/currencies-api.js +1 -1
  9. package/dist/esm/versions/v1/api/deal-fields-api.js +6 -6
  10. package/dist/esm/versions/v1/api/deals-api.d.ts +410 -88
  11. package/dist/esm/versions/v1/api/deals-api.js +447 -118
  12. package/dist/esm/versions/v1/api/files-api.js +8 -8
  13. package/dist/esm/versions/v1/api/filters-api.js +7 -7
  14. package/dist/esm/versions/v1/api/goals-api.js +5 -5
  15. package/dist/esm/versions/v1/api/item-search-api.d.ts +8 -8
  16. package/dist/esm/versions/v1/api/item-search-api.js +10 -10
  17. package/dist/esm/versions/v1/api/lead-labels-api.js +4 -4
  18. package/dist/esm/versions/v1/api/lead-sources-api.js +1 -1
  19. package/dist/esm/versions/v1/api/leads-api.d.ts +100 -14
  20. package/dist/esm/versions/v1/api/leads-api.js +114 -21
  21. package/dist/esm/versions/v1/api/legacy-teams-api.js +8 -8
  22. package/dist/esm/versions/v1/api/mailbox-api.js +6 -6
  23. package/dist/esm/versions/v1/api/meetings-api.js +2 -2
  24. package/dist/esm/versions/v1/api/note-fields-api.js +1 -1
  25. package/dist/esm/versions/v1/api/notes-api.d.ts +18 -2
  26. package/dist/esm/versions/v1/api/notes-api.js +25 -15
  27. package/dist/esm/versions/v1/api/organization-fields-api.js +6 -6
  28. package/dist/esm/versions/v1/api/organization-relationships-api.js +5 -5
  29. package/dist/esm/versions/v1/api/organizations-api.d.ts +68 -68
  30. package/dist/esm/versions/v1/api/organizations-api.js +88 -88
  31. package/dist/esm/versions/v1/api/permission-sets-api.js +3 -3
  32. package/dist/esm/versions/v1/api/person-fields-api.js +6 -6
  33. package/dist/esm/versions/v1/api/persons-api.d.ts +56 -56
  34. package/dist/esm/versions/v1/api/persons-api.js +78 -78
  35. package/dist/esm/versions/v1/api/pipelines-api.d.ts +28 -28
  36. package/dist/esm/versions/v1/api/pipelines-api.js +36 -36
  37. package/dist/esm/versions/v1/api/product-fields-api.js +6 -6
  38. package/dist/esm/versions/v1/api/products-api.d.ts +24 -24
  39. package/dist/esm/versions/v1/api/products-api.js +36 -36
  40. package/dist/esm/versions/v1/api/project-templates-api.js +4 -4
  41. package/dist/esm/versions/v1/api/projects-api.js +14 -14
  42. package/dist/esm/versions/v1/api/recents-api.js +1 -1
  43. package/dist/esm/versions/v1/api/roles-api.js +12 -12
  44. package/dist/esm/versions/v1/api/stages-api.d.ts +36 -36
  45. package/dist/esm/versions/v1/api/stages-api.js +43 -43
  46. package/dist/esm/versions/v1/api/subscriptions-api.js +9 -9
  47. package/dist/esm/versions/v1/api/tasks-api.js +5 -5
  48. package/dist/esm/versions/v1/api/user-connections-api.js +1 -1
  49. package/dist/esm/versions/v1/api/user-settings-api.js +1 -1
  50. package/dist/esm/versions/v1/api/users-api.js +10 -10
  51. package/dist/esm/versions/v1/api/webhooks-api.js +3 -3
  52. package/dist/esm/versions/v1/base.d.ts +2 -3
  53. package/dist/esm/versions/v1/configuration.d.ts +2 -2
  54. package/dist/esm/versions/v1/models/add-note-request-all-of.d.ts +9 -4
  55. package/dist/esm/versions/v1/models/add-note-request-all-of1.d.ts +10 -0
  56. package/dist/esm/versions/v1/models/add-note-request-all-of1.js +4 -0
  57. package/dist/esm/versions/v1/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -0
  58. package/dist/esm/versions/v1/models/index.d.ts +1 -0
  59. package/dist/esm/versions/v1/models/index.js +1 -0
  60. package/dist/esm/versions/v1/models/note-project.d.ts +23 -0
  61. package/dist/esm/versions/v1/models/note-project.js +14 -0
  62. package/dist/esm/versions/v1/models/note-request-all-of1.d.ts +5 -0
  63. package/dist/esm/versions/v1/models/note.d.ts +16 -0
  64. package/dist/esm/versions/v2/api/activities-api.d.ts +15 -7
  65. package/dist/esm/versions/v2/api/activities-api.js +17 -12
  66. package/dist/esm/versions/v2/api/beta-api.d.ts +212 -0
  67. package/dist/esm/versions/v2/api/beta-api.js +290 -4
  68. package/dist/esm/versions/v2/api/deals-api.d.ts +272 -4
  69. package/dist/esm/versions/v2/api/deals-api.js +311 -27
  70. package/dist/esm/versions/v2/api/item-search-api.js +2 -2
  71. package/dist/esm/versions/v2/api/leads-api.d.ts +111 -0
  72. package/dist/esm/versions/v2/api/leads-api.js +147 -2
  73. package/dist/esm/versions/v2/api/organizations-api.js +10 -10
  74. package/dist/esm/versions/v2/api/persons-api.d.ts +8 -8
  75. package/dist/esm/versions/v2/api/persons-api.js +18 -18
  76. package/dist/esm/versions/v2/api/pipelines-api.js +5 -5
  77. package/dist/esm/versions/v2/api/products-api.js +15 -15
  78. package/dist/esm/versions/v2/api/stages-api.js +5 -5
  79. package/dist/esm/versions/v2/api/users-api.js +1 -1
  80. package/dist/esm/versions/v2/base.d.ts +2 -3
  81. package/dist/esm/versions/v2/configuration.d.ts +2 -2
  82. package/dist/esm/versions/v2/models/activity-item.d.ts +5 -0
  83. package/dist/esm/versions/v2/models/activity-item1.d.ts +5 -0
  84. package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response-data.d.ts +23 -0
  85. package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response-data.js +14 -0
  86. package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response.d.ts +34 -0
  87. package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response.js +14 -0
  88. package/dist/esm/versions/v2/models/add-convert-lead-to-deal-response.d.ts +34 -0
  89. package/dist/esm/versions/v2/models/add-convert-lead-to-deal-response.js +14 -0
  90. package/dist/esm/versions/v2/models/add-person-request.d.ts +12 -0
  91. package/dist/esm/versions/v2/models/add-person-request.js +6 -1
  92. package/dist/esm/versions/v2/models/convert-lead-to-deal-request.d.ts +28 -0
  93. package/dist/esm/versions/v2/models/convert-lead-to-deal-request.js +14 -0
  94. package/dist/esm/versions/v2/models/deal-item.d.ts +5 -0
  95. package/dist/esm/versions/v2/models/deal-item1.d.ts +5 -0
  96. package/dist/esm/versions/v2/models/get-convert-response.d.ts +43 -0
  97. package/dist/esm/versions/v2/models/get-convert-response.js +14 -0
  98. package/dist/esm/versions/v2/models/get-convert-response1-data.d.ts +46 -0
  99. package/dist/esm/versions/v2/models/get-convert-response1-data.js +20 -0
  100. package/dist/esm/versions/v2/models/get-convert-response1.d.ts +34 -0
  101. package/dist/esm/versions/v2/models/get-convert-response1.js +14 -0
  102. package/dist/esm/versions/v2/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -0
  103. package/dist/esm/versions/v2/models/index.d.ts +7 -0
  104. package/dist/esm/versions/v2/models/index.js +7 -0
  105. package/dist/esm/versions/v2/models/update-person-request.d.ts +12 -0
  106. package/dist/esm/versions/v2/models/update-person-request.js +6 -1
  107. package/dist/versions/v1/api/activities-api.d.ts +40 -40
  108. package/dist/versions/v1/api/activities-api.js +47 -47
  109. package/dist/versions/v1/api/activity-fields-api.js +1 -1
  110. package/dist/versions/v1/api/activity-types-api.js +5 -5
  111. package/dist/versions/v1/api/billing-api.js +1 -1
  112. package/dist/versions/v1/api/call-logs-api.js +5 -5
  113. package/dist/versions/v1/api/channels-api.js +4 -4
  114. package/dist/versions/v1/api/currencies-api.js +1 -1
  115. package/dist/versions/v1/api/deal-fields-api.js +6 -6
  116. package/dist/versions/v1/api/deals-api.d.ts +410 -88
  117. package/dist/versions/v1/api/deals-api.js +447 -118
  118. package/dist/versions/v1/api/files-api.js +8 -8
  119. package/dist/versions/v1/api/filters-api.js +7 -7
  120. package/dist/versions/v1/api/goals-api.js +5 -5
  121. package/dist/versions/v1/api/item-search-api.d.ts +8 -8
  122. package/dist/versions/v1/api/item-search-api.js +10 -10
  123. package/dist/versions/v1/api/lead-labels-api.js +4 -4
  124. package/dist/versions/v1/api/lead-sources-api.js +1 -1
  125. package/dist/versions/v1/api/leads-api.d.ts +100 -14
  126. package/dist/versions/v1/api/leads-api.js +114 -21
  127. package/dist/versions/v1/api/legacy-teams-api.js +8 -8
  128. package/dist/versions/v1/api/mailbox-api.js +6 -6
  129. package/dist/versions/v1/api/meetings-api.js +2 -2
  130. package/dist/versions/v1/api/note-fields-api.js +1 -1
  131. package/dist/versions/v1/api/notes-api.d.ts +18 -2
  132. package/dist/versions/v1/api/notes-api.js +25 -15
  133. package/dist/versions/v1/api/organization-fields-api.js +6 -6
  134. package/dist/versions/v1/api/organization-relationships-api.js +5 -5
  135. package/dist/versions/v1/api/organizations-api.d.ts +68 -68
  136. package/dist/versions/v1/api/organizations-api.js +88 -88
  137. package/dist/versions/v1/api/permission-sets-api.js +3 -3
  138. package/dist/versions/v1/api/person-fields-api.js +6 -6
  139. package/dist/versions/v1/api/persons-api.d.ts +56 -56
  140. package/dist/versions/v1/api/persons-api.js +78 -78
  141. package/dist/versions/v1/api/pipelines-api.d.ts +28 -28
  142. package/dist/versions/v1/api/pipelines-api.js +36 -36
  143. package/dist/versions/v1/api/product-fields-api.js +6 -6
  144. package/dist/versions/v1/api/products-api.d.ts +24 -24
  145. package/dist/versions/v1/api/products-api.js +36 -36
  146. package/dist/versions/v1/api/project-templates-api.js +4 -4
  147. package/dist/versions/v1/api/projects-api.js +14 -14
  148. package/dist/versions/v1/api/recents-api.js +1 -1
  149. package/dist/versions/v1/api/roles-api.js +12 -12
  150. package/dist/versions/v1/api/stages-api.d.ts +36 -36
  151. package/dist/versions/v1/api/stages-api.js +43 -43
  152. package/dist/versions/v1/api/subscriptions-api.js +9 -9
  153. package/dist/versions/v1/api/tasks-api.js +5 -5
  154. package/dist/versions/v1/api/user-connections-api.js +1 -1
  155. package/dist/versions/v1/api/user-settings-api.js +1 -1
  156. package/dist/versions/v1/api/users-api.js +10 -10
  157. package/dist/versions/v1/api/webhooks-api.js +3 -3
  158. package/dist/versions/v1/base.d.ts +2 -3
  159. package/dist/versions/v1/configuration.d.ts +2 -2
  160. package/dist/versions/v1/models/add-note-request-all-of.d.ts +9 -4
  161. package/dist/versions/v1/models/add-note-request-all-of1.d.ts +10 -0
  162. package/dist/versions/v1/models/add-note-request-all-of1.js +5 -1
  163. package/dist/versions/v1/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -0
  164. package/dist/versions/v1/models/index.d.ts +1 -0
  165. package/dist/versions/v1/models/index.js +1 -0
  166. package/dist/versions/v1/models/note-project.d.ts +23 -0
  167. package/dist/versions/v1/models/note-project.js +15 -0
  168. package/dist/versions/v1/models/note-request-all-of1.d.ts +5 -0
  169. package/dist/versions/v1/models/note.d.ts +16 -0
  170. package/dist/versions/v2/api/activities-api.d.ts +15 -7
  171. package/dist/versions/v2/api/activities-api.js +17 -12
  172. package/dist/versions/v2/api/beta-api.d.ts +212 -0
  173. package/dist/versions/v2/api/beta-api.js +290 -4
  174. package/dist/versions/v2/api/deals-api.d.ts +272 -4
  175. package/dist/versions/v2/api/deals-api.js +311 -27
  176. package/dist/versions/v2/api/item-search-api.js +2 -2
  177. package/dist/versions/v2/api/leads-api.d.ts +111 -0
  178. package/dist/versions/v2/api/leads-api.js +146 -1
  179. package/dist/versions/v2/api/organizations-api.js +10 -10
  180. package/dist/versions/v2/api/persons-api.d.ts +8 -8
  181. package/dist/versions/v2/api/persons-api.js +18 -18
  182. package/dist/versions/v2/api/pipelines-api.js +5 -5
  183. package/dist/versions/v2/api/products-api.js +15 -15
  184. package/dist/versions/v2/api/stages-api.js +5 -5
  185. package/dist/versions/v2/api/users-api.js +1 -1
  186. package/dist/versions/v2/base.d.ts +2 -3
  187. package/dist/versions/v2/configuration.d.ts +2 -2
  188. package/dist/versions/v2/models/activity-item.d.ts +5 -0
  189. package/dist/versions/v2/models/activity-item1.d.ts +5 -0
  190. package/dist/versions/v2/models/add-convert-deal-to-lead-response-data.d.ts +23 -0
  191. package/dist/versions/v2/models/add-convert-deal-to-lead-response-data.js +15 -0
  192. package/dist/versions/v2/models/add-convert-deal-to-lead-response.d.ts +34 -0
  193. package/dist/versions/v2/models/add-convert-deal-to-lead-response.js +15 -0
  194. package/dist/versions/v2/models/add-convert-lead-to-deal-response.d.ts +34 -0
  195. package/dist/versions/v2/models/add-convert-lead-to-deal-response.js +15 -0
  196. package/dist/versions/v2/models/add-person-request.d.ts +12 -0
  197. package/dist/versions/v2/models/add-person-request.js +7 -0
  198. package/dist/versions/v2/models/convert-lead-to-deal-request.d.ts +28 -0
  199. package/dist/versions/v2/models/convert-lead-to-deal-request.js +15 -0
  200. package/dist/versions/v2/models/deal-item.d.ts +5 -0
  201. package/dist/versions/v2/models/deal-item1.d.ts +5 -0
  202. package/dist/versions/v2/models/get-convert-response.d.ts +43 -0
  203. package/dist/versions/v2/models/get-convert-response.js +15 -0
  204. package/dist/versions/v2/models/get-convert-response1-data.d.ts +46 -0
  205. package/dist/versions/v2/models/get-convert-response1-data.js +23 -0
  206. package/dist/versions/v2/models/get-convert-response1.d.ts +34 -0
  207. package/dist/versions/v2/models/get-convert-response1.js +15 -0
  208. package/dist/versions/v2/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -0
  209. package/dist/versions/v2/models/index.d.ts +7 -0
  210. package/dist/versions/v2/models/index.js +7 -0
  211. package/dist/versions/v2/models/update-person-request.d.ts +12 -0
  212. package/dist/versions/v2/models/update-person-request.js +7 -0
  213. package/package.json +1 -1
@@ -42,7 +42,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
42
42
  * Adds a new person. 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 personFields and look for `key` values.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `data.marketing_status` field.
43
43
  * @summary Add a person
44
44
  * @param {AddPersonRequest} [AddPersonRequest]
45
-
45
+ * @deprecated
46
46
  * @throws {RequiredError}
47
47
  */
48
48
  addPerson: (AddPersonRequest) => __awaiter(this, void 0, void 0, function* () {
@@ -57,7 +57,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
57
57
  const localVarHeaderParameter = {};
58
58
  const localVarQueryParameter = {};
59
59
  // authentication api_key required
60
- yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
60
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
61
61
  // authentication oauth2 required
62
62
  // oauth required
63
63
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["contacts:full"], configuration);
@@ -94,7 +94,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
94
94
  const localVarHeaderParameter = {};
95
95
  const localVarQueryParameter = {};
96
96
  // authentication api_key required
97
- yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
97
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
98
98
  // authentication oauth2 required
99
99
  // oauth required
100
100
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["contacts:full"], configuration);
@@ -138,7 +138,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
138
138
  const localVarQueryParameter = {};
139
139
  const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
140
140
  // authentication api_key required
141
- yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
141
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
142
142
  // authentication oauth2 required
143
143
  // oauth required
144
144
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["contacts:full"], configuration);
@@ -171,7 +171,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
171
171
  * Marks a person as deleted. After 30 days, the person will be permanently deleted.
172
172
  * @summary Delete a person
173
173
  * @param {number} id The ID of the person
174
-
174
+ * @deprecated
175
175
  * @throws {RequiredError}
176
176
  */
177
177
  deletePerson: (id) => __awaiter(this, void 0, void 0, function* () {
@@ -189,7 +189,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
189
189
  const localVarHeaderParameter = {};
190
190
  const localVarQueryParameter = {};
191
191
  // authentication api_key required
192
- yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
192
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
193
193
  // authentication oauth2 required
194
194
  // oauth required
195
195
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["contacts:full"], configuration);
@@ -227,7 +227,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
227
227
  const localVarHeaderParameter = {};
228
228
  const localVarQueryParameter = {};
229
229
  // authentication api_key required
230
- yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
230
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
231
231
  // authentication oauth2 required
232
232
  // oauth required
233
233
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["contacts:full"], configuration);
@@ -261,7 +261,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
261
261
  const localVarHeaderParameter = {};
262
262
  const localVarQueryParameter = {};
263
263
  // authentication api_key required
264
- yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
264
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
265
265
  // authentication oauth2 required
266
266
  // oauth required
267
267
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["contacts:full"], configuration);
@@ -274,10 +274,10 @@ const PersonsApiAxiosParamCreator = function (configuration) {
274
274
  };
275
275
  }),
276
276
  /**
277
- * Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
277
+ * Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#deletePerson\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/persons/{id}</a> instead.
278
278
  * @summary Delete multiple persons in bulk
279
279
  * @param {string} ids The comma-separated IDs that will be deleted
280
-
280
+ * @deprecated
281
281
  * @throws {RequiredError}
282
282
  */
283
283
  deletePersons: (ids) => __awaiter(this, void 0, void 0, function* () {
@@ -294,7 +294,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
294
294
  const localVarHeaderParameter = {};
295
295
  const localVarQueryParameter = {};
296
296
  // authentication api_key required
297
- yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
297
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
298
298
  // authentication oauth2 required
299
299
  // oauth required
300
300
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["contacts:full"], configuration);
@@ -313,7 +313,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
313
313
  * Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.<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.
314
314
  * @summary Get details of a person
315
315
  * @param {number} id The ID of the person
316
-
316
+ * @deprecated
317
317
  * @throws {RequiredError}
318
318
  */
319
319
  getPerson: (id) => __awaiter(this, void 0, void 0, function* () {
@@ -331,7 +331,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
331
331
  const localVarHeaderParameter = {};
332
332
  const localVarQueryParameter = {};
333
333
  // authentication api_key required
334
- yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
334
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
335
335
  // authentication oauth2 required
336
336
  // oauth required
337
337
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full"], configuration);
@@ -344,14 +344,14 @@ const PersonsApiAxiosParamCreator = function (configuration) {
344
344
  };
345
345
  }),
346
346
  /**
347
- * Lists activities associated with a person.
347
+ * Lists activities associated with a person. <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?person_id={id}</a> instead.
348
348
  * @summary List activities associated with a person
349
349
  * @param {number} id The ID of the person
350
350
  * @param {number} [start] Pagination start
351
351
  * @param {number} [limit] Items shown per page
352
352
  * @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.
353
353
  * @param {string} [exclude] A comma-separated string of activity IDs to exclude from result
354
-
354
+ * @deprecated
355
355
  * @throws {RequiredError}
356
356
  */
357
357
  getPersonActivities: (id, start, limit, done, exclude) => __awaiter(this, void 0, void 0, function* () {
@@ -369,7 +369,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
369
369
  const localVarHeaderParameter = {};
370
370
  const localVarQueryParameter = {};
371
371
  // authentication api_key required
372
- yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
372
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
373
373
  // authentication oauth2 required
374
374
  // oauth required
375
375
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["activities:read", "activities:full"], configuration);
@@ -417,7 +417,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
417
417
  const localVarHeaderParameter = {};
418
418
  const localVarQueryParameter = {};
419
419
  // authentication api_key required
420
- yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
420
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
421
421
  // authentication oauth2 required
422
422
  // oauth required
423
423
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["recents:read"], configuration);
@@ -436,14 +436,14 @@ const PersonsApiAxiosParamCreator = function (configuration) {
436
436
  };
437
437
  }),
438
438
  /**
439
- * Lists deals associated with a person.
439
+ * Lists deals associated with a person. <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?person_id={id}</a> instead.
440
440
  * @summary List deals associated with a person
441
441
  * @param {number} id The ID of the person
442
442
  * @param {number} [start] Pagination start
443
443
  * @param {number} [limit] Items shown per page
444
444
  * @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.
445
445
  * @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).
446
-
446
+ * @deprecated
447
447
  * @throws {RequiredError}
448
448
  */
449
449
  getPersonDeals: (id, start, limit, status, sort) => __awaiter(this, void 0, void 0, function* () {
@@ -461,7 +461,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
461
461
  const localVarHeaderParameter = {};
462
462
  const localVarQueryParameter = {};
463
463
  // authentication api_key required
464
- yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
464
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
465
465
  // authentication oauth2 required
466
466
  // oauth required
467
467
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration);
@@ -510,7 +510,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
510
510
  const localVarHeaderParameter = {};
511
511
  const localVarQueryParameter = {};
512
512
  // authentication api_key required
513
- yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
513
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
514
514
  // authentication oauth2 required
515
515
  // oauth required
516
516
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full"], configuration);
@@ -553,7 +553,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
553
553
  const localVarHeaderParameter = {};
554
554
  const localVarQueryParameter = {};
555
555
  // authentication api_key required
556
- yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
556
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
557
557
  // authentication oauth2 required
558
558
  // oauth required
559
559
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full"], configuration);
@@ -589,7 +589,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
589
589
  const localVarHeaderParameter = {};
590
590
  const localVarQueryParameter = {};
591
591
  // authentication api_key required
592
- yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
592
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
593
593
  // authentication oauth2 required
594
594
  // oauth required
595
595
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["mail:read", "mail:full"], configuration);
@@ -631,7 +631,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
631
631
  const localVarHeaderParameter = {};
632
632
  const localVarQueryParameter = {};
633
633
  // authentication api_key required
634
- yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
634
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
635
635
  // authentication oauth2 required
636
636
  // oauth required
637
637
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full"], configuration);
@@ -675,7 +675,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
675
675
  const localVarHeaderParameter = {};
676
676
  const localVarQueryParameter = {};
677
677
  // authentication api_key required
678
- yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
678
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
679
679
  // authentication oauth2 required
680
680
  // oauth required
681
681
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["recents:read"], configuration);
@@ -721,7 +721,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
721
721
  const localVarHeaderParameter = {};
722
722
  const localVarQueryParameter = {};
723
723
  // authentication api_key required
724
- yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
724
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
725
725
  // authentication oauth2 required
726
726
  // oauth required
727
727
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full"], configuration);
@@ -742,7 +742,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
742
742
  * @param {number} [start] Pagination start
743
743
  * @param {number} [limit] Items shown per page
744
744
  * @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).
745
-
745
+ * @deprecated
746
746
  * @throws {RequiredError}
747
747
  */
748
748
  getPersons: (user_id, filter_id, first_char, start, limit, sort) => __awaiter(this, void 0, void 0, function* () {
@@ -757,7 +757,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
757
757
  const localVarHeaderParameter = {};
758
758
  const localVarQueryParameter = {};
759
759
  // authentication api_key required
760
- yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
760
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
761
761
  // authentication oauth2 required
762
762
  // oauth required
763
763
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full"], configuration);
@@ -788,15 +788,15 @@ const PersonsApiAxiosParamCreator = function (configuration) {
788
788
  };
789
789
  }),
790
790
  /**
791
- * Returns all persons. 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>.
792
- * @summary Get all persons (BETA)
791
+ * Returns all persons. 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/Persons#getPersons\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/persons</a> instead.
792
+ * @summary Get all persons collection
793
793
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
794
794
  * @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.
795
795
  * @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.
796
796
  * @param {string} [until] The time boundary that points to the end 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.
797
797
  * @param {number} [owner_id] If supplied, only persons owned by the given user will be returned
798
798
  * @param {string} [first_char] If supplied, only persons whose name starts with the specified letter will be returned (case-insensitive)
799
-
799
+ * @deprecated
800
800
  * @throws {RequiredError}
801
801
  */
802
802
  getPersonsCollection: (cursor, limit, since, until, owner_id, first_char) => __awaiter(this, void 0, void 0, function* () {
@@ -811,7 +811,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
811
811
  const localVarHeaderParameter = {};
812
812
  const localVarQueryParameter = {};
813
813
  // authentication api_key required
814
- yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
814
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
815
815
  // authentication oauth2 required
816
816
  // oauth required
817
817
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full"], configuration);
@@ -864,7 +864,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
864
864
  const localVarHeaderParameter = {};
865
865
  const localVarQueryParameter = {};
866
866
  // authentication api_key required
867
- yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
867
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
868
868
  // authentication oauth2 required
869
869
  // oauth required
870
870
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["contacts:full"], configuration);
@@ -888,7 +888,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
888
888
  * @param {'person.picture'} [include_fields] Supports including optional fields in the results which are not provided by default
889
889
  * @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.
890
890
  * @param {number} [limit] Items shown per page
891
-
891
+ * @deprecated
892
892
  * @throws {RequiredError}
893
893
  */
894
894
  searchPersons: (term, fields, exact_match, organization_id, include_fields, start, limit) => __awaiter(this, void 0, void 0, function* () {
@@ -905,7 +905,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
905
905
  const localVarHeaderParameter = {};
906
906
  const localVarQueryParameter = {};
907
907
  // authentication api_key required
908
- yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
908
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
909
909
  // authentication oauth2 required
910
910
  // oauth required
911
911
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full", "search:read"], configuration);
@@ -961,7 +961,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
961
961
  const localVarHeaderParameter = {};
962
962
  const localVarQueryParameter = {};
963
963
  // authentication api_key required
964
- yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
964
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
965
965
  // authentication oauth2 required
966
966
  // oauth required
967
967
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["contacts:full"], configuration);
@@ -989,7 +989,7 @@ const PersonsApiFp = function (configuration) {
989
989
  * Adds a new person. 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 personFields and look for `key` values.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `data.marketing_status` field.
990
990
  * @summary Add a person
991
991
  * @param {AddPersonRequest} [AddPersonRequest]
992
-
992
+ * @deprecated
993
993
  * @throws {RequiredError}
994
994
  */
995
995
  addPerson(AddPersonRequest) {
@@ -1034,7 +1034,7 @@ const PersonsApiFp = function (configuration) {
1034
1034
  * Marks a person as deleted. After 30 days, the person will be permanently deleted.
1035
1035
  * @summary Delete a person
1036
1036
  * @param {number} id The ID of the person
1037
-
1037
+ * @deprecated
1038
1038
  * @throws {RequiredError}
1039
1039
  */
1040
1040
  deletePerson(id) {
@@ -1071,10 +1071,10 @@ const PersonsApiFp = function (configuration) {
1071
1071
  });
1072
1072
  },
1073
1073
  /**
1074
- * Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
1074
+ * Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#deletePerson\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/persons/{id}</a> instead.
1075
1075
  * @summary Delete multiple persons in bulk
1076
1076
  * @param {string} ids The comma-separated IDs that will be deleted
1077
-
1077
+ * @deprecated
1078
1078
  * @throws {RequiredError}
1079
1079
  */
1080
1080
  deletePersons(ids) {
@@ -1087,7 +1087,7 @@ const PersonsApiFp = function (configuration) {
1087
1087
  * Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.<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.
1088
1088
  * @summary Get details of a person
1089
1089
  * @param {number} id The ID of the person
1090
-
1090
+ * @deprecated
1091
1091
  * @throws {RequiredError}
1092
1092
  */
1093
1093
  getPerson(id) {
@@ -1097,14 +1097,14 @@ const PersonsApiFp = function (configuration) {
1097
1097
  });
1098
1098
  },
1099
1099
  /**
1100
- * Lists activities associated with a person.
1100
+ * Lists activities associated with a person. <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?person_id={id}</a> instead.
1101
1101
  * @summary List activities associated with a person
1102
1102
  * @param {number} id The ID of the person
1103
1103
  * @param {number} [start] Pagination start
1104
1104
  * @param {number} [limit] Items shown per page
1105
1105
  * @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.
1106
1106
  * @param {string} [exclude] A comma-separated string of activity IDs to exclude from result
1107
-
1107
+ * @deprecated
1108
1108
  * @throws {RequiredError}
1109
1109
  */
1110
1110
  getPersonActivities(id, start, limit, done, exclude) {
@@ -1129,14 +1129,14 @@ const PersonsApiFp = function (configuration) {
1129
1129
  });
1130
1130
  },
1131
1131
  /**
1132
- * Lists deals associated with a person.
1132
+ * Lists deals associated with a person. <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?person_id={id}</a> instead.
1133
1133
  * @summary List deals associated with a person
1134
1134
  * @param {number} id The ID of the person
1135
1135
  * @param {number} [start] Pagination start
1136
1136
  * @param {number} [limit] Items shown per page
1137
1137
  * @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.
1138
1138
  * @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).
1139
-
1139
+ * @deprecated
1140
1140
  * @throws {RequiredError}
1141
1141
  */
1142
1142
  getPersonDeals(id, start, limit, status, sort) {
@@ -1243,7 +1243,7 @@ const PersonsApiFp = function (configuration) {
1243
1243
  * @param {number} [start] Pagination start
1244
1244
  * @param {number} [limit] Items shown per page
1245
1245
  * @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).
1246
-
1246
+ * @deprecated
1247
1247
  * @throws {RequiredError}
1248
1248
  */
1249
1249
  getPersons(user_id, filter_id, first_char, start, limit, sort) {
@@ -1253,15 +1253,15 @@ const PersonsApiFp = function (configuration) {
1253
1253
  });
1254
1254
  },
1255
1255
  /**
1256
- * Returns all persons. 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>.
1257
- * @summary Get all persons (BETA)
1256
+ * Returns all persons. 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/Persons#getPersons\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/persons</a> instead.
1257
+ * @summary Get all persons collection
1258
1258
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
1259
1259
  * @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.
1260
1260
  * @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.
1261
1261
  * @param {string} [until] The time boundary that points to the end 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.
1262
1262
  * @param {number} [owner_id] If supplied, only persons owned by the given user will be returned
1263
1263
  * @param {string} [first_char] If supplied, only persons whose name starts with the specified letter will be returned (case-insensitive)
1264
-
1264
+ * @deprecated
1265
1265
  * @throws {RequiredError}
1266
1266
  */
1267
1267
  getPersonsCollection(cursor, limit, since, until, owner_id, first_char) {
@@ -1294,7 +1294,7 @@ const PersonsApiFp = function (configuration) {
1294
1294
  * @param {'person.picture'} [include_fields] Supports including optional fields in the results which are not provided by default
1295
1295
  * @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.
1296
1296
  * @param {number} [limit] Items shown per page
1297
-
1297
+ * @deprecated
1298
1298
  * @throws {RequiredError}
1299
1299
  */
1300
1300
  searchPersons(term, fields, exact_match, organization_id, include_fields, start, limit) {
@@ -1331,7 +1331,7 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
1331
1331
  * Adds a new person. 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 personFields and look for `key` values.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `data.marketing_status` field.
1332
1332
  * @summary Add a person
1333
1333
  * @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
1334
-
1334
+ * @deprecated
1335
1335
  * @throws {RequiredError}
1336
1336
  */
1337
1337
  addPerson(requestParameters = {}) {
@@ -1361,7 +1361,7 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
1361
1361
  * Marks a person as deleted. After 30 days, the person will be permanently deleted.
1362
1362
  * @summary Delete a person
1363
1363
  * @param {PersonsApiDeletePersonRequest} requestParameters Request parameters.
1364
-
1364
+ * @deprecated
1365
1365
  * @throws {RequiredError}
1366
1366
  */
1367
1367
  deletePerson(requestParameters) {
@@ -1388,10 +1388,10 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
1388
1388
  return localVarFp.deletePersonPicture(requestParameters.id).then((request) => request(axios, basePath));
1389
1389
  },
1390
1390
  /**
1391
- * Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
1391
+ * Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#deletePerson\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/persons/{id}</a> instead.
1392
1392
  * @summary Delete multiple persons in bulk
1393
1393
  * @param {PersonsApiDeletePersonsRequest} requestParameters Request parameters.
1394
-
1394
+ * @deprecated
1395
1395
  * @throws {RequiredError}
1396
1396
  */
1397
1397
  deletePersons(requestParameters) {
@@ -1401,17 +1401,17 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
1401
1401
  * Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.<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.
1402
1402
  * @summary Get details of a person
1403
1403
  * @param {PersonsApiGetPersonRequest} requestParameters Request parameters.
1404
-
1404
+ * @deprecated
1405
1405
  * @throws {RequiredError}
1406
1406
  */
1407
1407
  getPerson(requestParameters) {
1408
1408
  return localVarFp.getPerson(requestParameters.id).then((request) => request(axios, basePath));
1409
1409
  },
1410
1410
  /**
1411
- * Lists activities associated with a person.
1411
+ * Lists activities associated with a person. <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?person_id={id}</a> instead.
1412
1412
  * @summary List activities associated with a person
1413
1413
  * @param {PersonsApiGetPersonActivitiesRequest} requestParameters Request parameters.
1414
-
1414
+ * @deprecated
1415
1415
  * @throws {RequiredError}
1416
1416
  */
1417
1417
  getPersonActivities(requestParameters) {
@@ -1428,10 +1428,10 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
1428
1428
  return localVarFp.getPersonChangelog(requestParameters.id, requestParameters.cursor, requestParameters.limit).then((request) => request(axios, basePath));
1429
1429
  },
1430
1430
  /**
1431
- * Lists deals associated with a person.
1431
+ * Lists deals associated with a person. <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?person_id={id}</a> instead.
1432
1432
  * @summary List deals associated with a person
1433
1433
  * @param {PersonsApiGetPersonDealsRequest} requestParameters Request parameters.
1434
-
1434
+ * @deprecated
1435
1435
  * @throws {RequiredError}
1436
1436
  */
1437
1437
  getPersonDeals(requestParameters) {
@@ -1501,17 +1501,17 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
1501
1501
  * Returns all persons.
1502
1502
  * @summary Get all persons
1503
1503
  * @param {PersonsApiGetPersonsRequest} requestParameters Request parameters.
1504
-
1504
+ * @deprecated
1505
1505
  * @throws {RequiredError}
1506
1506
  */
1507
1507
  getPersons(requestParameters = {}) {
1508
1508
  return localVarFp.getPersons(requestParameters.user_id, requestParameters.filter_id, requestParameters.first_char, requestParameters.start, requestParameters.limit, requestParameters.sort).then((request) => request(axios, basePath));
1509
1509
  },
1510
1510
  /**
1511
- * Returns all persons. 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>.
1512
- * @summary Get all persons (BETA)
1511
+ * Returns all persons. 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/Persons#getPersons\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/persons</a> instead.
1512
+ * @summary Get all persons collection
1513
1513
  * @param {PersonsApiGetPersonsCollectionRequest} requestParameters Request parameters.
1514
-
1514
+ * @deprecated
1515
1515
  * @throws {RequiredError}
1516
1516
  */
1517
1517
  getPersonsCollection(requestParameters = {}) {
@@ -1531,7 +1531,7 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
1531
1531
  * Searches all persons by name, email, phone, 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 persons can be filtered by organization ID.
1532
1532
  * @summary Search persons
1533
1533
  * @param {PersonsApiSearchPersonsRequest} requestParameters Request parameters.
1534
-
1534
+ * @deprecated
1535
1535
  * @throws {RequiredError}
1536
1536
  */
1537
1537
  searchPersons(requestParameters) {
@@ -1561,7 +1561,7 @@ class PersonsApi extends base_1.BaseAPI {
1561
1561
  * Adds a new person. 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 personFields and look for `key` values.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `data.marketing_status` field.
1562
1562
  * @summary Add a person
1563
1563
  * @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
1564
-
1564
+ * @deprecated
1565
1565
  * @throws {RequiredError}
1566
1566
  * @memberof PersonsApi
1567
1567
  */
@@ -1594,7 +1594,7 @@ class PersonsApi extends base_1.BaseAPI {
1594
1594
  * Marks a person as deleted. After 30 days, the person will be permanently deleted.
1595
1595
  * @summary Delete a person
1596
1596
  * @param {PersonsApiDeletePersonRequest} requestParameters Request parameters.
1597
-
1597
+ * @deprecated
1598
1598
  * @throws {RequiredError}
1599
1599
  * @memberof PersonsApi
1600
1600
  */
@@ -1624,10 +1624,10 @@ class PersonsApi extends base_1.BaseAPI {
1624
1624
  return (0, exports.PersonsApiFp)(this.configuration).deletePersonPicture(requestParameters.id).then((request) => request(this.axios, this.basePath));
1625
1625
  }
1626
1626
  /**
1627
- * Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
1627
+ * Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#deletePerson\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/persons/{id}</a> instead.
1628
1628
  * @summary Delete multiple persons in bulk
1629
1629
  * @param {PersonsApiDeletePersonsRequest} requestParameters Request parameters.
1630
-
1630
+ * @deprecated
1631
1631
  * @throws {RequiredError}
1632
1632
  * @memberof PersonsApi
1633
1633
  */
@@ -1638,7 +1638,7 @@ class PersonsApi extends base_1.BaseAPI {
1638
1638
  * Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.<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.
1639
1639
  * @summary Get details of a person
1640
1640
  * @param {PersonsApiGetPersonRequest} requestParameters Request parameters.
1641
-
1641
+ * @deprecated
1642
1642
  * @throws {RequiredError}
1643
1643
  * @memberof PersonsApi
1644
1644
  */
@@ -1646,10 +1646,10 @@ class PersonsApi extends base_1.BaseAPI {
1646
1646
  return (0, exports.PersonsApiFp)(this.configuration).getPerson(requestParameters.id).then((request) => request(this.axios, this.basePath));
1647
1647
  }
1648
1648
  /**
1649
- * Lists activities associated with a person.
1649
+ * Lists activities associated with a person. <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?person_id={id}</a> instead.
1650
1650
  * @summary List activities associated with a person
1651
1651
  * @param {PersonsApiGetPersonActivitiesRequest} requestParameters Request parameters.
1652
-
1652
+ * @deprecated
1653
1653
  * @throws {RequiredError}
1654
1654
  * @memberof PersonsApi
1655
1655
  */
@@ -1668,10 +1668,10 @@ class PersonsApi extends base_1.BaseAPI {
1668
1668
  return (0, exports.PersonsApiFp)(this.configuration).getPersonChangelog(requestParameters.id, requestParameters.cursor, requestParameters.limit).then((request) => request(this.axios, this.basePath));
1669
1669
  }
1670
1670
  /**
1671
- * Lists deals associated with a person.
1671
+ * Lists deals associated with a person. <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?person_id={id}</a> instead.
1672
1672
  * @summary List deals associated with a person
1673
1673
  * @param {PersonsApiGetPersonDealsRequest} requestParameters Request parameters.
1674
-
1674
+ * @deprecated
1675
1675
  * @throws {RequiredError}
1676
1676
  * @memberof PersonsApi
1677
1677
  */
@@ -1748,7 +1748,7 @@ class PersonsApi extends base_1.BaseAPI {
1748
1748
  * Returns all persons.
1749
1749
  * @summary Get all persons
1750
1750
  * @param {PersonsApiGetPersonsRequest} requestParameters Request parameters.
1751
-
1751
+ * @deprecated
1752
1752
  * @throws {RequiredError}
1753
1753
  * @memberof PersonsApi
1754
1754
  */
@@ -1756,10 +1756,10 @@ class PersonsApi extends base_1.BaseAPI {
1756
1756
  return (0, exports.PersonsApiFp)(this.configuration).getPersons(requestParameters.user_id, requestParameters.filter_id, requestParameters.first_char, requestParameters.start, requestParameters.limit, requestParameters.sort).then((request) => request(this.axios, this.basePath));
1757
1757
  }
1758
1758
  /**
1759
- * Returns all persons. 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>.
1760
- * @summary Get all persons (BETA)
1759
+ * Returns all persons. 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/Persons#getPersons\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/persons</a> instead.
1760
+ * @summary Get all persons collection
1761
1761
  * @param {PersonsApiGetPersonsCollectionRequest} requestParameters Request parameters.
1762
-
1762
+ * @deprecated
1763
1763
  * @throws {RequiredError}
1764
1764
  * @memberof PersonsApi
1765
1765
  */
@@ -1781,7 +1781,7 @@ class PersonsApi extends base_1.BaseAPI {
1781
1781
  * Searches all persons by name, email, phone, 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 persons can be filtered by organization ID.
1782
1782
  * @summary Search persons
1783
1783
  * @param {PersonsApiSearchPersonsRequest} requestParameters Request parameters.
1784
-
1784
+ * @deprecated
1785
1785
  * @throws {RequiredError}
1786
1786
  * @memberof PersonsApi
1787
1787
  */