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
|
@@ -558,6 +558,19 @@ const PersonsApiFp = function (configuration) {
|
|
|
558
558
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
559
559
|
});
|
|
560
560
|
},
|
|
561
|
+
/**
|
|
562
|
+
* Same as `addPerson`, but resolves with the response body together with the HTTP status and headers.
|
|
563
|
+
* @summary Add a new person
|
|
564
|
+
* @param {AddPersonRequest} [AddPersonRequest]
|
|
565
|
+
|
|
566
|
+
* @throws {RequiredError}
|
|
567
|
+
*/
|
|
568
|
+
addPersonWithHttpInfo(AddPersonRequest) {
|
|
569
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
570
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.addPerson(AddPersonRequest);
|
|
571
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
572
|
+
});
|
|
573
|
+
},
|
|
561
574
|
/**
|
|
562
575
|
* Adds a user as a follower to the person.
|
|
563
576
|
* @summary Add a follower to a person
|
|
@@ -572,6 +585,20 @@ const PersonsApiFp = function (configuration) {
|
|
|
572
585
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
573
586
|
});
|
|
574
587
|
},
|
|
588
|
+
/**
|
|
589
|
+
* Same as `addPersonFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
590
|
+
* @summary Add a follower to a person
|
|
591
|
+
* @param {number} id The ID of the person
|
|
592
|
+
* @param {AddDealFollowerRequest} [AddDealFollowerRequest]
|
|
593
|
+
|
|
594
|
+
* @throws {RequiredError}
|
|
595
|
+
*/
|
|
596
|
+
addPersonFollowerWithHttpInfo(id, AddDealFollowerRequest) {
|
|
597
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
598
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.addPersonFollower(id, AddDealFollowerRequest);
|
|
599
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
600
|
+
});
|
|
601
|
+
},
|
|
575
602
|
/**
|
|
576
603
|
* Marks a person as deleted. After 30 days, the person will be permanently deleted.
|
|
577
604
|
* @summary Delete a person
|
|
@@ -585,6 +612,19 @@ const PersonsApiFp = function (configuration) {
|
|
|
585
612
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
586
613
|
});
|
|
587
614
|
},
|
|
615
|
+
/**
|
|
616
|
+
* Same as `deletePerson`, but resolves with the response body together with the HTTP status and headers.
|
|
617
|
+
* @summary Delete a person
|
|
618
|
+
* @param {number} id The ID of the person
|
|
619
|
+
|
|
620
|
+
* @throws {RequiredError}
|
|
621
|
+
*/
|
|
622
|
+
deletePersonWithHttpInfo(id) {
|
|
623
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
624
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deletePerson(id);
|
|
625
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
626
|
+
});
|
|
627
|
+
},
|
|
588
628
|
/**
|
|
589
629
|
* Deletes a user follower from the person.
|
|
590
630
|
* @summary Delete a follower from a person
|
|
@@ -599,6 +639,20 @@ const PersonsApiFp = function (configuration) {
|
|
|
599
639
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
600
640
|
});
|
|
601
641
|
},
|
|
642
|
+
/**
|
|
643
|
+
* Same as `deletePersonFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
644
|
+
* @summary Delete a follower from a person
|
|
645
|
+
* @param {number} id The ID of the person
|
|
646
|
+
* @param {number} follower_id The ID of the following user
|
|
647
|
+
|
|
648
|
+
* @throws {RequiredError}
|
|
649
|
+
*/
|
|
650
|
+
deletePersonFollowerWithHttpInfo(id, follower_id) {
|
|
651
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
652
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deletePersonFollower(id, follower_id);
|
|
653
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
654
|
+
});
|
|
655
|
+
},
|
|
602
656
|
/**
|
|
603
657
|
* Returns the details of a specific person. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
|
|
604
658
|
* @summary Get details of a person
|
|
@@ -616,6 +670,23 @@ const PersonsApiFp = function (configuration) {
|
|
|
616
670
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
617
671
|
});
|
|
618
672
|
},
|
|
673
|
+
/**
|
|
674
|
+
* Same as `getPerson`, but resolves with the response body together with the HTTP status and headers.
|
|
675
|
+
* @summary Get details of a person
|
|
676
|
+
* @param {number} id The ID of the person
|
|
677
|
+
* @param {Set<'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status' | 'smart_bcc_email'>} [include_fields] Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled.
|
|
678
|
+
* @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
679
|
+
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
680
|
+
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
681
|
+
|
|
682
|
+
* @throws {RequiredError}
|
|
683
|
+
*/
|
|
684
|
+
getPersonWithHttpInfo(id, include_fields, custom_fields, include_option_labels, include_labels) {
|
|
685
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
686
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPerson(id, include_fields, custom_fields, include_option_labels, include_labels);
|
|
687
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
688
|
+
});
|
|
689
|
+
},
|
|
619
690
|
/**
|
|
620
691
|
* Lists users who are following the person.
|
|
621
692
|
* @summary List followers of a person
|
|
@@ -631,6 +702,21 @@ const PersonsApiFp = function (configuration) {
|
|
|
631
702
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
632
703
|
});
|
|
633
704
|
},
|
|
705
|
+
/**
|
|
706
|
+
* Same as `getPersonFollowers`, but resolves with the response body together with the HTTP status and headers.
|
|
707
|
+
* @summary List followers of a person
|
|
708
|
+
* @param {number} id The ID of the person
|
|
709
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
|
710
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
711
|
+
|
|
712
|
+
* @throws {RequiredError}
|
|
713
|
+
*/
|
|
714
|
+
getPersonFollowersWithHttpInfo(id, limit, cursor) {
|
|
715
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
716
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPersonFollowers(id, limit, cursor);
|
|
717
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
718
|
+
});
|
|
719
|
+
},
|
|
634
720
|
/**
|
|
635
721
|
* Lists changelogs about users have followed the person.
|
|
636
722
|
* @summary List followers changelog of a person
|
|
@@ -646,6 +732,21 @@ const PersonsApiFp = function (configuration) {
|
|
|
646
732
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
647
733
|
});
|
|
648
734
|
},
|
|
735
|
+
/**
|
|
736
|
+
* Same as `getPersonFollowersChangelog`, but resolves with the response body together with the HTTP status and headers.
|
|
737
|
+
* @summary List followers changelog of a person
|
|
738
|
+
* @param {number} id The ID of the person
|
|
739
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
|
740
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
741
|
+
|
|
742
|
+
* @throws {RequiredError}
|
|
743
|
+
*/
|
|
744
|
+
getPersonFollowersChangelogWithHttpInfo(id, limit, cursor) {
|
|
745
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
746
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPersonFollowersChangelog(id, limit, cursor);
|
|
747
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
748
|
+
});
|
|
749
|
+
},
|
|
649
750
|
/**
|
|
650
751
|
* Returns the picture associated with a person. The picture URLs include both 128x128 and 512x512 pixel versions.
|
|
651
752
|
* @summary Get picture of a person
|
|
@@ -659,6 +760,19 @@ const PersonsApiFp = function (configuration) {
|
|
|
659
760
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
660
761
|
});
|
|
661
762
|
},
|
|
763
|
+
/**
|
|
764
|
+
* Same as `getPersonPicture`, but resolves with the response body together with the HTTP status and headers.
|
|
765
|
+
* @summary Get picture of a person
|
|
766
|
+
* @param {number} id The ID of the person
|
|
767
|
+
|
|
768
|
+
* @throws {RequiredError}
|
|
769
|
+
*/
|
|
770
|
+
getPersonPictureWithHttpInfo(id) {
|
|
771
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
772
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPersonPicture(id);
|
|
773
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
774
|
+
});
|
|
775
|
+
},
|
|
662
776
|
/**
|
|
663
777
|
* Returns data about all persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
|
|
664
778
|
* @summary Get all persons
|
|
@@ -686,6 +800,33 @@ const PersonsApiFp = function (configuration) {
|
|
|
686
800
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
687
801
|
});
|
|
688
802
|
},
|
|
803
|
+
/**
|
|
804
|
+
* Same as `getPersons`, but resolves with the response body together with the HTTP status and headers.
|
|
805
|
+
* @summary Get all persons
|
|
806
|
+
* @param {number} [filter_id] If supplied, only persons matching the specified filter are returned
|
|
807
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
808
|
+
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
809
|
+
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
810
|
+
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
811
|
+
* @param {string} [updated_since] If set, only persons with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
812
|
+
* @param {string} [updated_until] If set, only persons with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
813
|
+
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
814
|
+
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
815
|
+
* @param {Set<'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status' | 'smart_bcc_email'>} [include_fields] Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled.
|
|
816
|
+
* @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
817
|
+
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
818
|
+
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
819
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
|
820
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
821
|
+
|
|
822
|
+
* @throws {RequiredError}
|
|
823
|
+
*/
|
|
824
|
+
getPersonsWithHttpInfo(filter_id, ids, owner_id, org_id, deal_id, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, include_option_labels, include_labels, limit, cursor) {
|
|
825
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
826
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPersons(filter_id, ids, owner_id, org_id, deal_id, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, include_option_labels, include_labels, limit, cursor);
|
|
827
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
828
|
+
});
|
|
829
|
+
},
|
|
689
830
|
/**
|
|
690
831
|
* Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found persons can be filtered by organization ID.
|
|
691
832
|
* @summary Search persons
|
|
@@ -705,6 +846,25 @@ const PersonsApiFp = function (configuration) {
|
|
|
705
846
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
706
847
|
});
|
|
707
848
|
},
|
|
849
|
+
/**
|
|
850
|
+
* Same as `searchPersons`, but resolves with the response body together with the HTTP status and headers.
|
|
851
|
+
* @summary Search persons
|
|
852
|
+
* @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.
|
|
853
|
+
* @param {Set<'custom_fields' | 'email' | 'notes' | 'phone' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
854
|
+
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
855
|
+
* @param {number} [organization_id] Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
|
|
856
|
+
* @param {Set<'person.picture'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
857
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
858
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
859
|
+
|
|
860
|
+
* @throws {RequiredError}
|
|
861
|
+
*/
|
|
862
|
+
searchPersonsWithHttpInfo(term, fields, exact_match, organization_id, include_fields, limit, cursor) {
|
|
863
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
864
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.searchPersons(term, fields, exact_match, organization_id, include_fields, limit, cursor);
|
|
865
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
866
|
+
});
|
|
867
|
+
},
|
|
708
868
|
/**
|
|
709
869
|
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
710
870
|
* @summary Update a person
|
|
@@ -719,6 +879,20 @@ const PersonsApiFp = function (configuration) {
|
|
|
719
879
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
720
880
|
});
|
|
721
881
|
},
|
|
882
|
+
/**
|
|
883
|
+
* Same as `updatePerson`, but resolves with the response body together with the HTTP status and headers.
|
|
884
|
+
* @summary Update a person
|
|
885
|
+
* @param {number} id The ID of the person
|
|
886
|
+
* @param {UpdatePersonRequest} [UpdatePersonRequest]
|
|
887
|
+
|
|
888
|
+
* @throws {RequiredError}
|
|
889
|
+
*/
|
|
890
|
+
updatePersonWithHttpInfo(id, UpdatePersonRequest) {
|
|
891
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
892
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updatePerson(id, UpdatePersonRequest);
|
|
893
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
894
|
+
});
|
|
895
|
+
},
|
|
722
896
|
};
|
|
723
897
|
};
|
|
724
898
|
exports.PersonsApiFp = PersonsApiFp;
|
|
@@ -739,6 +913,9 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
739
913
|
addPerson(requestParameters = {}) {
|
|
740
914
|
return localVarFp.addPerson(requestParameters.AddPersonRequest).then((request) => request(axios, basePath));
|
|
741
915
|
},
|
|
916
|
+
addPersonWithHttpInfo(requestParameters = {}) {
|
|
917
|
+
return localVarFp.addPersonWithHttpInfo(requestParameters.AddPersonRequest).then((request) => request(axios, basePath));
|
|
918
|
+
},
|
|
742
919
|
/**
|
|
743
920
|
* Adds a user as a follower to the person.
|
|
744
921
|
* @summary Add a follower to a person
|
|
@@ -749,6 +926,9 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
749
926
|
addPersonFollower(requestParameters) {
|
|
750
927
|
return localVarFp.addPersonFollower(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(axios, basePath));
|
|
751
928
|
},
|
|
929
|
+
addPersonFollowerWithHttpInfo(requestParameters) {
|
|
930
|
+
return localVarFp.addPersonFollowerWithHttpInfo(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(axios, basePath));
|
|
931
|
+
},
|
|
752
932
|
/**
|
|
753
933
|
* Marks a person as deleted. After 30 days, the person will be permanently deleted.
|
|
754
934
|
* @summary Delete a person
|
|
@@ -759,6 +939,9 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
759
939
|
deletePerson(requestParameters) {
|
|
760
940
|
return localVarFp.deletePerson(requestParameters.id).then((request) => request(axios, basePath));
|
|
761
941
|
},
|
|
942
|
+
deletePersonWithHttpInfo(requestParameters) {
|
|
943
|
+
return localVarFp.deletePersonWithHttpInfo(requestParameters.id).then((request) => request(axios, basePath));
|
|
944
|
+
},
|
|
762
945
|
/**
|
|
763
946
|
* Deletes a user follower from the person.
|
|
764
947
|
* @summary Delete a follower from a person
|
|
@@ -769,6 +952,9 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
769
952
|
deletePersonFollower(requestParameters) {
|
|
770
953
|
return localVarFp.deletePersonFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(axios, basePath));
|
|
771
954
|
},
|
|
955
|
+
deletePersonFollowerWithHttpInfo(requestParameters) {
|
|
956
|
+
return localVarFp.deletePersonFollowerWithHttpInfo(requestParameters.id, requestParameters.follower_id).then((request) => request(axios, basePath));
|
|
957
|
+
},
|
|
772
958
|
/**
|
|
773
959
|
* Returns the details of a specific person. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
|
|
774
960
|
* @summary Get details of a person
|
|
@@ -779,6 +965,9 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
779
965
|
getPerson(requestParameters) {
|
|
780
966
|
return localVarFp.getPerson(requestParameters.id, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.include_option_labels, requestParameters.include_labels).then((request) => request(axios, basePath));
|
|
781
967
|
},
|
|
968
|
+
getPersonWithHttpInfo(requestParameters) {
|
|
969
|
+
return localVarFp.getPersonWithHttpInfo(requestParameters.id, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.include_option_labels, requestParameters.include_labels).then((request) => request(axios, basePath));
|
|
970
|
+
},
|
|
782
971
|
/**
|
|
783
972
|
* Lists users who are following the person.
|
|
784
973
|
* @summary List followers of a person
|
|
@@ -789,6 +978,9 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
789
978
|
getPersonFollowers(requestParameters) {
|
|
790
979
|
return localVarFp.getPersonFollowers(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
|
791
980
|
},
|
|
981
|
+
getPersonFollowersWithHttpInfo(requestParameters) {
|
|
982
|
+
return localVarFp.getPersonFollowersWithHttpInfo(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
|
983
|
+
},
|
|
792
984
|
/**
|
|
793
985
|
* Lists changelogs about users have followed the person.
|
|
794
986
|
* @summary List followers changelog of a person
|
|
@@ -799,6 +991,9 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
799
991
|
getPersonFollowersChangelog(requestParameters) {
|
|
800
992
|
return localVarFp.getPersonFollowersChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
|
801
993
|
},
|
|
994
|
+
getPersonFollowersChangelogWithHttpInfo(requestParameters) {
|
|
995
|
+
return localVarFp.getPersonFollowersChangelogWithHttpInfo(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
|
996
|
+
},
|
|
802
997
|
/**
|
|
803
998
|
* Returns the picture associated with a person. The picture URLs include both 128x128 and 512x512 pixel versions.
|
|
804
999
|
* @summary Get picture of a person
|
|
@@ -809,6 +1004,9 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
809
1004
|
getPersonPicture(requestParameters) {
|
|
810
1005
|
return localVarFp.getPersonPicture(requestParameters.id).then((request) => request(axios, basePath));
|
|
811
1006
|
},
|
|
1007
|
+
getPersonPictureWithHttpInfo(requestParameters) {
|
|
1008
|
+
return localVarFp.getPersonPictureWithHttpInfo(requestParameters.id).then((request) => request(axios, basePath));
|
|
1009
|
+
},
|
|
812
1010
|
/**
|
|
813
1011
|
* Returns data about all persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
|
|
814
1012
|
* @summary Get all persons
|
|
@@ -819,6 +1017,9 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
819
1017
|
getPersons(requestParameters = {}) {
|
|
820
1018
|
return localVarFp.getPersons(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.org_id, requestParameters.deal_id, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.include_option_labels, requestParameters.include_labels, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
|
821
1019
|
},
|
|
1020
|
+
getPersonsWithHttpInfo(requestParameters = {}) {
|
|
1021
|
+
return localVarFp.getPersonsWithHttpInfo(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.org_id, requestParameters.deal_id, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.include_option_labels, requestParameters.include_labels, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
|
1022
|
+
},
|
|
822
1023
|
/**
|
|
823
1024
|
* Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found persons can be filtered by organization ID.
|
|
824
1025
|
* @summary Search persons
|
|
@@ -829,6 +1030,9 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
829
1030
|
searchPersons(requestParameters) {
|
|
830
1031
|
return localVarFp.searchPersons(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.organization_id, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
|
831
1032
|
},
|
|
1033
|
+
searchPersonsWithHttpInfo(requestParameters) {
|
|
1034
|
+
return localVarFp.searchPersonsWithHttpInfo(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.organization_id, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
|
1035
|
+
},
|
|
832
1036
|
/**
|
|
833
1037
|
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
834
1038
|
* @summary Update a person
|
|
@@ -839,6 +1043,9 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
839
1043
|
updatePerson(requestParameters) {
|
|
840
1044
|
return localVarFp.updatePerson(requestParameters.id, requestParameters.UpdatePersonRequest).then((request) => request(axios, basePath));
|
|
841
1045
|
},
|
|
1046
|
+
updatePersonWithHttpInfo(requestParameters) {
|
|
1047
|
+
return localVarFp.updatePersonWithHttpInfo(requestParameters.id, requestParameters.UpdatePersonRequest).then((request) => request(axios, basePath));
|
|
1048
|
+
},
|
|
842
1049
|
};
|
|
843
1050
|
};
|
|
844
1051
|
exports.PersonsApiFactory = PersonsApiFactory;
|
|
@@ -860,6 +1067,17 @@ class PersonsApi extends base_1.BaseAPI {
|
|
|
860
1067
|
addPerson(requestParameters = {}) {
|
|
861
1068
|
return (0, exports.PersonsApiFp)(this.configuration).addPerson(requestParameters.AddPersonRequest).then((request) => request(this.axios, this.basePath));
|
|
862
1069
|
}
|
|
1070
|
+
/**
|
|
1071
|
+
* Same as `addPerson`, but resolves with the response body together with the HTTP status and headers.
|
|
1072
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1073
|
+
* @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
|
|
1074
|
+
|
|
1075
|
+
* @throws {RequiredError}
|
|
1076
|
+
* @memberof PersonsApi
|
|
1077
|
+
*/
|
|
1078
|
+
addPersonWithHttpInfo(requestParameters = {}) {
|
|
1079
|
+
return (0, exports.PersonsApiFp)(this.configuration).addPersonWithHttpInfo(requestParameters.AddPersonRequest).then((request) => request(this.axios, this.basePath));
|
|
1080
|
+
}
|
|
863
1081
|
/**
|
|
864
1082
|
* Adds a user as a follower to the person.
|
|
865
1083
|
* @summary Add a follower to a person
|
|
@@ -871,6 +1089,17 @@ class PersonsApi extends base_1.BaseAPI {
|
|
|
871
1089
|
addPersonFollower(requestParameters) {
|
|
872
1090
|
return (0, exports.PersonsApiFp)(this.configuration).addPersonFollower(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(this.axios, this.basePath));
|
|
873
1091
|
}
|
|
1092
|
+
/**
|
|
1093
|
+
* Same as `addPersonFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
1094
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1095
|
+
* @param {PersonsApiAddPersonFollowerRequest} requestParameters Request parameters.
|
|
1096
|
+
|
|
1097
|
+
* @throws {RequiredError}
|
|
1098
|
+
* @memberof PersonsApi
|
|
1099
|
+
*/
|
|
1100
|
+
addPersonFollowerWithHttpInfo(requestParameters) {
|
|
1101
|
+
return (0, exports.PersonsApiFp)(this.configuration).addPersonFollowerWithHttpInfo(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(this.axios, this.basePath));
|
|
1102
|
+
}
|
|
874
1103
|
/**
|
|
875
1104
|
* Marks a person as deleted. After 30 days, the person will be permanently deleted.
|
|
876
1105
|
* @summary Delete a person
|
|
@@ -882,6 +1111,17 @@ class PersonsApi extends base_1.BaseAPI {
|
|
|
882
1111
|
deletePerson(requestParameters) {
|
|
883
1112
|
return (0, exports.PersonsApiFp)(this.configuration).deletePerson(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
884
1113
|
}
|
|
1114
|
+
/**
|
|
1115
|
+
* Same as `deletePerson`, but resolves with the response body together with the HTTP status and headers.
|
|
1116
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1117
|
+
* @param {PersonsApiDeletePersonRequest} requestParameters Request parameters.
|
|
1118
|
+
|
|
1119
|
+
* @throws {RequiredError}
|
|
1120
|
+
* @memberof PersonsApi
|
|
1121
|
+
*/
|
|
1122
|
+
deletePersonWithHttpInfo(requestParameters) {
|
|
1123
|
+
return (0, exports.PersonsApiFp)(this.configuration).deletePersonWithHttpInfo(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
1124
|
+
}
|
|
885
1125
|
/**
|
|
886
1126
|
* Deletes a user follower from the person.
|
|
887
1127
|
* @summary Delete a follower from a person
|
|
@@ -893,6 +1133,17 @@ class PersonsApi extends base_1.BaseAPI {
|
|
|
893
1133
|
deletePersonFollower(requestParameters) {
|
|
894
1134
|
return (0, exports.PersonsApiFp)(this.configuration).deletePersonFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(this.axios, this.basePath));
|
|
895
1135
|
}
|
|
1136
|
+
/**
|
|
1137
|
+
* Same as `deletePersonFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
1138
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1139
|
+
* @param {PersonsApiDeletePersonFollowerRequest} requestParameters Request parameters.
|
|
1140
|
+
|
|
1141
|
+
* @throws {RequiredError}
|
|
1142
|
+
* @memberof PersonsApi
|
|
1143
|
+
*/
|
|
1144
|
+
deletePersonFollowerWithHttpInfo(requestParameters) {
|
|
1145
|
+
return (0, exports.PersonsApiFp)(this.configuration).deletePersonFollowerWithHttpInfo(requestParameters.id, requestParameters.follower_id).then((request) => request(this.axios, this.basePath));
|
|
1146
|
+
}
|
|
896
1147
|
/**
|
|
897
1148
|
* Returns the details of a specific person. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
|
|
898
1149
|
* @summary Get details of a person
|
|
@@ -904,6 +1155,17 @@ class PersonsApi extends base_1.BaseAPI {
|
|
|
904
1155
|
getPerson(requestParameters) {
|
|
905
1156
|
return (0, exports.PersonsApiFp)(this.configuration).getPerson(requestParameters.id, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.include_option_labels, requestParameters.include_labels).then((request) => request(this.axios, this.basePath));
|
|
906
1157
|
}
|
|
1158
|
+
/**
|
|
1159
|
+
* Same as `getPerson`, but resolves with the response body together with the HTTP status and headers.
|
|
1160
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1161
|
+
* @param {PersonsApiGetPersonRequest} requestParameters Request parameters.
|
|
1162
|
+
|
|
1163
|
+
* @throws {RequiredError}
|
|
1164
|
+
* @memberof PersonsApi
|
|
1165
|
+
*/
|
|
1166
|
+
getPersonWithHttpInfo(requestParameters) {
|
|
1167
|
+
return (0, exports.PersonsApiFp)(this.configuration).getPersonWithHttpInfo(requestParameters.id, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.include_option_labels, requestParameters.include_labels).then((request) => request(this.axios, this.basePath));
|
|
1168
|
+
}
|
|
907
1169
|
/**
|
|
908
1170
|
* Lists users who are following the person.
|
|
909
1171
|
* @summary List followers of a person
|
|
@@ -915,6 +1177,17 @@ class PersonsApi extends base_1.BaseAPI {
|
|
|
915
1177
|
getPersonFollowers(requestParameters) {
|
|
916
1178
|
return (0, exports.PersonsApiFp)(this.configuration).getPersonFollowers(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
|
917
1179
|
}
|
|
1180
|
+
/**
|
|
1181
|
+
* Same as `getPersonFollowers`, but resolves with the response body together with the HTTP status and headers.
|
|
1182
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1183
|
+
* @param {PersonsApiGetPersonFollowersRequest} requestParameters Request parameters.
|
|
1184
|
+
|
|
1185
|
+
* @throws {RequiredError}
|
|
1186
|
+
* @memberof PersonsApi
|
|
1187
|
+
*/
|
|
1188
|
+
getPersonFollowersWithHttpInfo(requestParameters) {
|
|
1189
|
+
return (0, exports.PersonsApiFp)(this.configuration).getPersonFollowersWithHttpInfo(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
|
1190
|
+
}
|
|
918
1191
|
/**
|
|
919
1192
|
* Lists changelogs about users have followed the person.
|
|
920
1193
|
* @summary List followers changelog of a person
|
|
@@ -926,6 +1199,17 @@ class PersonsApi extends base_1.BaseAPI {
|
|
|
926
1199
|
getPersonFollowersChangelog(requestParameters) {
|
|
927
1200
|
return (0, exports.PersonsApiFp)(this.configuration).getPersonFollowersChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
|
928
1201
|
}
|
|
1202
|
+
/**
|
|
1203
|
+
* Same as `getPersonFollowersChangelog`, but resolves with the response body together with the HTTP status and headers.
|
|
1204
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1205
|
+
* @param {PersonsApiGetPersonFollowersChangelogRequest} requestParameters Request parameters.
|
|
1206
|
+
|
|
1207
|
+
* @throws {RequiredError}
|
|
1208
|
+
* @memberof PersonsApi
|
|
1209
|
+
*/
|
|
1210
|
+
getPersonFollowersChangelogWithHttpInfo(requestParameters) {
|
|
1211
|
+
return (0, exports.PersonsApiFp)(this.configuration).getPersonFollowersChangelogWithHttpInfo(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
|
1212
|
+
}
|
|
929
1213
|
/**
|
|
930
1214
|
* Returns the picture associated with a person. The picture URLs include both 128x128 and 512x512 pixel versions.
|
|
931
1215
|
* @summary Get picture of a person
|
|
@@ -937,6 +1221,17 @@ class PersonsApi extends base_1.BaseAPI {
|
|
|
937
1221
|
getPersonPicture(requestParameters) {
|
|
938
1222
|
return (0, exports.PersonsApiFp)(this.configuration).getPersonPicture(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
939
1223
|
}
|
|
1224
|
+
/**
|
|
1225
|
+
* Same as `getPersonPicture`, but resolves with the response body together with the HTTP status and headers.
|
|
1226
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1227
|
+
* @param {PersonsApiGetPersonPictureRequest} requestParameters Request parameters.
|
|
1228
|
+
|
|
1229
|
+
* @throws {RequiredError}
|
|
1230
|
+
* @memberof PersonsApi
|
|
1231
|
+
*/
|
|
1232
|
+
getPersonPictureWithHttpInfo(requestParameters) {
|
|
1233
|
+
return (0, exports.PersonsApiFp)(this.configuration).getPersonPictureWithHttpInfo(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
1234
|
+
}
|
|
940
1235
|
/**
|
|
941
1236
|
* Returns data about all persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
|
|
942
1237
|
* @summary Get all persons
|
|
@@ -948,6 +1243,17 @@ class PersonsApi extends base_1.BaseAPI {
|
|
|
948
1243
|
getPersons(requestParameters = {}) {
|
|
949
1244
|
return (0, exports.PersonsApiFp)(this.configuration).getPersons(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.org_id, requestParameters.deal_id, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.include_option_labels, requestParameters.include_labels, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
|
950
1245
|
}
|
|
1246
|
+
/**
|
|
1247
|
+
* Same as `getPersons`, but resolves with the response body together with the HTTP status and headers.
|
|
1248
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1249
|
+
* @param {PersonsApiGetPersonsRequest} requestParameters Request parameters.
|
|
1250
|
+
|
|
1251
|
+
* @throws {RequiredError}
|
|
1252
|
+
* @memberof PersonsApi
|
|
1253
|
+
*/
|
|
1254
|
+
getPersonsWithHttpInfo(requestParameters = {}) {
|
|
1255
|
+
return (0, exports.PersonsApiFp)(this.configuration).getPersonsWithHttpInfo(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.org_id, requestParameters.deal_id, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.include_option_labels, requestParameters.include_labels, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
|
1256
|
+
}
|
|
951
1257
|
/**
|
|
952
1258
|
* Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found persons can be filtered by organization ID.
|
|
953
1259
|
* @summary Search persons
|
|
@@ -959,6 +1265,17 @@ class PersonsApi extends base_1.BaseAPI {
|
|
|
959
1265
|
searchPersons(requestParameters) {
|
|
960
1266
|
return (0, exports.PersonsApiFp)(this.configuration).searchPersons(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.organization_id, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
|
961
1267
|
}
|
|
1268
|
+
/**
|
|
1269
|
+
* Same as `searchPersons`, but resolves with the response body together with the HTTP status and headers.
|
|
1270
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1271
|
+
* @param {PersonsApiSearchPersonsRequest} requestParameters Request parameters.
|
|
1272
|
+
|
|
1273
|
+
* @throws {RequiredError}
|
|
1274
|
+
* @memberof PersonsApi
|
|
1275
|
+
*/
|
|
1276
|
+
searchPersonsWithHttpInfo(requestParameters) {
|
|
1277
|
+
return (0, exports.PersonsApiFp)(this.configuration).searchPersonsWithHttpInfo(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.organization_id, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
|
1278
|
+
}
|
|
962
1279
|
/**
|
|
963
1280
|
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
964
1281
|
* @summary Update a person
|
|
@@ -970,5 +1287,16 @@ class PersonsApi extends base_1.BaseAPI {
|
|
|
970
1287
|
updatePerson(requestParameters) {
|
|
971
1288
|
return (0, exports.PersonsApiFp)(this.configuration).updatePerson(requestParameters.id, requestParameters.UpdatePersonRequest).then((request) => request(this.axios, this.basePath));
|
|
972
1289
|
}
|
|
1290
|
+
/**
|
|
1291
|
+
* Same as `updatePerson`, but resolves with the response body together with the HTTP status and headers.
|
|
1292
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1293
|
+
* @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters.
|
|
1294
|
+
|
|
1295
|
+
* @throws {RequiredError}
|
|
1296
|
+
* @memberof PersonsApi
|
|
1297
|
+
*/
|
|
1298
|
+
updatePersonWithHttpInfo(requestParameters) {
|
|
1299
|
+
return (0, exports.PersonsApiFp)(this.configuration).updatePersonWithHttpInfo(requestParameters.id, requestParameters.UpdatePersonRequest).then((request) => request(this.axios, this.basePath));
|
|
1300
|
+
}
|
|
973
1301
|
}
|
|
974
1302
|
exports.PersonsApi = PersonsApi;
|