pipedrive 36.0.0 → 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/v1/models/deal-all-of.d.ts +6 -6
- package/dist/esm/versions/v1/models/index.d.ts +0 -3
- package/dist/esm/versions/v1/models/index.js +0 -3
- package/dist/esm/versions/v1/models/note-deal.d.ts +11 -5
- 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/esm/versions/v2/models/index.d.ts +2 -5
- package/dist/esm/versions/v2/models/index.js +2 -5
- package/dist/esm/versions/v2/models/prices-array.d.ts +3 -3
- package/dist/esm/versions/v2/models/{product-request-prices-inner-all-of.d.ts → product-price-request.d.ts} +12 -2
- package/dist/{versions/v2/models/prices-array-prices-inner-all-of.d.ts → esm/versions/v2/models/product-price.d.ts} +12 -2
- package/dist/esm/versions/v2/models/product-request.d.ts +3 -3
- 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/v1/models/deal-all-of.d.ts +6 -6
- package/dist/versions/v1/models/index.d.ts +0 -3
- package/dist/versions/v1/models/index.js +0 -3
- package/dist/versions/v1/models/note-deal.d.ts +11 -5
- 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/dist/versions/v2/models/index.d.ts +2 -5
- package/dist/versions/v2/models/index.js +2 -5
- package/dist/versions/v2/models/prices-array.d.ts +3 -3
- package/dist/versions/v2/models/{product-request-prices-inner-all-of.d.ts → product-price-request.d.ts} +12 -2
- package/dist/{esm/versions/v2/models/prices-array-prices-inner-all-of.d.ts → versions/v2/models/product-price.d.ts} +12 -2
- package/dist/versions/v2/models/product-request.d.ts +3 -3
- package/package.json +1 -1
- package/dist/esm/versions/v1/models/deal-all-of-org-id.d.ts +0 -17
- package/dist/esm/versions/v1/models/deal-all-of-org-id.js +0 -14
- package/dist/esm/versions/v1/models/deal-all-of-person-id.d.ts +0 -17
- package/dist/esm/versions/v1/models/deal-all-of-person-id.js +0 -14
- package/dist/esm/versions/v1/models/note-deal-all-of.d.ts +0 -23
- package/dist/esm/versions/v1/models/note-deal-all-of.js +0 -14
- package/dist/esm/versions/v2/models/prices-array-prices-inner.d.ts +0 -18
- package/dist/esm/versions/v2/models/product-price-base.d.ts +0 -28
- package/dist/esm/versions/v2/models/product-price-base.js +0 -14
- package/dist/esm/versions/v2/models/product-request-prices-inner-all-of.js +0 -14
- package/dist/esm/versions/v2/models/product-request-prices-inner.d.ts +0 -18
- package/dist/esm/versions/v2/models/product-request-prices-inner.js +0 -14
- package/dist/versions/v1/models/deal-all-of-org-id.d.ts +0 -17
- package/dist/versions/v1/models/deal-all-of-org-id.js +0 -15
- package/dist/versions/v1/models/deal-all-of-person-id.d.ts +0 -17
- package/dist/versions/v1/models/deal-all-of-person-id.js +0 -15
- package/dist/versions/v1/models/note-deal-all-of.d.ts +0 -23
- package/dist/versions/v1/models/note-deal-all-of.js +0 -15
- package/dist/versions/v2/models/prices-array-prices-inner.d.ts +0 -18
- package/dist/versions/v2/models/product-price-base.d.ts +0 -28
- package/dist/versions/v2/models/product-price-base.js +0 -15
- package/dist/versions/v2/models/product-request-prices-inner-all-of.js +0 -15
- package/dist/versions/v2/models/product-request-prices-inner.d.ts +0 -18
- package/dist/versions/v2/models/product-request-prices-inner.js +0 -15
- /package/dist/esm/versions/v2/models/{prices-array-prices-inner-all-of.js → product-price-request.js} +0 -0
- /package/dist/esm/versions/v2/models/{prices-array-prices-inner.js → product-price.js} +0 -0
- /package/dist/versions/v2/models/{prices-array-prices-inner-all-of.js → product-price-request.js} +0 -0
- /package/dist/versions/v2/models/{prices-array-prices-inner.js → product-price.js} +0 -0
|
@@ -551,6 +551,19 @@ export const PersonsApiFp = function (configuration) {
|
|
|
551
551
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
552
552
|
});
|
|
553
553
|
},
|
|
554
|
+
/**
|
|
555
|
+
* Same as `addPerson`, but resolves with the response body together with the HTTP status and headers.
|
|
556
|
+
* @summary Add a new person
|
|
557
|
+
* @param {AddPersonRequest} [AddPersonRequest]
|
|
558
|
+
|
|
559
|
+
* @throws {RequiredError}
|
|
560
|
+
*/
|
|
561
|
+
addPersonWithHttpInfo(AddPersonRequest) {
|
|
562
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
563
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.addPerson(AddPersonRequest);
|
|
564
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
565
|
+
});
|
|
566
|
+
},
|
|
554
567
|
/**
|
|
555
568
|
* Adds a user as a follower to the person.
|
|
556
569
|
* @summary Add a follower to a person
|
|
@@ -565,6 +578,20 @@ export const PersonsApiFp = function (configuration) {
|
|
|
565
578
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
566
579
|
});
|
|
567
580
|
},
|
|
581
|
+
/**
|
|
582
|
+
* Same as `addPersonFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
583
|
+
* @summary Add a follower to a person
|
|
584
|
+
* @param {number} id The ID of the person
|
|
585
|
+
* @param {AddDealFollowerRequest} [AddDealFollowerRequest]
|
|
586
|
+
|
|
587
|
+
* @throws {RequiredError}
|
|
588
|
+
*/
|
|
589
|
+
addPersonFollowerWithHttpInfo(id, AddDealFollowerRequest) {
|
|
590
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
591
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.addPersonFollower(id, AddDealFollowerRequest);
|
|
592
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
593
|
+
});
|
|
594
|
+
},
|
|
568
595
|
/**
|
|
569
596
|
* Marks a person as deleted. After 30 days, the person will be permanently deleted.
|
|
570
597
|
* @summary Delete a person
|
|
@@ -578,6 +605,19 @@ export const PersonsApiFp = function (configuration) {
|
|
|
578
605
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
579
606
|
});
|
|
580
607
|
},
|
|
608
|
+
/**
|
|
609
|
+
* Same as `deletePerson`, but resolves with the response body together with the HTTP status and headers.
|
|
610
|
+
* @summary Delete a person
|
|
611
|
+
* @param {number} id The ID of the person
|
|
612
|
+
|
|
613
|
+
* @throws {RequiredError}
|
|
614
|
+
*/
|
|
615
|
+
deletePersonWithHttpInfo(id) {
|
|
616
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
617
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deletePerson(id);
|
|
618
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
619
|
+
});
|
|
620
|
+
},
|
|
581
621
|
/**
|
|
582
622
|
* Deletes a user follower from the person.
|
|
583
623
|
* @summary Delete a follower from a person
|
|
@@ -592,6 +632,20 @@ export const PersonsApiFp = function (configuration) {
|
|
|
592
632
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
593
633
|
});
|
|
594
634
|
},
|
|
635
|
+
/**
|
|
636
|
+
* Same as `deletePersonFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
637
|
+
* @summary Delete a follower from a person
|
|
638
|
+
* @param {number} id The ID of the person
|
|
639
|
+
* @param {number} follower_id The ID of the following user
|
|
640
|
+
|
|
641
|
+
* @throws {RequiredError}
|
|
642
|
+
*/
|
|
643
|
+
deletePersonFollowerWithHttpInfo(id, follower_id) {
|
|
644
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
645
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deletePersonFollower(id, follower_id);
|
|
646
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
647
|
+
});
|
|
648
|
+
},
|
|
595
649
|
/**
|
|
596
650
|
* 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.
|
|
597
651
|
* @summary Get details of a person
|
|
@@ -609,6 +663,23 @@ export const PersonsApiFp = function (configuration) {
|
|
|
609
663
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
610
664
|
});
|
|
611
665
|
},
|
|
666
|
+
/**
|
|
667
|
+
* Same as `getPerson`, but resolves with the response body together with the HTTP status and headers.
|
|
668
|
+
* @summary Get details of a person
|
|
669
|
+
* @param {number} id The ID of the person
|
|
670
|
+
* @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.
|
|
671
|
+
* @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.
|
|
672
|
+
* @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
|
|
673
|
+
* @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 }\'
|
|
674
|
+
|
|
675
|
+
* @throws {RequiredError}
|
|
676
|
+
*/
|
|
677
|
+
getPersonWithHttpInfo(id, include_fields, custom_fields, include_option_labels, include_labels) {
|
|
678
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
679
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPerson(id, include_fields, custom_fields, include_option_labels, include_labels);
|
|
680
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
681
|
+
});
|
|
682
|
+
},
|
|
612
683
|
/**
|
|
613
684
|
* Lists users who are following the person.
|
|
614
685
|
* @summary List followers of a person
|
|
@@ -624,6 +695,21 @@ export const PersonsApiFp = function (configuration) {
|
|
|
624
695
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
625
696
|
});
|
|
626
697
|
},
|
|
698
|
+
/**
|
|
699
|
+
* Same as `getPersonFollowers`, but resolves with the response body together with the HTTP status and headers.
|
|
700
|
+
* @summary List followers of a person
|
|
701
|
+
* @param {number} id The ID of the person
|
|
702
|
+
* @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.
|
|
703
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
704
|
+
|
|
705
|
+
* @throws {RequiredError}
|
|
706
|
+
*/
|
|
707
|
+
getPersonFollowersWithHttpInfo(id, limit, cursor) {
|
|
708
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
709
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPersonFollowers(id, limit, cursor);
|
|
710
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
711
|
+
});
|
|
712
|
+
},
|
|
627
713
|
/**
|
|
628
714
|
* Lists changelogs about users have followed the person.
|
|
629
715
|
* @summary List followers changelog of a person
|
|
@@ -639,6 +725,21 @@ export const PersonsApiFp = function (configuration) {
|
|
|
639
725
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
640
726
|
});
|
|
641
727
|
},
|
|
728
|
+
/**
|
|
729
|
+
* Same as `getPersonFollowersChangelog`, but resolves with the response body together with the HTTP status and headers.
|
|
730
|
+
* @summary List followers changelog of a person
|
|
731
|
+
* @param {number} id The ID of the person
|
|
732
|
+
* @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.
|
|
733
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
734
|
+
|
|
735
|
+
* @throws {RequiredError}
|
|
736
|
+
*/
|
|
737
|
+
getPersonFollowersChangelogWithHttpInfo(id, limit, cursor) {
|
|
738
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
739
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPersonFollowersChangelog(id, limit, cursor);
|
|
740
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
741
|
+
});
|
|
742
|
+
},
|
|
642
743
|
/**
|
|
643
744
|
* Returns the picture associated with a person. The picture URLs include both 128x128 and 512x512 pixel versions.
|
|
644
745
|
* @summary Get picture of a person
|
|
@@ -652,6 +753,19 @@ export const PersonsApiFp = function (configuration) {
|
|
|
652
753
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
653
754
|
});
|
|
654
755
|
},
|
|
756
|
+
/**
|
|
757
|
+
* Same as `getPersonPicture`, but resolves with the response body together with the HTTP status and headers.
|
|
758
|
+
* @summary Get picture of a person
|
|
759
|
+
* @param {number} id The ID of the person
|
|
760
|
+
|
|
761
|
+
* @throws {RequiredError}
|
|
762
|
+
*/
|
|
763
|
+
getPersonPictureWithHttpInfo(id) {
|
|
764
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
765
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPersonPicture(id);
|
|
766
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
767
|
+
});
|
|
768
|
+
},
|
|
655
769
|
/**
|
|
656
770
|
* 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.
|
|
657
771
|
* @summary Get all persons
|
|
@@ -679,6 +793,33 @@ export const PersonsApiFp = function (configuration) {
|
|
|
679
793
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
680
794
|
});
|
|
681
795
|
},
|
|
796
|
+
/**
|
|
797
|
+
* Same as `getPersons`, but resolves with the response body together with the HTTP status and headers.
|
|
798
|
+
* @summary Get all persons
|
|
799
|
+
* @param {number} [filter_id] If supplied, only persons matching the specified filter are returned
|
|
800
|
+
* @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.
|
|
801
|
+
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
802
|
+
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
803
|
+
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
804
|
+
* @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.
|
|
805
|
+
* @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.
|
|
806
|
+
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
807
|
+
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
808
|
+
* @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.
|
|
809
|
+
* @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.
|
|
810
|
+
* @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
|
|
811
|
+
* @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 }\'
|
|
812
|
+
* @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.
|
|
813
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
814
|
+
|
|
815
|
+
* @throws {RequiredError}
|
|
816
|
+
*/
|
|
817
|
+
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) {
|
|
818
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
819
|
+
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);
|
|
820
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
821
|
+
});
|
|
822
|
+
},
|
|
682
823
|
/**
|
|
683
824
|
* 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.
|
|
684
825
|
* @summary Search persons
|
|
@@ -698,6 +839,25 @@ export const PersonsApiFp = function (configuration) {
|
|
|
698
839
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
699
840
|
});
|
|
700
841
|
},
|
|
842
|
+
/**
|
|
843
|
+
* Same as `searchPersons`, but resolves with the response body together with the HTTP status and headers.
|
|
844
|
+
* @summary Search persons
|
|
845
|
+
* @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.
|
|
846
|
+
* @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>.
|
|
847
|
+
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
848
|
+
* @param {number} [organization_id] Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
|
|
849
|
+
* @param {Set<'person.picture'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
850
|
+
* @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.
|
|
851
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
852
|
+
|
|
853
|
+
* @throws {RequiredError}
|
|
854
|
+
*/
|
|
855
|
+
searchPersonsWithHttpInfo(term, fields, exact_match, organization_id, include_fields, limit, cursor) {
|
|
856
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
857
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.searchPersons(term, fields, exact_match, organization_id, include_fields, limit, cursor);
|
|
858
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
859
|
+
});
|
|
860
|
+
},
|
|
701
861
|
/**
|
|
702
862
|
* 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.
|
|
703
863
|
* @summary Update a person
|
|
@@ -712,6 +872,20 @@ export const PersonsApiFp = function (configuration) {
|
|
|
712
872
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
713
873
|
});
|
|
714
874
|
},
|
|
875
|
+
/**
|
|
876
|
+
* Same as `updatePerson`, but resolves with the response body together with the HTTP status and headers.
|
|
877
|
+
* @summary Update a person
|
|
878
|
+
* @param {number} id The ID of the person
|
|
879
|
+
* @param {UpdatePersonRequest} [UpdatePersonRequest]
|
|
880
|
+
|
|
881
|
+
* @throws {RequiredError}
|
|
882
|
+
*/
|
|
883
|
+
updatePersonWithHttpInfo(id, UpdatePersonRequest) {
|
|
884
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
885
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updatePerson(id, UpdatePersonRequest);
|
|
886
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
887
|
+
});
|
|
888
|
+
},
|
|
715
889
|
};
|
|
716
890
|
};
|
|
717
891
|
/**
|
|
@@ -731,6 +905,9 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
731
905
|
addPerson(requestParameters = {}) {
|
|
732
906
|
return localVarFp.addPerson(requestParameters.AddPersonRequest).then((request) => request(axios, basePath));
|
|
733
907
|
},
|
|
908
|
+
addPersonWithHttpInfo(requestParameters = {}) {
|
|
909
|
+
return localVarFp.addPersonWithHttpInfo(requestParameters.AddPersonRequest).then((request) => request(axios, basePath));
|
|
910
|
+
},
|
|
734
911
|
/**
|
|
735
912
|
* Adds a user as a follower to the person.
|
|
736
913
|
* @summary Add a follower to a person
|
|
@@ -741,6 +918,9 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
741
918
|
addPersonFollower(requestParameters) {
|
|
742
919
|
return localVarFp.addPersonFollower(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(axios, basePath));
|
|
743
920
|
},
|
|
921
|
+
addPersonFollowerWithHttpInfo(requestParameters) {
|
|
922
|
+
return localVarFp.addPersonFollowerWithHttpInfo(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(axios, basePath));
|
|
923
|
+
},
|
|
744
924
|
/**
|
|
745
925
|
* Marks a person as deleted. After 30 days, the person will be permanently deleted.
|
|
746
926
|
* @summary Delete a person
|
|
@@ -751,6 +931,9 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
751
931
|
deletePerson(requestParameters) {
|
|
752
932
|
return localVarFp.deletePerson(requestParameters.id).then((request) => request(axios, basePath));
|
|
753
933
|
},
|
|
934
|
+
deletePersonWithHttpInfo(requestParameters) {
|
|
935
|
+
return localVarFp.deletePersonWithHttpInfo(requestParameters.id).then((request) => request(axios, basePath));
|
|
936
|
+
},
|
|
754
937
|
/**
|
|
755
938
|
* Deletes a user follower from the person.
|
|
756
939
|
* @summary Delete a follower from a person
|
|
@@ -761,6 +944,9 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
761
944
|
deletePersonFollower(requestParameters) {
|
|
762
945
|
return localVarFp.deletePersonFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(axios, basePath));
|
|
763
946
|
},
|
|
947
|
+
deletePersonFollowerWithHttpInfo(requestParameters) {
|
|
948
|
+
return localVarFp.deletePersonFollowerWithHttpInfo(requestParameters.id, requestParameters.follower_id).then((request) => request(axios, basePath));
|
|
949
|
+
},
|
|
764
950
|
/**
|
|
765
951
|
* 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.
|
|
766
952
|
* @summary Get details of a person
|
|
@@ -771,6 +957,9 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
771
957
|
getPerson(requestParameters) {
|
|
772
958
|
return localVarFp.getPerson(requestParameters.id, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.include_option_labels, requestParameters.include_labels).then((request) => request(axios, basePath));
|
|
773
959
|
},
|
|
960
|
+
getPersonWithHttpInfo(requestParameters) {
|
|
961
|
+
return localVarFp.getPersonWithHttpInfo(requestParameters.id, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.include_option_labels, requestParameters.include_labels).then((request) => request(axios, basePath));
|
|
962
|
+
},
|
|
774
963
|
/**
|
|
775
964
|
* Lists users who are following the person.
|
|
776
965
|
* @summary List followers of a person
|
|
@@ -781,6 +970,9 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
781
970
|
getPersonFollowers(requestParameters) {
|
|
782
971
|
return localVarFp.getPersonFollowers(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
|
783
972
|
},
|
|
973
|
+
getPersonFollowersWithHttpInfo(requestParameters) {
|
|
974
|
+
return localVarFp.getPersonFollowersWithHttpInfo(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
|
975
|
+
},
|
|
784
976
|
/**
|
|
785
977
|
* Lists changelogs about users have followed the person.
|
|
786
978
|
* @summary List followers changelog of a person
|
|
@@ -791,6 +983,9 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
791
983
|
getPersonFollowersChangelog(requestParameters) {
|
|
792
984
|
return localVarFp.getPersonFollowersChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
|
793
985
|
},
|
|
986
|
+
getPersonFollowersChangelogWithHttpInfo(requestParameters) {
|
|
987
|
+
return localVarFp.getPersonFollowersChangelogWithHttpInfo(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
|
988
|
+
},
|
|
794
989
|
/**
|
|
795
990
|
* Returns the picture associated with a person. The picture URLs include both 128x128 and 512x512 pixel versions.
|
|
796
991
|
* @summary Get picture of a person
|
|
@@ -801,6 +996,9 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
801
996
|
getPersonPicture(requestParameters) {
|
|
802
997
|
return localVarFp.getPersonPicture(requestParameters.id).then((request) => request(axios, basePath));
|
|
803
998
|
},
|
|
999
|
+
getPersonPictureWithHttpInfo(requestParameters) {
|
|
1000
|
+
return localVarFp.getPersonPictureWithHttpInfo(requestParameters.id).then((request) => request(axios, basePath));
|
|
1001
|
+
},
|
|
804
1002
|
/**
|
|
805
1003
|
* 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.
|
|
806
1004
|
* @summary Get all persons
|
|
@@ -811,6 +1009,9 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
811
1009
|
getPersons(requestParameters = {}) {
|
|
812
1010
|
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));
|
|
813
1011
|
},
|
|
1012
|
+
getPersonsWithHttpInfo(requestParameters = {}) {
|
|
1013
|
+
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));
|
|
1014
|
+
},
|
|
814
1015
|
/**
|
|
815
1016
|
* 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.
|
|
816
1017
|
* @summary Search persons
|
|
@@ -821,6 +1022,9 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
821
1022
|
searchPersons(requestParameters) {
|
|
822
1023
|
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));
|
|
823
1024
|
},
|
|
1025
|
+
searchPersonsWithHttpInfo(requestParameters) {
|
|
1026
|
+
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));
|
|
1027
|
+
},
|
|
824
1028
|
/**
|
|
825
1029
|
* 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.
|
|
826
1030
|
* @summary Update a person
|
|
@@ -831,6 +1035,9 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
831
1035
|
updatePerson(requestParameters) {
|
|
832
1036
|
return localVarFp.updatePerson(requestParameters.id, requestParameters.UpdatePersonRequest).then((request) => request(axios, basePath));
|
|
833
1037
|
},
|
|
1038
|
+
updatePersonWithHttpInfo(requestParameters) {
|
|
1039
|
+
return localVarFp.updatePersonWithHttpInfo(requestParameters.id, requestParameters.UpdatePersonRequest).then((request) => request(axios, basePath));
|
|
1040
|
+
},
|
|
834
1041
|
};
|
|
835
1042
|
};
|
|
836
1043
|
/**
|
|
@@ -851,6 +1058,17 @@ export class PersonsApi extends BaseAPI {
|
|
|
851
1058
|
addPerson(requestParameters = {}) {
|
|
852
1059
|
return PersonsApiFp(this.configuration).addPerson(requestParameters.AddPersonRequest).then((request) => request(this.axios, this.basePath));
|
|
853
1060
|
}
|
|
1061
|
+
/**
|
|
1062
|
+
* Same as `addPerson`, but resolves with the response body together with the HTTP status and headers.
|
|
1063
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1064
|
+
* @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
|
|
1065
|
+
|
|
1066
|
+
* @throws {RequiredError}
|
|
1067
|
+
* @memberof PersonsApi
|
|
1068
|
+
*/
|
|
1069
|
+
addPersonWithHttpInfo(requestParameters = {}) {
|
|
1070
|
+
return PersonsApiFp(this.configuration).addPersonWithHttpInfo(requestParameters.AddPersonRequest).then((request) => request(this.axios, this.basePath));
|
|
1071
|
+
}
|
|
854
1072
|
/**
|
|
855
1073
|
* Adds a user as a follower to the person.
|
|
856
1074
|
* @summary Add a follower to a person
|
|
@@ -862,6 +1080,17 @@ export class PersonsApi extends BaseAPI {
|
|
|
862
1080
|
addPersonFollower(requestParameters) {
|
|
863
1081
|
return PersonsApiFp(this.configuration).addPersonFollower(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(this.axios, this.basePath));
|
|
864
1082
|
}
|
|
1083
|
+
/**
|
|
1084
|
+
* Same as `addPersonFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
1085
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1086
|
+
* @param {PersonsApiAddPersonFollowerRequest} requestParameters Request parameters.
|
|
1087
|
+
|
|
1088
|
+
* @throws {RequiredError}
|
|
1089
|
+
* @memberof PersonsApi
|
|
1090
|
+
*/
|
|
1091
|
+
addPersonFollowerWithHttpInfo(requestParameters) {
|
|
1092
|
+
return PersonsApiFp(this.configuration).addPersonFollowerWithHttpInfo(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(this.axios, this.basePath));
|
|
1093
|
+
}
|
|
865
1094
|
/**
|
|
866
1095
|
* Marks a person as deleted. After 30 days, the person will be permanently deleted.
|
|
867
1096
|
* @summary Delete a person
|
|
@@ -873,6 +1102,17 @@ export class PersonsApi extends BaseAPI {
|
|
|
873
1102
|
deletePerson(requestParameters) {
|
|
874
1103
|
return PersonsApiFp(this.configuration).deletePerson(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
875
1104
|
}
|
|
1105
|
+
/**
|
|
1106
|
+
* Same as `deletePerson`, but resolves with the response body together with the HTTP status and headers.
|
|
1107
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1108
|
+
* @param {PersonsApiDeletePersonRequest} requestParameters Request parameters.
|
|
1109
|
+
|
|
1110
|
+
* @throws {RequiredError}
|
|
1111
|
+
* @memberof PersonsApi
|
|
1112
|
+
*/
|
|
1113
|
+
deletePersonWithHttpInfo(requestParameters) {
|
|
1114
|
+
return PersonsApiFp(this.configuration).deletePersonWithHttpInfo(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
1115
|
+
}
|
|
876
1116
|
/**
|
|
877
1117
|
* Deletes a user follower from the person.
|
|
878
1118
|
* @summary Delete a follower from a person
|
|
@@ -884,6 +1124,17 @@ export class PersonsApi extends BaseAPI {
|
|
|
884
1124
|
deletePersonFollower(requestParameters) {
|
|
885
1125
|
return PersonsApiFp(this.configuration).deletePersonFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(this.axios, this.basePath));
|
|
886
1126
|
}
|
|
1127
|
+
/**
|
|
1128
|
+
* Same as `deletePersonFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
1129
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1130
|
+
* @param {PersonsApiDeletePersonFollowerRequest} requestParameters Request parameters.
|
|
1131
|
+
|
|
1132
|
+
* @throws {RequiredError}
|
|
1133
|
+
* @memberof PersonsApi
|
|
1134
|
+
*/
|
|
1135
|
+
deletePersonFollowerWithHttpInfo(requestParameters) {
|
|
1136
|
+
return PersonsApiFp(this.configuration).deletePersonFollowerWithHttpInfo(requestParameters.id, requestParameters.follower_id).then((request) => request(this.axios, this.basePath));
|
|
1137
|
+
}
|
|
887
1138
|
/**
|
|
888
1139
|
* 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.
|
|
889
1140
|
* @summary Get details of a person
|
|
@@ -895,6 +1146,17 @@ export class PersonsApi extends BaseAPI {
|
|
|
895
1146
|
getPerson(requestParameters) {
|
|
896
1147
|
return 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));
|
|
897
1148
|
}
|
|
1149
|
+
/**
|
|
1150
|
+
* Same as `getPerson`, but resolves with the response body together with the HTTP status and headers.
|
|
1151
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1152
|
+
* @param {PersonsApiGetPersonRequest} requestParameters Request parameters.
|
|
1153
|
+
|
|
1154
|
+
* @throws {RequiredError}
|
|
1155
|
+
* @memberof PersonsApi
|
|
1156
|
+
*/
|
|
1157
|
+
getPersonWithHttpInfo(requestParameters) {
|
|
1158
|
+
return 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));
|
|
1159
|
+
}
|
|
898
1160
|
/**
|
|
899
1161
|
* Lists users who are following the person.
|
|
900
1162
|
* @summary List followers of a person
|
|
@@ -906,6 +1168,17 @@ export class PersonsApi extends BaseAPI {
|
|
|
906
1168
|
getPersonFollowers(requestParameters) {
|
|
907
1169
|
return PersonsApiFp(this.configuration).getPersonFollowers(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
|
908
1170
|
}
|
|
1171
|
+
/**
|
|
1172
|
+
* Same as `getPersonFollowers`, but resolves with the response body together with the HTTP status and headers.
|
|
1173
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1174
|
+
* @param {PersonsApiGetPersonFollowersRequest} requestParameters Request parameters.
|
|
1175
|
+
|
|
1176
|
+
* @throws {RequiredError}
|
|
1177
|
+
* @memberof PersonsApi
|
|
1178
|
+
*/
|
|
1179
|
+
getPersonFollowersWithHttpInfo(requestParameters) {
|
|
1180
|
+
return PersonsApiFp(this.configuration).getPersonFollowersWithHttpInfo(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
|
1181
|
+
}
|
|
909
1182
|
/**
|
|
910
1183
|
* Lists changelogs about users have followed the person.
|
|
911
1184
|
* @summary List followers changelog of a person
|
|
@@ -917,6 +1190,17 @@ export class PersonsApi extends BaseAPI {
|
|
|
917
1190
|
getPersonFollowersChangelog(requestParameters) {
|
|
918
1191
|
return PersonsApiFp(this.configuration).getPersonFollowersChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
|
919
1192
|
}
|
|
1193
|
+
/**
|
|
1194
|
+
* Same as `getPersonFollowersChangelog`, but resolves with the response body together with the HTTP status and headers.
|
|
1195
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1196
|
+
* @param {PersonsApiGetPersonFollowersChangelogRequest} requestParameters Request parameters.
|
|
1197
|
+
|
|
1198
|
+
* @throws {RequiredError}
|
|
1199
|
+
* @memberof PersonsApi
|
|
1200
|
+
*/
|
|
1201
|
+
getPersonFollowersChangelogWithHttpInfo(requestParameters) {
|
|
1202
|
+
return PersonsApiFp(this.configuration).getPersonFollowersChangelogWithHttpInfo(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
|
1203
|
+
}
|
|
920
1204
|
/**
|
|
921
1205
|
* Returns the picture associated with a person. The picture URLs include both 128x128 and 512x512 pixel versions.
|
|
922
1206
|
* @summary Get picture of a person
|
|
@@ -928,6 +1212,17 @@ export class PersonsApi extends BaseAPI {
|
|
|
928
1212
|
getPersonPicture(requestParameters) {
|
|
929
1213
|
return PersonsApiFp(this.configuration).getPersonPicture(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
930
1214
|
}
|
|
1215
|
+
/**
|
|
1216
|
+
* Same as `getPersonPicture`, but resolves with the response body together with the HTTP status and headers.
|
|
1217
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1218
|
+
* @param {PersonsApiGetPersonPictureRequest} requestParameters Request parameters.
|
|
1219
|
+
|
|
1220
|
+
* @throws {RequiredError}
|
|
1221
|
+
* @memberof PersonsApi
|
|
1222
|
+
*/
|
|
1223
|
+
getPersonPictureWithHttpInfo(requestParameters) {
|
|
1224
|
+
return PersonsApiFp(this.configuration).getPersonPictureWithHttpInfo(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
1225
|
+
}
|
|
931
1226
|
/**
|
|
932
1227
|
* 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.
|
|
933
1228
|
* @summary Get all persons
|
|
@@ -939,6 +1234,17 @@ export class PersonsApi extends BaseAPI {
|
|
|
939
1234
|
getPersons(requestParameters = {}) {
|
|
940
1235
|
return 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));
|
|
941
1236
|
}
|
|
1237
|
+
/**
|
|
1238
|
+
* Same as `getPersons`, but resolves with the response body together with the HTTP status and headers.
|
|
1239
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1240
|
+
* @param {PersonsApiGetPersonsRequest} requestParameters Request parameters.
|
|
1241
|
+
|
|
1242
|
+
* @throws {RequiredError}
|
|
1243
|
+
* @memberof PersonsApi
|
|
1244
|
+
*/
|
|
1245
|
+
getPersonsWithHttpInfo(requestParameters = {}) {
|
|
1246
|
+
return 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));
|
|
1247
|
+
}
|
|
942
1248
|
/**
|
|
943
1249
|
* 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.
|
|
944
1250
|
* @summary Search persons
|
|
@@ -950,6 +1256,17 @@ export class PersonsApi extends BaseAPI {
|
|
|
950
1256
|
searchPersons(requestParameters) {
|
|
951
1257
|
return 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));
|
|
952
1258
|
}
|
|
1259
|
+
/**
|
|
1260
|
+
* Same as `searchPersons`, but resolves with the response body together with the HTTP status and headers.
|
|
1261
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1262
|
+
* @param {PersonsApiSearchPersonsRequest} requestParameters Request parameters.
|
|
1263
|
+
|
|
1264
|
+
* @throws {RequiredError}
|
|
1265
|
+
* @memberof PersonsApi
|
|
1266
|
+
*/
|
|
1267
|
+
searchPersonsWithHttpInfo(requestParameters) {
|
|
1268
|
+
return 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));
|
|
1269
|
+
}
|
|
953
1270
|
/**
|
|
954
1271
|
* 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.
|
|
955
1272
|
* @summary Update a person
|
|
@@ -961,4 +1278,15 @@ export class PersonsApi extends BaseAPI {
|
|
|
961
1278
|
updatePerson(requestParameters) {
|
|
962
1279
|
return PersonsApiFp(this.configuration).updatePerson(requestParameters.id, requestParameters.UpdatePersonRequest).then((request) => request(this.axios, this.basePath));
|
|
963
1280
|
}
|
|
1281
|
+
/**
|
|
1282
|
+
* Same as `updatePerson`, but resolves with the response body together with the HTTP status and headers.
|
|
1283
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1284
|
+
* @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters.
|
|
1285
|
+
|
|
1286
|
+
* @throws {RequiredError}
|
|
1287
|
+
* @memberof PersonsApi
|
|
1288
|
+
*/
|
|
1289
|
+
updatePersonWithHttpInfo(requestParameters) {
|
|
1290
|
+
return PersonsApiFp(this.configuration).updatePersonWithHttpInfo(requestParameters.id, requestParameters.UpdatePersonRequest).then((request) => request(this.axios, this.basePath));
|
|
1291
|
+
}
|
|
964
1292
|
}
|