pipedrive 36.0.1 → 36.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/esm/versions/v1/api/activity-fields-api.d.ts +17 -1
- package/dist/esm/versions/v1/api/activity-fields-api.js +25 -0
- package/dist/esm/versions/v1/api/activity-types-api.d.ts +72 -1
- package/dist/esm/versions/v1/api/activity-types-api.js +107 -0
- package/dist/esm/versions/v1/api/billing-api.d.ts +17 -1
- package/dist/esm/versions/v1/api/billing-api.js +25 -0
- package/dist/esm/versions/v1/api/call-logs-api.d.ts +93 -1
- package/dist/esm/versions/v1/api/call-logs-api.js +137 -0
- package/dist/esm/versions/v1/api/channels-api.d.ts +74 -1
- package/dist/esm/versions/v1/api/channels-api.js +109 -0
- package/dist/esm/versions/v1/api/currencies-api.d.ts +19 -1
- package/dist/esm/versions/v1/api/currencies-api.js +27 -0
- package/dist/esm/versions/v1/api/deal-fields-api.d.ts +111 -1
- package/dist/esm/versions/v1/api/deal-fields-api.js +164 -0
- package/dist/esm/versions/v1/api/deals-api.d.ts +399 -1
- package/dist/esm/versions/v1/api/deals-api.js +569 -0
- package/dist/esm/versions/v1/api/files-api.d.ts +163 -1
- package/dist/esm/versions/v1/api/files-api.js +234 -0
- package/dist/esm/versions/v1/api/filters-api.d.ts +129 -1
- package/dist/esm/versions/v1/api/filters-api.js +191 -0
- package/dist/esm/versions/v1/api/goals-api.d.ts +106 -1
- package/dist/esm/versions/v1/api/goals-api.js +150 -0
- package/dist/esm/versions/v1/api/lead-fields-api.d.ts +20 -1
- package/dist/esm/versions/v1/api/lead-fields-api.js +28 -0
- package/dist/esm/versions/v1/api/lead-labels-api.d.ts +72 -1
- package/dist/esm/versions/v1/api/lead-labels-api.js +107 -0
- package/dist/esm/versions/v1/api/lead-sources-api.d.ts +17 -1
- package/dist/esm/versions/v1/api/lead-sources-api.js +25 -0
- package/dist/esm/versions/v1/api/leads-api.d.ts +166 -1
- package/dist/esm/versions/v1/api/leads-api.js +237 -0
- package/dist/esm/versions/v1/api/legacy-teams-api.d.ts +152 -1
- package/dist/esm/versions/v1/api/legacy-teams-api.js +223 -0
- package/dist/esm/versions/v1/api/mailbox-api.d.ts +117 -1
- package/dist/esm/versions/v1/api/mailbox-api.js +170 -0
- package/dist/esm/versions/v1/api/meetings-api.d.ts +37 -1
- package/dist/esm/versions/v1/api/meetings-api.js +54 -0
- package/dist/esm/versions/v1/api/note-fields-api.d.ts +17 -1
- package/dist/esm/versions/v1/api/note-fields-api.js +25 -0
- package/dist/esm/versions/v1/api/notes-api.d.ts +207 -1
- package/dist/esm/versions/v1/api/notes-api.js +296 -0
- package/dist/esm/versions/v1/api/organization-fields-api.d.ts +111 -1
- package/dist/esm/versions/v1/api/organization-fields-api.js +164 -0
- package/dist/esm/versions/v1/api/organization-relationships-api.d.ts +93 -1
- package/dist/esm/versions/v1/api/organization-relationships-api.js +137 -0
- package/dist/esm/versions/v1/api/organizations-api.d.ts +178 -1
- package/dist/esm/versions/v1/api/organizations-api.js +258 -0
- package/dist/esm/versions/v1/api/permission-sets-api.d.ts +57 -1
- package/dist/esm/versions/v1/api/permission-sets-api.js +83 -0
- package/dist/esm/versions/v1/api/person-fields-api.d.ts +111 -1
- package/dist/esm/versions/v1/api/person-fields-api.js +164 -0
- package/dist/esm/versions/v1/api/persons-api.d.ts +275 -37
- package/dist/esm/versions/v1/api/persons-api.js +370 -24
- package/dist/esm/versions/v1/api/pipelines-api.d.ts +69 -1
- package/dist/esm/versions/v1/api/pipelines-api.js +95 -0
- package/dist/esm/versions/v1/api/product-fields-api.d.ts +111 -1
- package/dist/esm/versions/v1/api/product-fields-api.js +164 -0
- package/dist/esm/versions/v1/api/products-api.d.ts +119 -1
- package/dist/esm/versions/v1/api/products-api.js +172 -0
- package/dist/esm/versions/v1/api/project-boards-api.d.ts +35 -1
- package/dist/esm/versions/v1/api/project-boards-api.js +52 -0
- package/dist/esm/versions/v1/api/project-phases-api.d.ts +37 -1
- package/dist/esm/versions/v1/api/project-phases-api.js +54 -0
- package/dist/esm/versions/v1/api/project-templates-api.d.ts +38 -1
- package/dist/esm/versions/v1/api/project-templates-api.js +55 -0
- package/dist/esm/versions/v1/api/projects-api.d.ts +227 -1
- package/dist/esm/versions/v1/api/projects-api.js +334 -0
- package/dist/esm/versions/v1/api/recents-api.d.ts +22 -1
- package/dist/esm/versions/v1/api/recents-api.js +30 -0
- package/dist/esm/versions/v1/api/roles-api.d.ts +226 -1
- package/dist/esm/versions/v1/api/roles-api.js +333 -0
- package/dist/esm/versions/v1/api/stages-api.d.ts +24 -1
- package/dist/esm/versions/v1/api/stages-api.js +32 -0
- package/dist/esm/versions/v1/api/tasks-api.d.ts +97 -1
- package/dist/esm/versions/v1/api/tasks-api.js +141 -0
- package/dist/esm/versions/v1/api/user-connections-api.d.ts +17 -1
- package/dist/esm/versions/v1/api/user-connections-api.js +25 -0
- package/dist/esm/versions/v1/api/user-settings-api.d.ts +17 -1
- package/dist/esm/versions/v1/api/user-settings-api.js +25 -0
- package/dist/esm/versions/v1/api/users-api.d.ts +181 -1
- package/dist/esm/versions/v1/api/users-api.js +270 -0
- package/dist/esm/versions/v1/api/webhooks-api.d.ts +53 -1
- package/dist/esm/versions/v1/api/webhooks-api.js +79 -0
- package/dist/esm/versions/v1/base.d.ts +17 -0
- package/dist/esm/versions/v1/base.js +22 -0
- package/dist/esm/versions/v1/common.d.ts +1 -1
- package/dist/esm/versions/v1/common.js +7 -4
- package/dist/esm/versions/v2/api/activities-api.d.ts +107 -1
- package/dist/esm/versions/v2/api/activities-api.js +151 -0
- package/dist/esm/versions/v2/api/activity-fields-api.d.ts +40 -1
- package/dist/esm/versions/v2/api/activity-fields-api.js +57 -0
- package/dist/esm/versions/v2/api/beta-api.d.ts +451 -1
- package/dist/esm/versions/v2/api/beta-api.js +666 -0
- package/dist/esm/versions/v2/api/deal-fields-api.d.ts +152 -1
- package/dist/esm/versions/v2/api/deal-fields-api.js +223 -0
- package/dist/esm/versions/v2/api/deal-installments-api.d.ts +81 -1
- package/dist/esm/versions/v2/api/deal-installments-api.js +116 -0
- package/dist/esm/versions/v2/api/deal-products-api.d.ts +141 -1
- package/dist/esm/versions/v2/api/deal-products-api.js +203 -0
- package/dist/esm/versions/v2/api/deals-api.d.ts +363 -1
- package/dist/esm/versions/v2/api/deals-api.js +516 -1
- package/dist/esm/versions/v2/api/item-search-api.d.ts +49 -1
- package/dist/esm/versions/v2/api/item-search-api.js +66 -0
- package/dist/esm/versions/v2/api/leads-api.d.ts +64 -1
- package/dist/esm/versions/v2/api/leads-api.js +90 -0
- package/dist/esm/versions/v2/api/organization-fields-api.d.ts +152 -1
- package/dist/esm/versions/v2/api/organization-fields-api.js +223 -0
- package/dist/esm/versions/v2/api/organizations-api.d.ts +208 -1
- package/dist/esm/versions/v2/api/organizations-api.js +297 -0
- package/dist/esm/versions/v2/api/person-fields-api.d.ts +152 -1
- package/dist/esm/versions/v2/api/person-fields-api.js +223 -0
- package/dist/esm/versions/v2/api/persons-api.d.ts +230 -1
- package/dist/esm/versions/v2/api/persons-api.js +328 -0
- package/dist/esm/versions/v2/api/pipelines-api.d.ts +95 -1
- package/dist/esm/versions/v2/api/pipelines-api.js +139 -0
- package/dist/esm/versions/v2/api/product-fields-api.d.ts +152 -1
- package/dist/esm/versions/v2/api/product-fields-api.js +223 -0
- package/dist/esm/versions/v2/api/products-api.d.ts +371 -1
- package/dist/esm/versions/v2/api/products-api.js +541 -0
- package/dist/esm/versions/v2/api/project-boards-api.d.ts +90 -1
- package/dist/esm/versions/v2/api/project-boards-api.js +134 -0
- package/dist/esm/versions/v2/api/project-fields-api.d.ts +150 -1
- package/dist/esm/versions/v2/api/project-fields-api.js +221 -0
- package/dist/esm/versions/v2/api/project-phases-api.d.ts +92 -1
- package/dist/esm/versions/v2/api/project-phases-api.js +136 -0
- package/dist/esm/versions/v2/api/project-templates-api.d.ts +38 -1
- package/dist/esm/versions/v2/api/project-templates-api.js +55 -0
- package/dist/esm/versions/v2/api/projects-api.d.ts +201 -1
- package/dist/esm/versions/v2/api/projects-api.js +290 -0
- package/dist/esm/versions/v2/api/stages-api.d.ts +96 -1
- package/dist/esm/versions/v2/api/stages-api.js +140 -0
- package/dist/esm/versions/v2/api/tasks-api.d.ts +98 -1
- package/dist/esm/versions/v2/api/tasks-api.js +142 -0
- package/dist/esm/versions/v2/api/users-api.d.ts +21 -1
- package/dist/esm/versions/v2/api/users-api.js +29 -0
- package/dist/esm/versions/v2/base.d.ts +17 -0
- package/dist/esm/versions/v2/base.js +22 -0
- package/dist/esm/versions/v2/common.d.ts +1 -1
- package/dist/esm/versions/v2/common.js +7 -4
- package/dist/versions/v1/api/activity-fields-api.d.ts +17 -1
- package/dist/versions/v1/api/activity-fields-api.js +25 -0
- package/dist/versions/v1/api/activity-types-api.d.ts +72 -1
- package/dist/versions/v1/api/activity-types-api.js +107 -0
- package/dist/versions/v1/api/billing-api.d.ts +17 -1
- package/dist/versions/v1/api/billing-api.js +25 -0
- package/dist/versions/v1/api/call-logs-api.d.ts +93 -1
- package/dist/versions/v1/api/call-logs-api.js +137 -0
- package/dist/versions/v1/api/channels-api.d.ts +74 -1
- package/dist/versions/v1/api/channels-api.js +109 -0
- package/dist/versions/v1/api/currencies-api.d.ts +19 -1
- package/dist/versions/v1/api/currencies-api.js +27 -0
- package/dist/versions/v1/api/deal-fields-api.d.ts +111 -1
- package/dist/versions/v1/api/deal-fields-api.js +164 -0
- package/dist/versions/v1/api/deals-api.d.ts +399 -1
- package/dist/versions/v1/api/deals-api.js +569 -0
- package/dist/versions/v1/api/files-api.d.ts +163 -1
- package/dist/versions/v1/api/files-api.js +234 -0
- package/dist/versions/v1/api/filters-api.d.ts +129 -1
- package/dist/versions/v1/api/filters-api.js +191 -0
- package/dist/versions/v1/api/goals-api.d.ts +106 -1
- package/dist/versions/v1/api/goals-api.js +150 -0
- package/dist/versions/v1/api/lead-fields-api.d.ts +20 -1
- package/dist/versions/v1/api/lead-fields-api.js +28 -0
- package/dist/versions/v1/api/lead-labels-api.d.ts +72 -1
- package/dist/versions/v1/api/lead-labels-api.js +107 -0
- package/dist/versions/v1/api/lead-sources-api.d.ts +17 -1
- package/dist/versions/v1/api/lead-sources-api.js +25 -0
- package/dist/versions/v1/api/leads-api.d.ts +166 -1
- package/dist/versions/v1/api/leads-api.js +237 -0
- package/dist/versions/v1/api/legacy-teams-api.d.ts +152 -1
- package/dist/versions/v1/api/legacy-teams-api.js +223 -0
- package/dist/versions/v1/api/mailbox-api.d.ts +117 -1
- package/dist/versions/v1/api/mailbox-api.js +170 -0
- package/dist/versions/v1/api/meetings-api.d.ts +37 -1
- package/dist/versions/v1/api/meetings-api.js +54 -0
- package/dist/versions/v1/api/note-fields-api.d.ts +17 -1
- package/dist/versions/v1/api/note-fields-api.js +25 -0
- package/dist/versions/v1/api/notes-api.d.ts +207 -1
- package/dist/versions/v1/api/notes-api.js +296 -0
- package/dist/versions/v1/api/organization-fields-api.d.ts +111 -1
- package/dist/versions/v1/api/organization-fields-api.js +164 -0
- package/dist/versions/v1/api/organization-relationships-api.d.ts +93 -1
- package/dist/versions/v1/api/organization-relationships-api.js +137 -0
- package/dist/versions/v1/api/organizations-api.d.ts +178 -1
- package/dist/versions/v1/api/organizations-api.js +258 -0
- package/dist/versions/v1/api/permission-sets-api.d.ts +57 -1
- package/dist/versions/v1/api/permission-sets-api.js +83 -0
- package/dist/versions/v1/api/person-fields-api.d.ts +111 -1
- package/dist/versions/v1/api/person-fields-api.js +164 -0
- package/dist/versions/v1/api/persons-api.d.ts +275 -37
- package/dist/versions/v1/api/persons-api.js +370 -24
- package/dist/versions/v1/api/pipelines-api.d.ts +69 -1
- package/dist/versions/v1/api/pipelines-api.js +95 -0
- package/dist/versions/v1/api/product-fields-api.d.ts +111 -1
- package/dist/versions/v1/api/product-fields-api.js +164 -0
- package/dist/versions/v1/api/products-api.d.ts +119 -1
- package/dist/versions/v1/api/products-api.js +172 -0
- package/dist/versions/v1/api/project-boards-api.d.ts +35 -1
- package/dist/versions/v1/api/project-boards-api.js +52 -0
- package/dist/versions/v1/api/project-phases-api.d.ts +37 -1
- package/dist/versions/v1/api/project-phases-api.js +54 -0
- package/dist/versions/v1/api/project-templates-api.d.ts +38 -1
- package/dist/versions/v1/api/project-templates-api.js +55 -0
- package/dist/versions/v1/api/projects-api.d.ts +227 -1
- package/dist/versions/v1/api/projects-api.js +334 -0
- package/dist/versions/v1/api/recents-api.d.ts +22 -1
- package/dist/versions/v1/api/recents-api.js +30 -0
- package/dist/versions/v1/api/roles-api.d.ts +226 -1
- package/dist/versions/v1/api/roles-api.js +333 -0
- package/dist/versions/v1/api/stages-api.d.ts +24 -1
- package/dist/versions/v1/api/stages-api.js +32 -0
- package/dist/versions/v1/api/tasks-api.d.ts +97 -1
- package/dist/versions/v1/api/tasks-api.js +141 -0
- package/dist/versions/v1/api/user-connections-api.d.ts +17 -1
- package/dist/versions/v1/api/user-connections-api.js +25 -0
- package/dist/versions/v1/api/user-settings-api.d.ts +17 -1
- package/dist/versions/v1/api/user-settings-api.js +25 -0
- package/dist/versions/v1/api/users-api.d.ts +181 -1
- package/dist/versions/v1/api/users-api.js +270 -0
- package/dist/versions/v1/api/webhooks-api.d.ts +53 -1
- package/dist/versions/v1/api/webhooks-api.js +79 -0
- package/dist/versions/v1/base.d.ts +17 -0
- package/dist/versions/v1/base.js +24 -1
- package/dist/versions/v1/common.d.ts +1 -1
- package/dist/versions/v1/common.js +6 -3
- package/dist/versions/v2/api/activities-api.d.ts +107 -1
- package/dist/versions/v2/api/activities-api.js +151 -0
- package/dist/versions/v2/api/activity-fields-api.d.ts +40 -1
- package/dist/versions/v2/api/activity-fields-api.js +57 -0
- package/dist/versions/v2/api/beta-api.d.ts +451 -1
- package/dist/versions/v2/api/beta-api.js +666 -0
- package/dist/versions/v2/api/deal-fields-api.d.ts +152 -1
- package/dist/versions/v2/api/deal-fields-api.js +223 -0
- package/dist/versions/v2/api/deal-installments-api.d.ts +81 -1
- package/dist/versions/v2/api/deal-installments-api.js +116 -0
- package/dist/versions/v2/api/deal-products-api.d.ts +141 -1
- package/dist/versions/v2/api/deal-products-api.js +203 -0
- package/dist/versions/v2/api/deals-api.d.ts +363 -1
- package/dist/versions/v2/api/deals-api.js +516 -1
- package/dist/versions/v2/api/item-search-api.d.ts +49 -1
- package/dist/versions/v2/api/item-search-api.js +66 -0
- package/dist/versions/v2/api/leads-api.d.ts +64 -1
- package/dist/versions/v2/api/leads-api.js +90 -0
- package/dist/versions/v2/api/organization-fields-api.d.ts +152 -1
- package/dist/versions/v2/api/organization-fields-api.js +223 -0
- package/dist/versions/v2/api/organizations-api.d.ts +208 -1
- package/dist/versions/v2/api/organizations-api.js +297 -0
- package/dist/versions/v2/api/person-fields-api.d.ts +152 -1
- package/dist/versions/v2/api/person-fields-api.js +223 -0
- package/dist/versions/v2/api/persons-api.d.ts +230 -1
- package/dist/versions/v2/api/persons-api.js +328 -0
- package/dist/versions/v2/api/pipelines-api.d.ts +95 -1
- package/dist/versions/v2/api/pipelines-api.js +139 -0
- package/dist/versions/v2/api/product-fields-api.d.ts +152 -1
- package/dist/versions/v2/api/product-fields-api.js +223 -0
- package/dist/versions/v2/api/products-api.d.ts +371 -1
- package/dist/versions/v2/api/products-api.js +541 -0
- package/dist/versions/v2/api/project-boards-api.d.ts +90 -1
- package/dist/versions/v2/api/project-boards-api.js +134 -0
- package/dist/versions/v2/api/project-fields-api.d.ts +150 -1
- package/dist/versions/v2/api/project-fields-api.js +221 -0
- package/dist/versions/v2/api/project-phases-api.d.ts +92 -1
- package/dist/versions/v2/api/project-phases-api.js +136 -0
- package/dist/versions/v2/api/project-templates-api.d.ts +38 -1
- package/dist/versions/v2/api/project-templates-api.js +55 -0
- package/dist/versions/v2/api/projects-api.d.ts +201 -1
- package/dist/versions/v2/api/projects-api.js +290 -0
- package/dist/versions/v2/api/stages-api.d.ts +96 -1
- package/dist/versions/v2/api/stages-api.js +140 -0
- package/dist/versions/v2/api/tasks-api.d.ts +98 -1
- package/dist/versions/v2/api/tasks-api.js +142 -0
- package/dist/versions/v2/api/users-api.d.ts +21 -1
- package/dist/versions/v2/api/users-api.js +29 -0
- package/dist/versions/v2/base.d.ts +17 -0
- package/dist/versions/v2/base.js +24 -1
- package/dist/versions/v2/common.d.ts +1 -1
- package/dist/versions/v2/common.js +6 -3
- package/package.json +1 -1
|
@@ -410,6 +410,19 @@ export const LeadsApiFp = function (configuration) {
|
|
|
410
410
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
411
411
|
});
|
|
412
412
|
},
|
|
413
|
+
/**
|
|
414
|
+
* Same as `addLead`, but resolves with the response body together with the HTTP status and headers.
|
|
415
|
+
* @summary Add a lead
|
|
416
|
+
* @param {AddLeadRequest} [AddLeadRequest]
|
|
417
|
+
|
|
418
|
+
* @throws {RequiredError}
|
|
419
|
+
*/
|
|
420
|
+
addLeadWithHttpInfo(AddLeadRequest) {
|
|
421
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
422
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.addLead(AddLeadRequest);
|
|
423
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
424
|
+
});
|
|
425
|
+
},
|
|
413
426
|
/**
|
|
414
427
|
* Deletes a specific lead.
|
|
415
428
|
* @summary Delete a lead
|
|
@@ -423,6 +436,19 @@ export const LeadsApiFp = function (configuration) {
|
|
|
423
436
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
424
437
|
});
|
|
425
438
|
},
|
|
439
|
+
/**
|
|
440
|
+
* Same as `deleteLead`, but resolves with the response body together with the HTTP status and headers.
|
|
441
|
+
* @summary Delete a lead
|
|
442
|
+
* @param {string} id The ID of the lead
|
|
443
|
+
|
|
444
|
+
* @throws {RequiredError}
|
|
445
|
+
*/
|
|
446
|
+
deleteLeadWithHttpInfo(id) {
|
|
447
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
448
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteLead(id);
|
|
449
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
450
|
+
});
|
|
451
|
+
},
|
|
426
452
|
/**
|
|
427
453
|
* 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.
|
|
428
454
|
* @summary Get all archived leads
|
|
@@ -442,6 +468,25 @@ export const LeadsApiFp = function (configuration) {
|
|
|
442
468
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
443
469
|
});
|
|
444
470
|
},
|
|
471
|
+
/**
|
|
472
|
+
* Same as `getArchivedLeads`, but resolves with the response body together with the HTTP status and headers.
|
|
473
|
+
* @summary Get all archived leads
|
|
474
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
|
|
475
|
+
* @param {number} [start] For pagination, the position that represents the first result for the page
|
|
476
|
+
* @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.
|
|
477
|
+
* @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.
|
|
478
|
+
* @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.
|
|
479
|
+
* @param {number} [filter_id] The ID of the filter to use
|
|
480
|
+
* @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).
|
|
481
|
+
|
|
482
|
+
* @throws {RequiredError}
|
|
483
|
+
*/
|
|
484
|
+
getArchivedLeadsWithHttpInfo(limit, start, owner_id, person_id, organization_id, filter_id, sort) {
|
|
485
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
486
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getArchivedLeads(limit, start, owner_id, person_id, organization_id, filter_id, sort);
|
|
487
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
488
|
+
});
|
|
489
|
+
},
|
|
445
490
|
/**
|
|
446
491
|
* 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.
|
|
447
492
|
* @summary Get one lead
|
|
@@ -455,6 +500,19 @@ export const LeadsApiFp = function (configuration) {
|
|
|
455
500
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
456
501
|
});
|
|
457
502
|
},
|
|
503
|
+
/**
|
|
504
|
+
* Same as `getLead`, but resolves with the response body together with the HTTP status and headers.
|
|
505
|
+
* @summary Get one lead
|
|
506
|
+
* @param {string} id The ID of the lead
|
|
507
|
+
|
|
508
|
+
* @throws {RequiredError}
|
|
509
|
+
*/
|
|
510
|
+
getLeadWithHttpInfo(id) {
|
|
511
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
512
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getLead(id);
|
|
513
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
514
|
+
});
|
|
515
|
+
},
|
|
458
516
|
/**
|
|
459
517
|
* Lists the users permitted to access a lead.
|
|
460
518
|
* @summary List permitted users
|
|
@@ -468,6 +526,19 @@ export const LeadsApiFp = function (configuration) {
|
|
|
468
526
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
469
527
|
});
|
|
470
528
|
},
|
|
529
|
+
/**
|
|
530
|
+
* Same as `getLeadUsers`, but resolves with the response body together with the HTTP status and headers.
|
|
531
|
+
* @summary List permitted users
|
|
532
|
+
* @param {string} id The ID of the lead
|
|
533
|
+
|
|
534
|
+
* @throws {RequiredError}
|
|
535
|
+
*/
|
|
536
|
+
getLeadUsersWithHttpInfo(id) {
|
|
537
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
538
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getLeadUsers(id);
|
|
539
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
540
|
+
});
|
|
541
|
+
},
|
|
471
542
|
/**
|
|
472
543
|
* 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.
|
|
473
544
|
* @summary Get all leads
|
|
@@ -488,6 +559,26 @@ export const LeadsApiFp = function (configuration) {
|
|
|
488
559
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
489
560
|
});
|
|
490
561
|
},
|
|
562
|
+
/**
|
|
563
|
+
* Same as `getLeads`, but resolves with the response body together with the HTTP status and headers.
|
|
564
|
+
* @summary Get all leads
|
|
565
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
|
|
566
|
+
* @param {number} [start] For pagination, the position that represents the first result for the page
|
|
567
|
+
* @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.
|
|
568
|
+
* @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.
|
|
569
|
+
* @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.
|
|
570
|
+
* @param {number} [filter_id] The ID of the filter to use
|
|
571
|
+
* @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
572
|
+
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id, title, owner_id, creator_id, label_ids, value, source_name, was_seen, expected_close_date, next_activity_id, add_time, update_time, visible_to, and custom fields.
|
|
573
|
+
|
|
574
|
+
* @throws {RequiredError}
|
|
575
|
+
*/
|
|
576
|
+
getLeadsWithHttpInfo(limit, start, owner_id, person_id, organization_id, filter_id, updated_since, sort) {
|
|
577
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
578
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getLeads(limit, start, owner_id, person_id, organization_id, filter_id, updated_since, sort);
|
|
579
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
580
|
+
});
|
|
581
|
+
},
|
|
491
582
|
/**
|
|
492
583
|
* 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.
|
|
493
584
|
* @summary Search leads
|
|
@@ -508,6 +599,26 @@ export const LeadsApiFp = function (configuration) {
|
|
|
508
599
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
509
600
|
});
|
|
510
601
|
},
|
|
602
|
+
/**
|
|
603
|
+
* Same as `searchLeads`, but resolves with the response body together with the HTTP status and headers.
|
|
604
|
+
* @summary Search leads
|
|
605
|
+
* @param {string} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
|
|
606
|
+
* @param {Set<'custom_fields' | 'notes' | 'title'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
607
|
+
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
608
|
+
* @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
|
|
609
|
+
* @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
|
|
610
|
+
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
611
|
+
* @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
|
|
612
|
+
* @param {number} [limit] Items shown per page
|
|
613
|
+
|
|
614
|
+
* @throws {RequiredError}
|
|
615
|
+
*/
|
|
616
|
+
searchLeadsWithHttpInfo(term, fields, exact_match, person_id, organization_id, include_fields, start, limit) {
|
|
617
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
618
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.searchLeads(term, fields, exact_match, person_id, organization_id, include_fields, start, limit);
|
|
619
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
620
|
+
});
|
|
621
|
+
},
|
|
511
622
|
/**
|
|
512
623
|
* Updates one or more properties of a lead. Only properties included in the request will be updated. Send `null` to unset a property (applicable for example for `value`, `person_id` or `organization_id`). 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. See an example given in the <a href=\"https://pipedrive.readme.io/docs/updating-custom-field-value\" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields’ values tutorial</a>.
|
|
513
624
|
* @summary Update a lead
|
|
@@ -522,6 +633,20 @@ export const LeadsApiFp = function (configuration) {
|
|
|
522
633
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
523
634
|
});
|
|
524
635
|
},
|
|
636
|
+
/**
|
|
637
|
+
* Same as `updateLead`, but resolves with the response body together with the HTTP status and headers.
|
|
638
|
+
* @summary Update a lead
|
|
639
|
+
* @param {string} id The ID of the lead
|
|
640
|
+
* @param {UpdateLeadRequest} [UpdateLeadRequest]
|
|
641
|
+
|
|
642
|
+
* @throws {RequiredError}
|
|
643
|
+
*/
|
|
644
|
+
updateLeadWithHttpInfo(id, UpdateLeadRequest) {
|
|
645
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
646
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateLead(id, UpdateLeadRequest);
|
|
647
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
648
|
+
});
|
|
649
|
+
},
|
|
525
650
|
};
|
|
526
651
|
};
|
|
527
652
|
/**
|
|
@@ -541,6 +666,9 @@ export const LeadsApiFactory = function (configuration, basePath, axios) {
|
|
|
541
666
|
addLead(requestParameters = {}) {
|
|
542
667
|
return localVarFp.addLead(requestParameters.AddLeadRequest).then((request) => request(axios, basePath));
|
|
543
668
|
},
|
|
669
|
+
addLeadWithHttpInfo(requestParameters = {}) {
|
|
670
|
+
return localVarFp.addLeadWithHttpInfo(requestParameters.AddLeadRequest).then((request) => request(axios, basePath));
|
|
671
|
+
},
|
|
544
672
|
/**
|
|
545
673
|
* Deletes a specific lead.
|
|
546
674
|
* @summary Delete a lead
|
|
@@ -551,6 +679,9 @@ export const LeadsApiFactory = function (configuration, basePath, axios) {
|
|
|
551
679
|
deleteLead(requestParameters) {
|
|
552
680
|
return localVarFp.deleteLead(requestParameters.id).then((request) => request(axios, basePath));
|
|
553
681
|
},
|
|
682
|
+
deleteLeadWithHttpInfo(requestParameters) {
|
|
683
|
+
return localVarFp.deleteLeadWithHttpInfo(requestParameters.id).then((request) => request(axios, basePath));
|
|
684
|
+
},
|
|
554
685
|
/**
|
|
555
686
|
* 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.
|
|
556
687
|
* @summary Get all archived leads
|
|
@@ -561,6 +692,9 @@ export const LeadsApiFactory = function (configuration, basePath, axios) {
|
|
|
561
692
|
getArchivedLeads(requestParameters = {}) {
|
|
562
693
|
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));
|
|
563
694
|
},
|
|
695
|
+
getArchivedLeadsWithHttpInfo(requestParameters = {}) {
|
|
696
|
+
return localVarFp.getArchivedLeadsWithHttpInfo(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(axios, basePath));
|
|
697
|
+
},
|
|
564
698
|
/**
|
|
565
699
|
* 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.
|
|
566
700
|
* @summary Get one lead
|
|
@@ -571,6 +705,9 @@ export const LeadsApiFactory = function (configuration, basePath, axios) {
|
|
|
571
705
|
getLead(requestParameters) {
|
|
572
706
|
return localVarFp.getLead(requestParameters.id).then((request) => request(axios, basePath));
|
|
573
707
|
},
|
|
708
|
+
getLeadWithHttpInfo(requestParameters) {
|
|
709
|
+
return localVarFp.getLeadWithHttpInfo(requestParameters.id).then((request) => request(axios, basePath));
|
|
710
|
+
},
|
|
574
711
|
/**
|
|
575
712
|
* Lists the users permitted to access a lead.
|
|
576
713
|
* @summary List permitted users
|
|
@@ -581,6 +718,9 @@ export const LeadsApiFactory = function (configuration, basePath, axios) {
|
|
|
581
718
|
getLeadUsers(requestParameters) {
|
|
582
719
|
return localVarFp.getLeadUsers(requestParameters.id).then((request) => request(axios, basePath));
|
|
583
720
|
},
|
|
721
|
+
getLeadUsersWithHttpInfo(requestParameters) {
|
|
722
|
+
return localVarFp.getLeadUsersWithHttpInfo(requestParameters.id).then((request) => request(axios, basePath));
|
|
723
|
+
},
|
|
584
724
|
/**
|
|
585
725
|
* 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.
|
|
586
726
|
* @summary Get all leads
|
|
@@ -591,6 +731,9 @@ export const LeadsApiFactory = function (configuration, basePath, axios) {
|
|
|
591
731
|
getLeads(requestParameters = {}) {
|
|
592
732
|
return localVarFp.getLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.updated_since, requestParameters.sort).then((request) => request(axios, basePath));
|
|
593
733
|
},
|
|
734
|
+
getLeadsWithHttpInfo(requestParameters = {}) {
|
|
735
|
+
return localVarFp.getLeadsWithHttpInfo(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.updated_since, requestParameters.sort).then((request) => request(axios, basePath));
|
|
736
|
+
},
|
|
594
737
|
/**
|
|
595
738
|
* 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.
|
|
596
739
|
* @summary Search leads
|
|
@@ -601,6 +744,9 @@ export const LeadsApiFactory = function (configuration, basePath, axios) {
|
|
|
601
744
|
searchLeads(requestParameters) {
|
|
602
745
|
return localVarFp.searchLeads(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.person_id, requestParameters.organization_id, requestParameters.include_fields, requestParameters.start, requestParameters.limit).then((request) => request(axios, basePath));
|
|
603
746
|
},
|
|
747
|
+
searchLeadsWithHttpInfo(requestParameters) {
|
|
748
|
+
return localVarFp.searchLeadsWithHttpInfo(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.person_id, requestParameters.organization_id, requestParameters.include_fields, requestParameters.start, requestParameters.limit).then((request) => request(axios, basePath));
|
|
749
|
+
},
|
|
604
750
|
/**
|
|
605
751
|
* Updates one or more properties of a lead. Only properties included in the request will be updated. Send `null` to unset a property (applicable for example for `value`, `person_id` or `organization_id`). 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. See an example given in the <a href=\"https://pipedrive.readme.io/docs/updating-custom-field-value\" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields’ values tutorial</a>.
|
|
606
752
|
* @summary Update a lead
|
|
@@ -611,6 +757,9 @@ export const LeadsApiFactory = function (configuration, basePath, axios) {
|
|
|
611
757
|
updateLead(requestParameters) {
|
|
612
758
|
return localVarFp.updateLead(requestParameters.id, requestParameters.UpdateLeadRequest).then((request) => request(axios, basePath));
|
|
613
759
|
},
|
|
760
|
+
updateLeadWithHttpInfo(requestParameters) {
|
|
761
|
+
return localVarFp.updateLeadWithHttpInfo(requestParameters.id, requestParameters.UpdateLeadRequest).then((request) => request(axios, basePath));
|
|
762
|
+
},
|
|
614
763
|
};
|
|
615
764
|
};
|
|
616
765
|
/**
|
|
@@ -631,6 +780,17 @@ export class LeadsApi extends BaseAPI {
|
|
|
631
780
|
addLead(requestParameters = {}) {
|
|
632
781
|
return LeadsApiFp(this.configuration).addLead(requestParameters.AddLeadRequest).then((request) => request(this.axios, this.basePath));
|
|
633
782
|
}
|
|
783
|
+
/**
|
|
784
|
+
* Same as `addLead`, but resolves with the response body together with the HTTP status and headers.
|
|
785
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
786
|
+
* @param {LeadsApiAddLeadRequest} requestParameters Request parameters.
|
|
787
|
+
|
|
788
|
+
* @throws {RequiredError}
|
|
789
|
+
* @memberof LeadsApi
|
|
790
|
+
*/
|
|
791
|
+
addLeadWithHttpInfo(requestParameters = {}) {
|
|
792
|
+
return LeadsApiFp(this.configuration).addLeadWithHttpInfo(requestParameters.AddLeadRequest).then((request) => request(this.axios, this.basePath));
|
|
793
|
+
}
|
|
634
794
|
/**
|
|
635
795
|
* Deletes a specific lead.
|
|
636
796
|
* @summary Delete a lead
|
|
@@ -642,6 +802,17 @@ export class LeadsApi extends BaseAPI {
|
|
|
642
802
|
deleteLead(requestParameters) {
|
|
643
803
|
return LeadsApiFp(this.configuration).deleteLead(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
644
804
|
}
|
|
805
|
+
/**
|
|
806
|
+
* Same as `deleteLead`, but resolves with the response body together with the HTTP status and headers.
|
|
807
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
808
|
+
* @param {LeadsApiDeleteLeadRequest} requestParameters Request parameters.
|
|
809
|
+
|
|
810
|
+
* @throws {RequiredError}
|
|
811
|
+
* @memberof LeadsApi
|
|
812
|
+
*/
|
|
813
|
+
deleteLeadWithHttpInfo(requestParameters) {
|
|
814
|
+
return LeadsApiFp(this.configuration).deleteLeadWithHttpInfo(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
815
|
+
}
|
|
645
816
|
/**
|
|
646
817
|
* 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.
|
|
647
818
|
* @summary Get all archived leads
|
|
@@ -653,6 +824,17 @@ export class LeadsApi extends BaseAPI {
|
|
|
653
824
|
getArchivedLeads(requestParameters = {}) {
|
|
654
825
|
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));
|
|
655
826
|
}
|
|
827
|
+
/**
|
|
828
|
+
* Same as `getArchivedLeads`, but resolves with the response body together with the HTTP status and headers.
|
|
829
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
830
|
+
* @param {LeadsApiGetArchivedLeadsRequest} requestParameters Request parameters.
|
|
831
|
+
|
|
832
|
+
* @throws {RequiredError}
|
|
833
|
+
* @memberof LeadsApi
|
|
834
|
+
*/
|
|
835
|
+
getArchivedLeadsWithHttpInfo(requestParameters = {}) {
|
|
836
|
+
return LeadsApiFp(this.configuration).getArchivedLeadsWithHttpInfo(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));
|
|
837
|
+
}
|
|
656
838
|
/**
|
|
657
839
|
* 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.
|
|
658
840
|
* @summary Get one lead
|
|
@@ -664,6 +846,17 @@ export class LeadsApi extends BaseAPI {
|
|
|
664
846
|
getLead(requestParameters) {
|
|
665
847
|
return LeadsApiFp(this.configuration).getLead(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
666
848
|
}
|
|
849
|
+
/**
|
|
850
|
+
* Same as `getLead`, but resolves with the response body together with the HTTP status and headers.
|
|
851
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
852
|
+
* @param {LeadsApiGetLeadRequest} requestParameters Request parameters.
|
|
853
|
+
|
|
854
|
+
* @throws {RequiredError}
|
|
855
|
+
* @memberof LeadsApi
|
|
856
|
+
*/
|
|
857
|
+
getLeadWithHttpInfo(requestParameters) {
|
|
858
|
+
return LeadsApiFp(this.configuration).getLeadWithHttpInfo(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
859
|
+
}
|
|
667
860
|
/**
|
|
668
861
|
* Lists the users permitted to access a lead.
|
|
669
862
|
* @summary List permitted users
|
|
@@ -675,6 +868,17 @@ export class LeadsApi extends BaseAPI {
|
|
|
675
868
|
getLeadUsers(requestParameters) {
|
|
676
869
|
return LeadsApiFp(this.configuration).getLeadUsers(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
677
870
|
}
|
|
871
|
+
/**
|
|
872
|
+
* Same as `getLeadUsers`, but resolves with the response body together with the HTTP status and headers.
|
|
873
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
874
|
+
* @param {LeadsApiGetLeadUsersRequest} requestParameters Request parameters.
|
|
875
|
+
|
|
876
|
+
* @throws {RequiredError}
|
|
877
|
+
* @memberof LeadsApi
|
|
878
|
+
*/
|
|
879
|
+
getLeadUsersWithHttpInfo(requestParameters) {
|
|
880
|
+
return LeadsApiFp(this.configuration).getLeadUsersWithHttpInfo(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
881
|
+
}
|
|
678
882
|
/**
|
|
679
883
|
* 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.
|
|
680
884
|
* @summary Get all leads
|
|
@@ -686,6 +890,17 @@ export class LeadsApi extends BaseAPI {
|
|
|
686
890
|
getLeads(requestParameters = {}) {
|
|
687
891
|
return LeadsApiFp(this.configuration).getLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.updated_since, requestParameters.sort).then((request) => request(this.axios, this.basePath));
|
|
688
892
|
}
|
|
893
|
+
/**
|
|
894
|
+
* Same as `getLeads`, but resolves with the response body together with the HTTP status and headers.
|
|
895
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
896
|
+
* @param {LeadsApiGetLeadsRequest} requestParameters Request parameters.
|
|
897
|
+
|
|
898
|
+
* @throws {RequiredError}
|
|
899
|
+
* @memberof LeadsApi
|
|
900
|
+
*/
|
|
901
|
+
getLeadsWithHttpInfo(requestParameters = {}) {
|
|
902
|
+
return LeadsApiFp(this.configuration).getLeadsWithHttpInfo(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.updated_since, requestParameters.sort).then((request) => request(this.axios, this.basePath));
|
|
903
|
+
}
|
|
689
904
|
/**
|
|
690
905
|
* 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.
|
|
691
906
|
* @summary Search leads
|
|
@@ -697,6 +912,17 @@ export class LeadsApi extends BaseAPI {
|
|
|
697
912
|
searchLeads(requestParameters) {
|
|
698
913
|
return LeadsApiFp(this.configuration).searchLeads(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.person_id, requestParameters.organization_id, requestParameters.include_fields, requestParameters.start, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
|
699
914
|
}
|
|
915
|
+
/**
|
|
916
|
+
* Same as `searchLeads`, but resolves with the response body together with the HTTP status and headers.
|
|
917
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
918
|
+
* @param {LeadsApiSearchLeadsRequest} requestParameters Request parameters.
|
|
919
|
+
|
|
920
|
+
* @throws {RequiredError}
|
|
921
|
+
* @memberof LeadsApi
|
|
922
|
+
*/
|
|
923
|
+
searchLeadsWithHttpInfo(requestParameters) {
|
|
924
|
+
return LeadsApiFp(this.configuration).searchLeadsWithHttpInfo(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.person_id, requestParameters.organization_id, requestParameters.include_fields, requestParameters.start, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
|
925
|
+
}
|
|
700
926
|
/**
|
|
701
927
|
* Updates one or more properties of a lead. Only properties included in the request will be updated. Send `null` to unset a property (applicable for example for `value`, `person_id` or `organization_id`). 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. See an example given in the <a href=\"https://pipedrive.readme.io/docs/updating-custom-field-value\" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields’ values tutorial</a>.
|
|
702
928
|
* @summary Update a lead
|
|
@@ -708,4 +934,15 @@ export class LeadsApi extends BaseAPI {
|
|
|
708
934
|
updateLead(requestParameters) {
|
|
709
935
|
return LeadsApiFp(this.configuration).updateLead(requestParameters.id, requestParameters.UpdateLeadRequest).then((request) => request(this.axios, this.basePath));
|
|
710
936
|
}
|
|
937
|
+
/**
|
|
938
|
+
* Same as `updateLead`, but resolves with the response body together with the HTTP status and headers.
|
|
939
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
940
|
+
* @param {LeadsApiUpdateLeadRequest} requestParameters Request parameters.
|
|
941
|
+
|
|
942
|
+
* @throws {RequiredError}
|
|
943
|
+
* @memberof LeadsApi
|
|
944
|
+
*/
|
|
945
|
+
updateLeadWithHttpInfo(requestParameters) {
|
|
946
|
+
return LeadsApiFp(this.configuration).updateLeadWithHttpInfo(requestParameters.id, requestParameters.UpdateLeadRequest).then((request) => request(this.axios, this.basePath));
|
|
947
|
+
}
|
|
711
948
|
}
|