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
@@ -38,6 +38,81 @@ const base_1 = require("../base");
38
38
  */
39
39
  const LeadsApiAxiosParamCreator = function (configuration) {
40
40
  return {
41
+ /**
42
+ * Initiates a conversion of a lead to a deal. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. If the conversion is successful, the lead is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#getLeadConversionStatus\">/api/v2/leads/{lead_id}/convert/status/{conversion_id}</a> endpoint.
43
+ * @summary Convert a lead to a deal (BETA)
44
+ * @param {string} id The ID of the lead to convert
45
+ * @param {ConvertLeadToDealRequest} [ConvertLeadToDealRequest]
46
+
47
+ * @throws {RequiredError}
48
+ */
49
+ convertLeadToDeal: (id, ConvertLeadToDealRequest) => __awaiter(this, void 0, void 0, function* () {
50
+ // verify required parameter 'id' is not null or undefined
51
+ (0, common_1.assertParamExists)('convertLeadToDeal', 'id', id);
52
+ const localVarPath = `/leads/{id}/convert/deal`
53
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
54
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
55
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
56
+ let baseOptions;
57
+ if (configuration) {
58
+ baseOptions = configuration.baseOptions;
59
+ }
60
+ const localVarRequestOptions = Object.assign({ method: 'POST' }, baseOptions);
61
+ const localVarHeaderParameter = {};
62
+ const localVarQueryParameter = {};
63
+ // authentication api_key required
64
+ yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
65
+ // authentication oauth2 required
66
+ // oauth required
67
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["deals:full", "leads:full"], configuration);
68
+ localVarHeaderParameter['Content-Type'] = 'application/json';
69
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
70
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
71
+ localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
72
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(ConvertLeadToDealRequest, localVarRequestOptions, configuration);
73
+ return {
74
+ url: (0, common_1.toPathString)(localVarUrlObj),
75
+ options: localVarRequestOptions,
76
+ };
77
+ }),
78
+ /**
79
+ * Returns data about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Deal ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
80
+ * @summary Get Lead conversion status (BETA)
81
+ * @param {string} id The ID of a lead
82
+ * @param {string} conversion_id The ID of the conversion
83
+
84
+ * @throws {RequiredError}
85
+ */
86
+ getLeadConversionStatus: (id, conversion_id) => __awaiter(this, void 0, void 0, function* () {
87
+ // verify required parameter 'id' is not null or undefined
88
+ (0, common_1.assertParamExists)('getLeadConversionStatus', 'id', id);
89
+ // verify required parameter 'conversion_id' is not null or undefined
90
+ (0, common_1.assertParamExists)('getLeadConversionStatus', 'conversion_id', conversion_id);
91
+ const localVarPath = `/leads/{id}/convert/status/{conversion_id}`
92
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)))
93
+ .replace(`{${"conversion_id"}}`, encodeURIComponent(String(conversion_id)));
94
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
95
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
96
+ let baseOptions;
97
+ if (configuration) {
98
+ baseOptions = configuration.baseOptions;
99
+ }
100
+ const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
101
+ const localVarHeaderParameter = {};
102
+ const localVarQueryParameter = {};
103
+ // authentication api_key required
104
+ yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
105
+ // authentication oauth2 required
106
+ // oauth required
107
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["leads:read"], configuration);
108
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
109
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
110
+ localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
111
+ return {
112
+ url: (0, common_1.toPathString)(localVarUrlObj),
113
+ options: localVarRequestOptions,
114
+ };
115
+ }),
41
116
  /**
42
117
  * Searches all leads 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 leads can be filtered by the person ID and the organization ID.
43
118
  * @summary Search leads
@@ -112,6 +187,34 @@ exports.LeadsApiAxiosParamCreator = LeadsApiAxiosParamCreator;
112
187
  const LeadsApiFp = function (configuration) {
113
188
  const localVarAxiosParamCreator = (0, exports.LeadsApiAxiosParamCreator)(configuration);
114
189
  return {
190
+ /**
191
+ * Initiates a conversion of a lead to a deal. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. If the conversion is successful, the lead is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#getLeadConversionStatus\">/api/v2/leads/{lead_id}/convert/status/{conversion_id}</a> endpoint.
192
+ * @summary Convert a lead to a deal (BETA)
193
+ * @param {string} id The ID of the lead to convert
194
+ * @param {ConvertLeadToDealRequest} [ConvertLeadToDealRequest]
195
+
196
+ * @throws {RequiredError}
197
+ */
198
+ convertLeadToDeal(id, ConvertLeadToDealRequest) {
199
+ return __awaiter(this, void 0, void 0, function* () {
200
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.convertLeadToDeal(id, ConvertLeadToDealRequest);
201
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
202
+ });
203
+ },
204
+ /**
205
+ * Returns data about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Deal ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
206
+ * @summary Get Lead conversion status (BETA)
207
+ * @param {string} id The ID of a lead
208
+ * @param {string} conversion_id The ID of the conversion
209
+
210
+ * @throws {RequiredError}
211
+ */
212
+ getLeadConversionStatus(id, conversion_id) {
213
+ return __awaiter(this, void 0, void 0, function* () {
214
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getLeadConversionStatus(id, conversion_id);
215
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
216
+ });
217
+ },
115
218
  /**
116
219
  * Searches all leads 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 leads can be filtered by the person ID and the organization ID.
117
220
  * @summary Search leads
@@ -142,6 +245,26 @@ exports.LeadsApiFp = LeadsApiFp;
142
245
  const LeadsApiFactory = function (configuration, basePath, axios) {
143
246
  const localVarFp = (0, exports.LeadsApiFp)(configuration);
144
247
  return {
248
+ /**
249
+ * Initiates a conversion of a lead to a deal. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. If the conversion is successful, the lead is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#getLeadConversionStatus\">/api/v2/leads/{lead_id}/convert/status/{conversion_id}</a> endpoint.
250
+ * @summary Convert a lead to a deal (BETA)
251
+ * @param {LeadsApiConvertLeadToDealRequest} requestParameters Request parameters.
252
+
253
+ * @throws {RequiredError}
254
+ */
255
+ convertLeadToDeal(requestParameters) {
256
+ return localVarFp.convertLeadToDeal(requestParameters.id, requestParameters.ConvertLeadToDealRequest).then((request) => request(axios, basePath));
257
+ },
258
+ /**
259
+ * Returns data about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Deal ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
260
+ * @summary Get Lead conversion status (BETA)
261
+ * @param {LeadsApiGetLeadConversionStatusRequest} requestParameters Request parameters.
262
+
263
+ * @throws {RequiredError}
264
+ */
265
+ getLeadConversionStatus(requestParameters) {
266
+ return localVarFp.getLeadConversionStatus(requestParameters.id, requestParameters.conversion_id).then((request) => request(axios, basePath));
267
+ },
145
268
  /**
146
269
  * Searches all leads 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 leads can be filtered by the person ID and the organization ID.
147
270
  * @summary Search leads
@@ -162,6 +285,28 @@ exports.LeadsApiFactory = LeadsApiFactory;
162
285
  * @extends {BaseAPI}
163
286
  */
164
287
  class LeadsApi extends base_1.BaseAPI {
288
+ /**
289
+ * Initiates a conversion of a lead to a deal. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. If the conversion is successful, the lead is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#getLeadConversionStatus\">/api/v2/leads/{lead_id}/convert/status/{conversion_id}</a> endpoint.
290
+ * @summary Convert a lead to a deal (BETA)
291
+ * @param {LeadsApiConvertLeadToDealRequest} requestParameters Request parameters.
292
+
293
+ * @throws {RequiredError}
294
+ * @memberof LeadsApi
295
+ */
296
+ convertLeadToDeal(requestParameters) {
297
+ return (0, exports.LeadsApiFp)(this.configuration).convertLeadToDeal(requestParameters.id, requestParameters.ConvertLeadToDealRequest).then((request) => request(this.axios, this.basePath));
298
+ }
299
+ /**
300
+ * Returns data about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Deal ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
301
+ * @summary Get Lead conversion status (BETA)
302
+ * @param {LeadsApiGetLeadConversionStatusRequest} requestParameters Request parameters.
303
+
304
+ * @throws {RequiredError}
305
+ * @memberof LeadsApi
306
+ */
307
+ getLeadConversionStatus(requestParameters) {
308
+ return (0, exports.LeadsApiFp)(this.configuration).getLeadConversionStatus(requestParameters.id, requestParameters.conversion_id).then((request) => request(this.axios, this.basePath));
309
+ }
165
310
  /**
166
311
  * Searches all leads 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 leads can be filtered by the person ID and the organization ID.
167
312
  * @summary Search leads
@@ -29,7 +29,7 @@ import { UpsertPersonResponse } from '../models';
29
29
  */
30
30
  export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration) => {
31
31
  /**
32
- * Adds a new person.
32
+ * Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
33
33
  * @summary Add a new person
34
34
  * @param {AddPersonRequest} [AddPersonRequest]
35
35
 
@@ -126,7 +126,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
126
126
  */
127
127
  searchPersons: (term: string, fields?: 'custom_fields' | 'email' | 'notes' | 'phone' | 'name', exact_match?: boolean, organization_id?: number, include_fields?: 'person.picture', limit?: number, cursor?: string) => Promise<RequestArgs>;
128
128
  /**
129
- * Updates the properties of a person.
129
+ * Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
130
130
  * @summary Update a person
131
131
  * @param {number} id The ID of the person
132
132
  * @param {UpdatePersonRequest} [UpdatePersonRequest]
@@ -141,7 +141,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
141
141
  */
142
142
  export declare const PersonsApiFp: (configuration?: Configuration) => {
143
143
  /**
144
- * Adds a new person.
144
+ * Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
145
145
  * @summary Add a new person
146
146
  * @param {AddPersonRequest} [AddPersonRequest]
147
147
 
@@ -238,7 +238,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
238
238
  */
239
239
  searchPersons(term: string, fields?: 'custom_fields' | 'email' | 'notes' | 'phone' | 'name', exact_match?: boolean, organization_id?: number, include_fields?: 'person.picture', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonSearchResponse>>;
240
240
  /**
241
- * Updates the properties of a person.
241
+ * Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
242
242
  * @summary Update a person
243
243
  * @param {number} id The ID of the person
244
244
  * @param {UpdatePersonRequest} [UpdatePersonRequest]
@@ -253,7 +253,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
253
253
  */
254
254
  export declare const PersonsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
255
255
  /**
256
- * Adds a new person.
256
+ * Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
257
257
  * @summary Add a new person
258
258
  * @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
259
259
 
@@ -325,7 +325,7 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
325
325
  */
326
326
  searchPersons(requestParameters: PersonsApiSearchPersonsRequest): Promise<GetPersonSearchResponse>;
327
327
  /**
328
- * Updates the properties of a person.
328
+ * Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
329
329
  * @summary Update a person
330
330
  * @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters.
331
331
 
@@ -627,7 +627,7 @@ export interface PersonsApiUpdatePersonRequest {
627
627
  */
628
628
  export declare class PersonsApi extends BaseAPI {
629
629
  /**
630
- * Adds a new person.
630
+ * Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
631
631
  * @summary Add a new person
632
632
  * @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
633
633
 
@@ -708,7 +708,7 @@ export declare class PersonsApi extends BaseAPI {
708
708
  */
709
709
  searchPersons(requestParameters: PersonsApiSearchPersonsRequest): Promise<GetPersonSearchResponse>;
710
710
  /**
711
- * Updates the properties of a person.
711
+ * Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
712
712
  * @summary Update a person
713
713
  * @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters.
714
714
 
@@ -39,7 +39,7 @@ const base_1 = require("../base");
39
39
  const PersonsApiAxiosParamCreator = function (configuration) {
40
40
  return {
41
41
  /**
42
- * Adds a new person.
42
+ * Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
43
43
  * @summary Add a new person
44
44
  * @param {AddPersonRequest} [AddPersonRequest]
45
45
 
@@ -445,7 +445,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
445
445
  };
446
446
  }),
447
447
  /**
448
- * Updates the properties of a person.
448
+ * Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
449
449
  * @summary Update a person
450
450
  * @param {number} id The ID of the person
451
451
  * @param {UpdatePersonRequest} [UpdatePersonRequest]
@@ -492,7 +492,7 @@ const PersonsApiFp = function (configuration) {
492
492
  const localVarAxiosParamCreator = (0, exports.PersonsApiAxiosParamCreator)(configuration);
493
493
  return {
494
494
  /**
495
- * Adds a new person.
495
+ * Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
496
496
  * @summary Add a new person
497
497
  * @param {AddPersonRequest} [AddPersonRequest]
498
498
 
@@ -634,7 +634,7 @@ const PersonsApiFp = function (configuration) {
634
634
  });
635
635
  },
636
636
  /**
637
- * Updates the properties of a person.
637
+ * Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
638
638
  * @summary Update a person
639
639
  * @param {number} id The ID of the person
640
640
  * @param {UpdatePersonRequest} [UpdatePersonRequest]
@@ -658,7 +658,7 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
658
658
  const localVarFp = (0, exports.PersonsApiFp)(configuration);
659
659
  return {
660
660
  /**
661
- * Adds a new person.
661
+ * Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
662
662
  * @summary Add a new person
663
663
  * @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
664
664
 
@@ -748,7 +748,7 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
748
748
  return localVarFp.searchPersons(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.organization_id, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
749
749
  },
750
750
  /**
751
- * Updates the properties of a person.
751
+ * Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
752
752
  * @summary Update a person
753
753
  * @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters.
754
754
 
@@ -768,7 +768,7 @@ exports.PersonsApiFactory = PersonsApiFactory;
768
768
  */
769
769
  class PersonsApi extends base_1.BaseAPI {
770
770
  /**
771
- * Adds a new person.
771
+ * Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
772
772
  * @summary Add a new person
773
773
  * @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
774
774
 
@@ -867,7 +867,7 @@ class PersonsApi extends base_1.BaseAPI {
867
867
  return (0, exports.PersonsApiFp)(this.configuration).searchPersons(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.organization_id, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
868
868
  }
869
869
  /**
870
- * Updates the properties of a person.
870
+ * Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
871
871
  * @summary Update a person
872
872
  * @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters.
873
873
 
@@ -97,7 +97,7 @@ const ProductsApiAxiosParamCreator = function (configuration) {
97
97
  yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
98
98
  // authentication oauth2 required
99
99
  // oauth required
100
- yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", [], configuration);
100
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["products:full"], configuration);
101
101
  localVarHeaderParameter['Content-Type'] = 'application/json';
102
102
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
103
103
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -10,8 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { Configuration } from './configuration';
13
- import type { AxiosError, AxiosResponse, AxiosRequestConfig, InternalAxiosRequestConfig } from 'axios';
14
- import axios from 'axios';
13
+ import type { AxiosError, AxiosResponse, AxiosRequestConfig, InternalAxiosRequestConfig, AxiosInstance } from 'axios';
15
14
  export declare const BASE_PATH: string;
16
15
  /**
17
16
  *
@@ -43,7 +42,7 @@ export declare const errorInterceptor: (error: AxiosError) => Promise<never>;
43
42
  export declare class BaseAPI {
44
43
  protected configuration: Configuration | undefined;
45
44
  protected basePath: string;
46
- protected axios: axios.AxiosInstance;
45
+ protected axios: AxiosInstance;
47
46
  constructor(configuration: Configuration);
48
47
  }
49
48
  /**
@@ -9,7 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import axios from "axios";
12
+ import { AxiosResponse } from "axios";
13
13
  export type TokenResponse = {
14
14
  access_token: string;
15
15
  refresh_token: string;
@@ -54,7 +54,7 @@ export declare class OAuth2Configuration {
54
54
  * Revoke Refresh Token aka marking an app uninstalled or revoke the Access Token.
55
55
  * @param {String} tokenTypeHint values can be: 'access_token' or 'refresh_token'.
56
56
  */
57
- revokeToken(tokenTypeHint?: 'access_token' | 'refresh_token'): Promise<axios.AxiosResponse<any, any>>;
57
+ revokeToken(tokenTypeHint?: 'access_token' | 'refresh_token'): Promise<AxiosResponse<any, any>>;
58
58
  private validateParam;
59
59
  }
60
60
  export interface ConfigurationParameters {
@@ -39,6 +39,11 @@ export interface ActivityItem {
39
39
  */
40
40
  'owner_id'?: number;
41
41
  /**
42
+ * The ID of the user who created the activity
43
+ * @type {number}
44
+ */
45
+ 'creator_user_id'?: number;
46
+ /**
42
47
  * Whether the activity is deleted or not
43
48
  * @type {boolean}
44
49
  */
@@ -39,6 +39,11 @@ export interface ActivityItem1 {
39
39
  */
40
40
  'owner_id'?: number;
41
41
  /**
42
+ * The ID of the user who created the activity
43
+ * @type {number}
44
+ */
45
+ 'creator_user_id'?: number;
46
+ /**
42
47
  * Whether the activity is deleted or not
43
48
  * @type {boolean}
44
49
  */
@@ -0,0 +1,23 @@
1
+ /**
2
+ * Pipedrive API v2
3
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * An object containing conversion job id that performs the conversion
14
+ * @export
15
+ * @interface AddConvertDealToLeadResponseData
16
+ */
17
+ export interface AddConvertDealToLeadResponseData {
18
+ /**
19
+ * The ID of the conversion job that can be used to retrieve conversion status and details. The ID has UUID format.
20
+ * @type {string}
21
+ */
22
+ 'conversion_id': string;
23
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Pipedrive API v2
6
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,34 @@
1
+ /**
2
+ * Pipedrive API v2
3
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AddConvertDealToLeadResponseData } from './add-convert-deal-to-lead-response-data';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface AddConvertDealToLeadResponse
17
+ */
18
+ export interface AddConvertDealToLeadResponse {
19
+ /**
20
+ *
21
+ * @type {boolean}
22
+ */
23
+ 'success'?: boolean;
24
+ /**
25
+ *
26
+ * @type {AddConvertDealToLeadResponseData}
27
+ */
28
+ 'data'?: AddConvertDealToLeadResponseData;
29
+ /**
30
+ *
31
+ * @type {object}
32
+ */
33
+ 'additional_data'?: object | null;
34
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Pipedrive API v2
6
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,34 @@
1
+ /**
2
+ * Pipedrive API v2
3
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AddConvertDealToLeadResponseData } from './add-convert-deal-to-lead-response-data';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface AddConvertLeadToDealResponse
17
+ */
18
+ export interface AddConvertLeadToDealResponse {
19
+ /**
20
+ *
21
+ * @type {boolean}
22
+ */
23
+ 'success'?: boolean;
24
+ /**
25
+ *
26
+ * @type {AddConvertDealToLeadResponseData}
27
+ */
28
+ 'data'?: AddConvertDealToLeadResponseData;
29
+ /**
30
+ *
31
+ * @type {object}
32
+ */
33
+ 'additional_data'?: object | null;
34
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Pipedrive API v2
6
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -62,4 +62,16 @@ export interface AddPersonRequest {
62
62
  * @type {Array<number>}
63
63
  */
64
64
  'label_ids'?: Array<number>;
65
+ /**
66
+ * If the person does not have a valid email address, then the marketing status is **not set** and `no_consent` is returned for the `marketing_status` value when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed **once** to change the marketing status from an old status to a new one.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`no_consent`</td><td>The customer has not given consent to receive any marketing communications</td></tr><tr><td>`unsubscribed`</td><td>The customers have unsubscribed from ALL marketing communications</td></tr><tr><td>`subscribed`</td><td>The customers are subscribed and are counted towards marketing caps</td></tr><tr><td>`archived`</td><td>The customers with `subscribed` status can be moved to `archived` to save consent, but they are not paid for</td></tr></table>
67
+ * @type {string}
68
+ */
69
+ 'marketing_status'?: AddPersonRequestMarketingStatusConst;
65
70
  }
71
+ export declare const AddPersonRequestMarketingStatusConst: {
72
+ readonly no_consent: "no_consent";
73
+ readonly unsubscribed: "unsubscribed";
74
+ readonly subscribed: "subscribed";
75
+ readonly archived: "archived";
76
+ };
77
+ export type AddPersonRequestMarketingStatusConst = typeof AddPersonRequestMarketingStatusConst[keyof typeof AddPersonRequestMarketingStatusConst];
@@ -13,3 +13,10 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.AddPersonRequestMarketingStatusConst = void 0;
17
+ exports.AddPersonRequestMarketingStatusConst = {
18
+ no_consent: 'no_consent',
19
+ unsubscribed: 'unsubscribed',
20
+ subscribed: 'subscribed',
21
+ archived: 'archived'
22
+ };
@@ -0,0 +1,28 @@
1
+ /**
2
+ * Pipedrive API v2
3
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface ConvertLeadToDealRequest
16
+ */
17
+ export interface ConvertLeadToDealRequest {
18
+ /**
19
+ * The ID of a stage the created deal will be added to. Please note that a pipeline will be assigned automatically based on the `stage_id`. If omitted, the deal will be placed in the first stage of the default pipeline.
20
+ * @type {number}
21
+ */
22
+ 'stage_id'?: number;
23
+ /**
24
+ * The ID of a pipeline the created deal will be added to. By default, the deal will be added to the first stage of the specified pipeline. Please note that `pipeline_id` and `stage_id` should not be used together as `pipeline_id` will be ignored.
25
+ * @type {number}
26
+ */
27
+ 'pipeline_id'?: number;
28
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Pipedrive API v2
6
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -76,6 +76,11 @@ export interface DealItem {
76
76
  */
77
77
  'stage_change_time'?: string;
78
78
  /**
79
+ * Whether the deal is archived or not
80
+ * @type {boolean}
81
+ */
82
+ 'is_archived'?: boolean;
83
+ /**
79
84
  * Whether the deal is deleted or not
80
85
  * @type {boolean}
81
86
  */
@@ -76,6 +76,11 @@ export interface DealItem1 {
76
76
  */
77
77
  'stage_change_time'?: string;
78
78
  /**
79
+ * Whether the deal is archived or not
80
+ * @type {boolean}
81
+ */
82
+ 'is_archived'?: boolean;
83
+ /**
79
84
  * Whether the deal is deleted or not
80
85
  * @type {boolean}
81
86
  */