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
@@ -51,7 +51,7 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
51
51
  const localVarHeaderParameter = {};
52
52
  const localVarQueryParameter = {};
53
53
  // authentication api_key required
54
- yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
54
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
55
55
  // authentication oauth2 required
56
56
  // oauth required
57
57
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["leads:full"], configuration);
@@ -87,7 +87,7 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
87
87
  const localVarHeaderParameter = {};
88
88
  const localVarQueryParameter = {};
89
89
  // authentication api_key required
90
- yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
90
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
91
91
  // authentication oauth2 required
92
92
  // oauth required
93
93
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["leads:full"], configuration);
@@ -99,6 +99,64 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
99
99
  options: localVarRequestOptions,
100
100
  };
101
101
  }),
102
+ /**
103
+ * Returns multiple archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
104
+ * @summary Get all archived leads
105
+ * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
106
+ * @param {number} [start] For pagination, the position that represents the first result for the page
107
+ * @param {number} [owner_id] If supplied, only leads matching the given user will be returned. However, `filter_id` takes precedence over `owner_id` when supplied.
108
+ * @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
109
+ * @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
110
+ * @param {number} [filter_id] The ID of the filter to use
111
+ * @param {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
112
+
113
+ * @throws {RequiredError}
114
+ */
115
+ getArchivedLeads: (limit, start, owner_id, person_id, organization_id, filter_id, sort) => __awaiter(this, void 0, void 0, function* () {
116
+ const localVarPath = `/leads/archived`;
117
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
118
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
119
+ let baseOptions;
120
+ if (configuration) {
121
+ baseOptions = configuration.baseOptions;
122
+ }
123
+ const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
124
+ const localVarHeaderParameter = {};
125
+ const localVarQueryParameter = {};
126
+ // authentication api_key required
127
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
128
+ // authentication oauth2 required
129
+ // oauth required
130
+ yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["leads:read", "leads:full"], configuration);
131
+ if (limit !== undefined) {
132
+ localVarQueryParameter['limit'] = limit;
133
+ }
134
+ if (start !== undefined) {
135
+ localVarQueryParameter['start'] = start;
136
+ }
137
+ if (owner_id !== undefined) {
138
+ localVarQueryParameter['owner_id'] = owner_id;
139
+ }
140
+ if (person_id !== undefined) {
141
+ localVarQueryParameter['person_id'] = person_id;
142
+ }
143
+ if (organization_id !== undefined) {
144
+ localVarQueryParameter['organization_id'] = organization_id;
145
+ }
146
+ if (filter_id !== undefined) {
147
+ localVarQueryParameter['filter_id'] = filter_id;
148
+ }
149
+ if (sort !== undefined) {
150
+ localVarQueryParameter['sort'] = sort;
151
+ }
152
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
153
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
154
+ localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
155
+ return {
156
+ url: toPathString(localVarUrlObj),
157
+ options: localVarRequestOptions,
158
+ };
159
+ }),
102
160
  /**
103
161
  * Returns details of a specific lead. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals.
104
162
  * @summary Get one lead
@@ -121,7 +179,7 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
121
179
  const localVarHeaderParameter = {};
122
180
  const localVarQueryParameter = {};
123
181
  // authentication api_key required
124
- yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
182
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
125
183
  // authentication oauth2 required
126
184
  // oauth required
127
185
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["leads:read", "leads:full"], configuration);
@@ -155,7 +213,7 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
155
213
  const localVarHeaderParameter = {};
156
214
  const localVarQueryParameter = {};
157
215
  // authentication api_key required
158
- yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
216
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
159
217
  // authentication oauth2 required
160
218
  // oauth required
161
219
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["leads:read", "leads:full"], configuration);
@@ -168,11 +226,10 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
168
226
  };
169
227
  }),
170
228
  /**
171
- * Returns multiple leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
229
+ * Returns multiple not archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
172
230
  * @summary Get all leads
173
231
  * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
174
232
  * @param {number} [start] For pagination, the position that represents the first result for the page
175
- * @param {'archived' | 'not_archived' | 'all'} [archived_status] Filtering based on the archived status of a lead. If not provided, `All` is used.
176
233
  * @param {number} [owner_id] If supplied, only leads matching the given user will be returned. However, `filter_id` takes precedence over `owner_id` when supplied.
177
234
  * @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
178
235
  * @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
@@ -181,7 +238,7 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
181
238
 
182
239
  * @throws {RequiredError}
183
240
  */
184
- getLeads: (limit, start, archived_status, owner_id, person_id, organization_id, filter_id, sort) => __awaiter(this, void 0, void 0, function* () {
241
+ getLeads: (limit, start, owner_id, person_id, organization_id, filter_id, sort) => __awaiter(this, void 0, void 0, function* () {
185
242
  const localVarPath = `/leads`;
186
243
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
187
244
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -193,7 +250,7 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
193
250
  const localVarHeaderParameter = {};
194
251
  const localVarQueryParameter = {};
195
252
  // authentication api_key required
196
- yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
253
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
197
254
  // authentication oauth2 required
198
255
  // oauth required
199
256
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["leads:read", "leads:full"], configuration);
@@ -203,9 +260,6 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
203
260
  if (start !== undefined) {
204
261
  localVarQueryParameter['start'] = start;
205
262
  }
206
- if (archived_status !== undefined) {
207
- localVarQueryParameter['archived_status'] = archived_status;
208
- }
209
263
  if (owner_id !== undefined) {
210
264
  localVarQueryParameter['owner_id'] = owner_id;
211
265
  }
@@ -257,7 +311,7 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
257
311
  const localVarHeaderParameter = {};
258
312
  const localVarQueryParameter = {};
259
313
  // authentication api_key required
260
- yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
314
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
261
315
  // authentication oauth2 required
262
316
  // oauth required
263
317
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["leads:read", "leads:full", "search:read"], configuration);
@@ -316,7 +370,7 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
316
370
  const localVarHeaderParameter = {};
317
371
  const localVarQueryParameter = {};
318
372
  // authentication api_key required
319
- yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
373
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
320
374
  // authentication oauth2 required
321
375
  // oauth required
322
376
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["leads:full"], configuration);
@@ -365,6 +419,25 @@ export const LeadsApiFp = function (configuration) {
365
419
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
366
420
  });
367
421
  },
422
+ /**
423
+ * Returns multiple archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
424
+ * @summary Get all archived leads
425
+ * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
426
+ * @param {number} [start] For pagination, the position that represents the first result for the page
427
+ * @param {number} [owner_id] If supplied, only leads matching the given user will be returned. However, `filter_id` takes precedence over `owner_id` when supplied.
428
+ * @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
429
+ * @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
430
+ * @param {number} [filter_id] The ID of the filter to use
431
+ * @param {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
432
+
433
+ * @throws {RequiredError}
434
+ */
435
+ getArchivedLeads(limit, start, owner_id, person_id, organization_id, filter_id, sort) {
436
+ return __awaiter(this, void 0, void 0, function* () {
437
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getArchivedLeads(limit, start, owner_id, person_id, organization_id, filter_id, sort);
438
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
439
+ });
440
+ },
368
441
  /**
369
442
  * Returns details of a specific lead. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals.
370
443
  * @summary Get one lead
@@ -392,11 +465,10 @@ export const LeadsApiFp = function (configuration) {
392
465
  });
393
466
  },
394
467
  /**
395
- * Returns multiple leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
468
+ * Returns multiple not archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
396
469
  * @summary Get all leads
397
470
  * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
398
471
  * @param {number} [start] For pagination, the position that represents the first result for the page
399
- * @param {'archived' | 'not_archived' | 'all'} [archived_status] Filtering based on the archived status of a lead. If not provided, `All` is used.
400
472
  * @param {number} [owner_id] If supplied, only leads matching the given user will be returned. However, `filter_id` takes precedence over `owner_id` when supplied.
401
473
  * @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
402
474
  * @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
@@ -405,9 +477,9 @@ export const LeadsApiFp = function (configuration) {
405
477
 
406
478
  * @throws {RequiredError}
407
479
  */
408
- getLeads(limit, start, archived_status, owner_id, person_id, organization_id, filter_id, sort) {
480
+ getLeads(limit, start, owner_id, person_id, organization_id, filter_id, sort) {
409
481
  return __awaiter(this, void 0, void 0, function* () {
410
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getLeads(limit, start, archived_status, owner_id, person_id, organization_id, filter_id, sort);
482
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getLeads(limit, start, owner_id, person_id, organization_id, filter_id, sort);
411
483
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
412
484
  });
413
485
  },
@@ -474,6 +546,16 @@ export const LeadsApiFactory = function (configuration, basePath, axios) {
474
546
  deleteLead(requestParameters) {
475
547
  return localVarFp.deleteLead(requestParameters.id).then((request) => request(axios, basePath));
476
548
  },
549
+ /**
550
+ * Returns multiple archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
551
+ * @summary Get all archived leads
552
+ * @param {LeadsApiGetArchivedLeadsRequest} requestParameters Request parameters.
553
+
554
+ * @throws {RequiredError}
555
+ */
556
+ getArchivedLeads(requestParameters = {}) {
557
+ return localVarFp.getArchivedLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(axios, basePath));
558
+ },
477
559
  /**
478
560
  * Returns details of a specific lead. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals.
479
561
  * @summary Get one lead
@@ -495,14 +577,14 @@ export const LeadsApiFactory = function (configuration, basePath, axios) {
495
577
  return localVarFp.getLeadUsers(requestParameters.id).then((request) => request(axios, basePath));
496
578
  },
497
579
  /**
498
- * Returns multiple leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
580
+ * Returns multiple not archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
499
581
  * @summary Get all leads
500
582
  * @param {LeadsApiGetLeadsRequest} requestParameters Request parameters.
501
583
 
502
584
  * @throws {RequiredError}
503
585
  */
504
586
  getLeads(requestParameters = {}) {
505
- return localVarFp.getLeads(requestParameters.limit, requestParameters.start, requestParameters.archived_status, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(axios, basePath));
587
+ return localVarFp.getLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(axios, basePath));
506
588
  },
507
589
  /**
508
590
  * 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.
@@ -555,6 +637,17 @@ export class LeadsApi extends BaseAPI {
555
637
  deleteLead(requestParameters) {
556
638
  return LeadsApiFp(this.configuration).deleteLead(requestParameters.id).then((request) => request(this.axios, this.basePath));
557
639
  }
640
+ /**
641
+ * Returns multiple archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
642
+ * @summary Get all archived leads
643
+ * @param {LeadsApiGetArchivedLeadsRequest} requestParameters Request parameters.
644
+
645
+ * @throws {RequiredError}
646
+ * @memberof LeadsApi
647
+ */
648
+ getArchivedLeads(requestParameters = {}) {
649
+ return LeadsApiFp(this.configuration).getArchivedLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(this.axios, this.basePath));
650
+ }
558
651
  /**
559
652
  * Returns details of a specific lead. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals.
560
653
  * @summary Get one lead
@@ -578,7 +671,7 @@ export class LeadsApi extends BaseAPI {
578
671
  return LeadsApiFp(this.configuration).getLeadUsers(requestParameters.id).then((request) => request(this.axios, this.basePath));
579
672
  }
580
673
  /**
581
- * Returns multiple leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
674
+ * Returns multiple not archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
582
675
  * @summary Get all leads
583
676
  * @param {LeadsApiGetLeadsRequest} requestParameters Request parameters.
584
677
 
@@ -586,7 +679,7 @@ export class LeadsApi extends BaseAPI {
586
679
  * @memberof LeadsApi
587
680
  */
588
681
  getLeads(requestParameters = {}) {
589
- return LeadsApiFp(this.configuration).getLeads(requestParameters.limit, requestParameters.start, requestParameters.archived_status, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(this.axios, this.basePath));
682
+ return LeadsApiFp(this.configuration).getLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(this.axios, this.basePath));
590
683
  }
591
684
  /**
592
685
  * 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.
@@ -51,7 +51,7 @@ export const LegacyTeamsApiAxiosParamCreator = function (configuration) {
51
51
  const localVarHeaderParameter = {};
52
52
  const localVarQueryParameter = {};
53
53
  // authentication api_key required
54
- yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
54
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
55
55
  // authentication oauth2 required
56
56
  // oauth required
57
57
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["admin"], configuration);
@@ -88,7 +88,7 @@ export const LegacyTeamsApiAxiosParamCreator = function (configuration) {
88
88
  const localVarHeaderParameter = {};
89
89
  const localVarQueryParameter = {};
90
90
  // authentication api_key required
91
- yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
91
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
92
92
  // authentication oauth2 required
93
93
  // oauth required
94
94
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["admin"], configuration);
@@ -125,7 +125,7 @@ export const LegacyTeamsApiAxiosParamCreator = function (configuration) {
125
125
  const localVarHeaderParameter = {};
126
126
  const localVarQueryParameter = {};
127
127
  // authentication api_key required
128
- yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
128
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
129
129
  // authentication oauth2 required
130
130
  // oauth required
131
131
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["admin"], configuration);
@@ -162,7 +162,7 @@ export const LegacyTeamsApiAxiosParamCreator = function (configuration) {
162
162
  const localVarHeaderParameter = {};
163
163
  const localVarQueryParameter = {};
164
164
  // authentication api_key required
165
- yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
165
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
166
166
  // authentication oauth2 required
167
167
  // oauth required
168
168
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["users:read"], configuration);
@@ -199,7 +199,7 @@ export const LegacyTeamsApiAxiosParamCreator = function (configuration) {
199
199
  const localVarHeaderParameter = {};
200
200
  const localVarQueryParameter = {};
201
201
  // authentication api_key required
202
- yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
202
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
203
203
  // authentication oauth2 required
204
204
  // oauth required
205
205
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["users:read"], configuration);
@@ -231,7 +231,7 @@ export const LegacyTeamsApiAxiosParamCreator = function (configuration) {
231
231
  const localVarHeaderParameter = {};
232
232
  const localVarQueryParameter = {};
233
233
  // authentication api_key required
234
- yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
234
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
235
235
  // authentication oauth2 required
236
236
  // oauth required
237
237
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["users:read"], configuration);
@@ -273,7 +273,7 @@ export const LegacyTeamsApiAxiosParamCreator = function (configuration) {
273
273
  const localVarHeaderParameter = {};
274
274
  const localVarQueryParameter = {};
275
275
  // authentication api_key required
276
- yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
276
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
277
277
  // authentication oauth2 required
278
278
  // oauth required
279
279
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["users:read"], configuration);
@@ -314,7 +314,7 @@ export const LegacyTeamsApiAxiosParamCreator = function (configuration) {
314
314
  const localVarHeaderParameter = {};
315
315
  const localVarQueryParameter = {};
316
316
  // authentication api_key required
317
- yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
317
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
318
318
  // authentication oauth2 required
319
319
  // oauth required
320
320
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["admin"], configuration);
@@ -54,7 +54,7 @@ export const MailboxApiAxiosParamCreator = function (configuration) {
54
54
  const localVarHeaderParameter = {};
55
55
  const localVarQueryParameter = {};
56
56
  // authentication api_key required
57
- yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
57
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
58
58
  // authentication oauth2 required
59
59
  // oauth required
60
60
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["mail:full"], configuration);
@@ -89,7 +89,7 @@ export const MailboxApiAxiosParamCreator = function (configuration) {
89
89
  const localVarHeaderParameter = {};
90
90
  const localVarQueryParameter = {};
91
91
  // authentication api_key required
92
- yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
92
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
93
93
  // authentication oauth2 required
94
94
  // oauth required
95
95
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["mail:read", "mail:full"], configuration);
@@ -126,7 +126,7 @@ export const MailboxApiAxiosParamCreator = function (configuration) {
126
126
  const localVarHeaderParameter = {};
127
127
  const localVarQueryParameter = {};
128
128
  // authentication api_key required
129
- yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
129
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
130
130
  // authentication oauth2 required
131
131
  // oauth required
132
132
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["mail:read", "mail:full"], configuration);
@@ -160,7 +160,7 @@ export const MailboxApiAxiosParamCreator = function (configuration) {
160
160
  const localVarHeaderParameter = {};
161
161
  const localVarQueryParameter = {};
162
162
  // authentication api_key required
163
- yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
163
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
164
164
  // authentication oauth2 required
165
165
  // oauth required
166
166
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["mail:read", "mail:full"], configuration);
@@ -195,7 +195,7 @@ export const MailboxApiAxiosParamCreator = function (configuration) {
195
195
  const localVarHeaderParameter = {};
196
196
  const localVarQueryParameter = {};
197
197
  // authentication api_key required
198
- yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
198
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
199
199
  // authentication oauth2 required
200
200
  // oauth required
201
201
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["mail:read", "mail:full"], configuration);
@@ -244,7 +244,7 @@ export const MailboxApiAxiosParamCreator = function (configuration) {
244
244
  const localVarQueryParameter = {};
245
245
  const localVarFormParams = new URLSearchParams();
246
246
  // authentication api_key required
247
- yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
247
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
248
248
  // authentication oauth2 required
249
249
  // oauth required
250
250
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["mail:full"], configuration);
@@ -54,7 +54,7 @@ export const MeetingsApiAxiosParamCreator = function (configuration) {
54
54
  const localVarHeaderParameter = {};
55
55
  const localVarQueryParameter = {};
56
56
  // authentication api_key required
57
- yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
57
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
58
58
  // authentication oauth2 required
59
59
  // oauth required
60
60
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["video-calls"], configuration);
@@ -85,7 +85,7 @@ export const MeetingsApiAxiosParamCreator = function (configuration) {
85
85
  const localVarHeaderParameter = {};
86
86
  const localVarQueryParameter = {};
87
87
  // authentication api_key required
88
- yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
88
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
89
89
  // authentication oauth2 required
90
90
  // oauth required
91
91
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["video-calls"], configuration);
@@ -50,7 +50,7 @@ export const NoteFieldsApiAxiosParamCreator = function (configuration) {
50
50
  const localVarHeaderParameter = {};
51
51
  const localVarQueryParameter = {};
52
52
  // authentication api_key required
53
- yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
53
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
54
54
  // authentication oauth2 required
55
55
  // oauth required
56
56
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full", "contacts:read", "contacts:full"], configuration);
@@ -95,6 +95,7 @@ export declare const NotesApiAxiosParamCreator: (configuration?: Configuration)
95
95
  * @param {number} [deal_id] The ID of the deal which notes to fetch. If omitted, notes about all deals will be returned.
96
96
  * @param {number} [person_id] The ID of the person whose notes to fetch. If omitted, notes about all persons will be returned.
97
97
  * @param {number} [org_id] The ID of the organization which notes to fetch. If omitted, notes about all organizations will be returned.
98
+ * @param {number} [project_id] The ID of the project which notes to fetch. If omitted, notes about all projects will be returned.
98
99
  * @param {number} [start] Pagination start
99
100
  * @param {number} [limit] Items shown per page
100
101
  * @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). Supported fields: &#x60;id&#x60;, &#x60;user_id&#x60;, &#x60;deal_id&#x60;, &#x60;person_id&#x60;, &#x60;org_id&#x60;, &#x60;content&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
@@ -104,10 +105,11 @@ export declare const NotesApiAxiosParamCreator: (configuration?: Configuration)
104
105
  * @param {0 | 1} [pinned_to_deal_flag] If set, the results are filtered by note to deal pinning state
105
106
  * @param {0 | 1} [pinned_to_organization_flag] If set, the results are filtered by note to organization pinning state
106
107
  * @param {0 | 1} [pinned_to_person_flag] If set, the results are filtered by note to person pinning state
108
+ * @param {0 | 1} [pinned_to_project_flag] If set, the results are filtered by note to project pinning state
107
109
 
108
110
  * @throws {RequiredError}
109
111
  */
110
- getNotes: (user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_id?: number, start?: number, limit?: number, sort?: string, start_date?: string, end_date?: string, pinned_to_lead_flag?: 0 | 1, pinned_to_deal_flag?: 0 | 1, pinned_to_organization_flag?: 0 | 1, pinned_to_person_flag?: 0 | 1) => Promise<RequestArgs>;
112
+ getNotes: (user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_id?: number, project_id?: number, start?: number, limit?: number, sort?: string, start_date?: string, end_date?: string, pinned_to_lead_flag?: 0 | 1, pinned_to_deal_flag?: 0 | 1, pinned_to_organization_flag?: 0 | 1, pinned_to_person_flag?: 0 | 1, pinned_to_project_flag?: 0 | 1) => Promise<RequestArgs>;
111
113
  /**
112
114
  * Updates a comment related to a note.
113
115
  * @summary Update a comment related to a note
@@ -202,6 +204,7 @@ export declare const NotesApiFp: (configuration?: Configuration) => {
202
204
  * @param {number} [deal_id] The ID of the deal which notes to fetch. If omitted, notes about all deals will be returned.
203
205
  * @param {number} [person_id] The ID of the person whose notes to fetch. If omitted, notes about all persons will be returned.
204
206
  * @param {number} [org_id] The ID of the organization which notes to fetch. If omitted, notes about all organizations will be returned.
207
+ * @param {number} [project_id] The ID of the project which notes to fetch. If omitted, notes about all projects will be returned.
205
208
  * @param {number} [start] Pagination start
206
209
  * @param {number} [limit] Items shown per page
207
210
  * @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). Supported fields: &#x60;id&#x60;, &#x60;user_id&#x60;, &#x60;deal_id&#x60;, &#x60;person_id&#x60;, &#x60;org_id&#x60;, &#x60;content&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
@@ -211,10 +214,11 @@ export declare const NotesApiFp: (configuration?: Configuration) => {
211
214
  * @param {0 | 1} [pinned_to_deal_flag] If set, the results are filtered by note to deal pinning state
212
215
  * @param {0 | 1} [pinned_to_organization_flag] If set, the results are filtered by note to organization pinning state
213
216
  * @param {0 | 1} [pinned_to_person_flag] If set, the results are filtered by note to person pinning state
217
+ * @param {0 | 1} [pinned_to_project_flag] If set, the results are filtered by note to project pinning state
214
218
 
215
219
  * @throws {RequiredError}
216
220
  */
217
- getNotes(user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_id?: number, start?: number, limit?: number, sort?: string, start_date?: string, end_date?: string, pinned_to_lead_flag?: 0 | 1, pinned_to_deal_flag?: 0 | 1, pinned_to_organization_flag?: 0 | 1, pinned_to_person_flag?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetNotesResponse>>;
221
+ getNotes(user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_id?: number, project_id?: number, start?: number, limit?: number, sort?: string, start_date?: string, end_date?: string, pinned_to_lead_flag?: 0 | 1, pinned_to_deal_flag?: 0 | 1, pinned_to_organization_flag?: 0 | 1, pinned_to_person_flag?: 0 | 1, pinned_to_project_flag?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetNotesResponse>>;
218
222
  /**
219
223
  * Updates a comment related to a note.
220
224
  * @summary Update a comment related to a note
@@ -478,6 +482,12 @@ export interface NotesApiGetNotesRequest {
478
482
  * @memberof NotesApiGetNotes
479
483
  */
480
484
  readonly org_id?: number;
485
+ /**
486
+ * The ID of the project which notes to fetch. If omitted, notes about all projects will be returned.
487
+ * @type {number}
488
+ * @memberof NotesApiGetNotes
489
+ */
490
+ readonly project_id?: number;
481
491
  /**
482
492
  * Pagination start
483
493
  * @type {number}
@@ -532,6 +542,12 @@ export interface NotesApiGetNotesRequest {
532
542
  * @memberof NotesApiGetNotes
533
543
  */
534
544
  readonly pinned_to_person_flag?: 0 | 1;
545
+ /**
546
+ * If set, the results are filtered by note to project pinning state
547
+ * @type {0 | 1}
548
+ * @memberof NotesApiGetNotes
549
+ */
550
+ readonly pinned_to_project_flag?: 0 | 1;
535
551
  }
536
552
  /**
537
553
  * Request parameters for updateCommentForNote operation in NotesApi.