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
|
@@ -417,6 +417,19 @@ const LeadsApiFp = function (configuration) {
|
|
|
417
417
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
418
418
|
});
|
|
419
419
|
},
|
|
420
|
+
/**
|
|
421
|
+
* Same as `addLead`, but resolves with the response body together with the HTTP status and headers.
|
|
422
|
+
* @summary Add a lead
|
|
423
|
+
* @param {AddLeadRequest} [AddLeadRequest]
|
|
424
|
+
|
|
425
|
+
* @throws {RequiredError}
|
|
426
|
+
*/
|
|
427
|
+
addLeadWithHttpInfo(AddLeadRequest) {
|
|
428
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
429
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.addLead(AddLeadRequest);
|
|
430
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
431
|
+
});
|
|
432
|
+
},
|
|
420
433
|
/**
|
|
421
434
|
* Deletes a specific lead.
|
|
422
435
|
* @summary Delete a lead
|
|
@@ -430,6 +443,19 @@ const LeadsApiFp = function (configuration) {
|
|
|
430
443
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
431
444
|
});
|
|
432
445
|
},
|
|
446
|
+
/**
|
|
447
|
+
* Same as `deleteLead`, but resolves with the response body together with the HTTP status and headers.
|
|
448
|
+
* @summary Delete a lead
|
|
449
|
+
* @param {string} id The ID of the lead
|
|
450
|
+
|
|
451
|
+
* @throws {RequiredError}
|
|
452
|
+
*/
|
|
453
|
+
deleteLeadWithHttpInfo(id) {
|
|
454
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
455
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteLead(id);
|
|
456
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
457
|
+
});
|
|
458
|
+
},
|
|
433
459
|
/**
|
|
434
460
|
* Returns multiple archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
|
|
435
461
|
* @summary Get all archived leads
|
|
@@ -449,6 +475,25 @@ const LeadsApiFp = function (configuration) {
|
|
|
449
475
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
450
476
|
});
|
|
451
477
|
},
|
|
478
|
+
/**
|
|
479
|
+
* Same as `getArchivedLeads`, but resolves with the response body together with the HTTP status and headers.
|
|
480
|
+
* @summary Get all archived leads
|
|
481
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
|
|
482
|
+
* @param {number} [start] For pagination, the position that represents the first result for the page
|
|
483
|
+
* @param {number} [owner_id] If supplied, only leads matching the given user will be returned. However, `filter_id` takes precedence over `owner_id` when supplied.
|
|
484
|
+
* @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
|
|
485
|
+
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
|
486
|
+
* @param {number} [filter_id] The ID of the filter to use
|
|
487
|
+
* @param {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
|
488
|
+
|
|
489
|
+
* @throws {RequiredError}
|
|
490
|
+
*/
|
|
491
|
+
getArchivedLeadsWithHttpInfo(limit, start, owner_id, person_id, organization_id, filter_id, sort) {
|
|
492
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
493
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getArchivedLeads(limit, start, owner_id, person_id, organization_id, filter_id, sort);
|
|
494
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
495
|
+
});
|
|
496
|
+
},
|
|
452
497
|
/**
|
|
453
498
|
* Returns details of a specific lead. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals.
|
|
454
499
|
* @summary Get one lead
|
|
@@ -462,6 +507,19 @@ const LeadsApiFp = function (configuration) {
|
|
|
462
507
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
463
508
|
});
|
|
464
509
|
},
|
|
510
|
+
/**
|
|
511
|
+
* Same as `getLead`, but resolves with the response body together with the HTTP status and headers.
|
|
512
|
+
* @summary Get one lead
|
|
513
|
+
* @param {string} id The ID of the lead
|
|
514
|
+
|
|
515
|
+
* @throws {RequiredError}
|
|
516
|
+
*/
|
|
517
|
+
getLeadWithHttpInfo(id) {
|
|
518
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
519
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getLead(id);
|
|
520
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
521
|
+
});
|
|
522
|
+
},
|
|
465
523
|
/**
|
|
466
524
|
* Lists the users permitted to access a lead.
|
|
467
525
|
* @summary List permitted users
|
|
@@ -475,6 +533,19 @@ const LeadsApiFp = function (configuration) {
|
|
|
475
533
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
476
534
|
});
|
|
477
535
|
},
|
|
536
|
+
/**
|
|
537
|
+
* Same as `getLeadUsers`, but resolves with the response body together with the HTTP status and headers.
|
|
538
|
+
* @summary List permitted users
|
|
539
|
+
* @param {string} id The ID of the lead
|
|
540
|
+
|
|
541
|
+
* @throws {RequiredError}
|
|
542
|
+
*/
|
|
543
|
+
getLeadUsersWithHttpInfo(id) {
|
|
544
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
545
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getLeadUsers(id);
|
|
546
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
547
|
+
});
|
|
548
|
+
},
|
|
478
549
|
/**
|
|
479
550
|
* Returns multiple not archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
|
|
480
551
|
* @summary Get all leads
|
|
@@ -495,6 +566,26 @@ const LeadsApiFp = function (configuration) {
|
|
|
495
566
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
496
567
|
});
|
|
497
568
|
},
|
|
569
|
+
/**
|
|
570
|
+
* Same as `getLeads`, but resolves with the response body together with the HTTP status and headers.
|
|
571
|
+
* @summary Get all leads
|
|
572
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
|
|
573
|
+
* @param {number} [start] For pagination, the position that represents the first result for the page
|
|
574
|
+
* @param {number} [owner_id] If supplied, only leads matching the given user will be returned. However, `filter_id` takes precedence over `owner_id` when supplied.
|
|
575
|
+
* @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
|
|
576
|
+
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
|
577
|
+
* @param {number} [filter_id] The ID of the filter to use
|
|
578
|
+
* @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
579
|
+
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id, title, owner_id, creator_id, label_ids, value, source_name, was_seen, expected_close_date, next_activity_id, add_time, update_time, visible_to, and custom fields.
|
|
580
|
+
|
|
581
|
+
* @throws {RequiredError}
|
|
582
|
+
*/
|
|
583
|
+
getLeadsWithHttpInfo(limit, start, owner_id, person_id, organization_id, filter_id, updated_since, sort) {
|
|
584
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
585
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getLeads(limit, start, owner_id, person_id, organization_id, filter_id, updated_since, sort);
|
|
586
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
587
|
+
});
|
|
588
|
+
},
|
|
498
589
|
/**
|
|
499
590
|
* Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
|
|
500
591
|
* @summary Search leads
|
|
@@ -515,6 +606,26 @@ const LeadsApiFp = function (configuration) {
|
|
|
515
606
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
516
607
|
});
|
|
517
608
|
},
|
|
609
|
+
/**
|
|
610
|
+
* Same as `searchLeads`, but resolves with the response body together with the HTTP status and headers.
|
|
611
|
+
* @summary Search leads
|
|
612
|
+
* @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.
|
|
613
|
+
* @param {Set<'custom_fields' | 'notes' | 'title'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
614
|
+
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
615
|
+
* @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
|
|
616
|
+
* @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
|
|
617
|
+
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
618
|
+
* @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
|
|
619
|
+
* @param {number} [limit] Items shown per page
|
|
620
|
+
|
|
621
|
+
* @throws {RequiredError}
|
|
622
|
+
*/
|
|
623
|
+
searchLeadsWithHttpInfo(term, fields, exact_match, person_id, organization_id, include_fields, start, limit) {
|
|
624
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
625
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.searchLeads(term, fields, exact_match, person_id, organization_id, include_fields, start, limit);
|
|
626
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
627
|
+
});
|
|
628
|
+
},
|
|
518
629
|
/**
|
|
519
630
|
* Updates one or more properties of a lead. Only properties included in the request will be updated. Send `null` to unset a property (applicable for example for `value`, `person_id` or `organization_id`). If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals. See an example given in the <a href=\"https://pipedrive.readme.io/docs/updating-custom-field-value\" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields’ values tutorial</a>.
|
|
520
631
|
* @summary Update a lead
|
|
@@ -529,6 +640,20 @@ const LeadsApiFp = function (configuration) {
|
|
|
529
640
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
530
641
|
});
|
|
531
642
|
},
|
|
643
|
+
/**
|
|
644
|
+
* Same as `updateLead`, but resolves with the response body together with the HTTP status and headers.
|
|
645
|
+
* @summary Update a lead
|
|
646
|
+
* @param {string} id The ID of the lead
|
|
647
|
+
* @param {UpdateLeadRequest} [UpdateLeadRequest]
|
|
648
|
+
|
|
649
|
+
* @throws {RequiredError}
|
|
650
|
+
*/
|
|
651
|
+
updateLeadWithHttpInfo(id, UpdateLeadRequest) {
|
|
652
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
653
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateLead(id, UpdateLeadRequest);
|
|
654
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
655
|
+
});
|
|
656
|
+
},
|
|
532
657
|
};
|
|
533
658
|
};
|
|
534
659
|
exports.LeadsApiFp = LeadsApiFp;
|
|
@@ -549,6 +674,9 @@ const LeadsApiFactory = function (configuration, basePath, axios) {
|
|
|
549
674
|
addLead(requestParameters = {}) {
|
|
550
675
|
return localVarFp.addLead(requestParameters.AddLeadRequest).then((request) => request(axios, basePath));
|
|
551
676
|
},
|
|
677
|
+
addLeadWithHttpInfo(requestParameters = {}) {
|
|
678
|
+
return localVarFp.addLeadWithHttpInfo(requestParameters.AddLeadRequest).then((request) => request(axios, basePath));
|
|
679
|
+
},
|
|
552
680
|
/**
|
|
553
681
|
* Deletes a specific lead.
|
|
554
682
|
* @summary Delete a lead
|
|
@@ -559,6 +687,9 @@ const LeadsApiFactory = function (configuration, basePath, axios) {
|
|
|
559
687
|
deleteLead(requestParameters) {
|
|
560
688
|
return localVarFp.deleteLead(requestParameters.id).then((request) => request(axios, basePath));
|
|
561
689
|
},
|
|
690
|
+
deleteLeadWithHttpInfo(requestParameters) {
|
|
691
|
+
return localVarFp.deleteLeadWithHttpInfo(requestParameters.id).then((request) => request(axios, basePath));
|
|
692
|
+
},
|
|
562
693
|
/**
|
|
563
694
|
* Returns multiple archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
|
|
564
695
|
* @summary Get all archived leads
|
|
@@ -569,6 +700,9 @@ const LeadsApiFactory = function (configuration, basePath, axios) {
|
|
|
569
700
|
getArchivedLeads(requestParameters = {}) {
|
|
570
701
|
return localVarFp.getArchivedLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(axios, basePath));
|
|
571
702
|
},
|
|
703
|
+
getArchivedLeadsWithHttpInfo(requestParameters = {}) {
|
|
704
|
+
return localVarFp.getArchivedLeadsWithHttpInfo(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(axios, basePath));
|
|
705
|
+
},
|
|
572
706
|
/**
|
|
573
707
|
* Returns details of a specific lead. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals.
|
|
574
708
|
* @summary Get one lead
|
|
@@ -579,6 +713,9 @@ const LeadsApiFactory = function (configuration, basePath, axios) {
|
|
|
579
713
|
getLead(requestParameters) {
|
|
580
714
|
return localVarFp.getLead(requestParameters.id).then((request) => request(axios, basePath));
|
|
581
715
|
},
|
|
716
|
+
getLeadWithHttpInfo(requestParameters) {
|
|
717
|
+
return localVarFp.getLeadWithHttpInfo(requestParameters.id).then((request) => request(axios, basePath));
|
|
718
|
+
},
|
|
582
719
|
/**
|
|
583
720
|
* Lists the users permitted to access a lead.
|
|
584
721
|
* @summary List permitted users
|
|
@@ -589,6 +726,9 @@ const LeadsApiFactory = function (configuration, basePath, axios) {
|
|
|
589
726
|
getLeadUsers(requestParameters) {
|
|
590
727
|
return localVarFp.getLeadUsers(requestParameters.id).then((request) => request(axios, basePath));
|
|
591
728
|
},
|
|
729
|
+
getLeadUsersWithHttpInfo(requestParameters) {
|
|
730
|
+
return localVarFp.getLeadUsersWithHttpInfo(requestParameters.id).then((request) => request(axios, basePath));
|
|
731
|
+
},
|
|
592
732
|
/**
|
|
593
733
|
* Returns multiple not archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
|
|
594
734
|
* @summary Get all leads
|
|
@@ -599,6 +739,9 @@ const LeadsApiFactory = function (configuration, basePath, axios) {
|
|
|
599
739
|
getLeads(requestParameters = {}) {
|
|
600
740
|
return localVarFp.getLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.updated_since, requestParameters.sort).then((request) => request(axios, basePath));
|
|
601
741
|
},
|
|
742
|
+
getLeadsWithHttpInfo(requestParameters = {}) {
|
|
743
|
+
return localVarFp.getLeadsWithHttpInfo(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.updated_since, requestParameters.sort).then((request) => request(axios, basePath));
|
|
744
|
+
},
|
|
602
745
|
/**
|
|
603
746
|
* Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
|
|
604
747
|
* @summary Search leads
|
|
@@ -609,6 +752,9 @@ const LeadsApiFactory = function (configuration, basePath, axios) {
|
|
|
609
752
|
searchLeads(requestParameters) {
|
|
610
753
|
return localVarFp.searchLeads(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.person_id, requestParameters.organization_id, requestParameters.include_fields, requestParameters.start, requestParameters.limit).then((request) => request(axios, basePath));
|
|
611
754
|
},
|
|
755
|
+
searchLeadsWithHttpInfo(requestParameters) {
|
|
756
|
+
return localVarFp.searchLeadsWithHttpInfo(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.person_id, requestParameters.organization_id, requestParameters.include_fields, requestParameters.start, requestParameters.limit).then((request) => request(axios, basePath));
|
|
757
|
+
},
|
|
612
758
|
/**
|
|
613
759
|
* Updates one or more properties of a lead. Only properties included in the request will be updated. Send `null` to unset a property (applicable for example for `value`, `person_id` or `organization_id`). If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals. See an example given in the <a href=\"https://pipedrive.readme.io/docs/updating-custom-field-value\" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields’ values tutorial</a>.
|
|
614
760
|
* @summary Update a lead
|
|
@@ -619,6 +765,9 @@ const LeadsApiFactory = function (configuration, basePath, axios) {
|
|
|
619
765
|
updateLead(requestParameters) {
|
|
620
766
|
return localVarFp.updateLead(requestParameters.id, requestParameters.UpdateLeadRequest).then((request) => request(axios, basePath));
|
|
621
767
|
},
|
|
768
|
+
updateLeadWithHttpInfo(requestParameters) {
|
|
769
|
+
return localVarFp.updateLeadWithHttpInfo(requestParameters.id, requestParameters.UpdateLeadRequest).then((request) => request(axios, basePath));
|
|
770
|
+
},
|
|
622
771
|
};
|
|
623
772
|
};
|
|
624
773
|
exports.LeadsApiFactory = LeadsApiFactory;
|
|
@@ -640,6 +789,17 @@ class LeadsApi extends base_1.BaseAPI {
|
|
|
640
789
|
addLead(requestParameters = {}) {
|
|
641
790
|
return (0, exports.LeadsApiFp)(this.configuration).addLead(requestParameters.AddLeadRequest).then((request) => request(this.axios, this.basePath));
|
|
642
791
|
}
|
|
792
|
+
/**
|
|
793
|
+
* Same as `addLead`, but resolves with the response body together with the HTTP status and headers.
|
|
794
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
795
|
+
* @param {LeadsApiAddLeadRequest} requestParameters Request parameters.
|
|
796
|
+
|
|
797
|
+
* @throws {RequiredError}
|
|
798
|
+
* @memberof LeadsApi
|
|
799
|
+
*/
|
|
800
|
+
addLeadWithHttpInfo(requestParameters = {}) {
|
|
801
|
+
return (0, exports.LeadsApiFp)(this.configuration).addLeadWithHttpInfo(requestParameters.AddLeadRequest).then((request) => request(this.axios, this.basePath));
|
|
802
|
+
}
|
|
643
803
|
/**
|
|
644
804
|
* Deletes a specific lead.
|
|
645
805
|
* @summary Delete a lead
|
|
@@ -651,6 +811,17 @@ class LeadsApi extends base_1.BaseAPI {
|
|
|
651
811
|
deleteLead(requestParameters) {
|
|
652
812
|
return (0, exports.LeadsApiFp)(this.configuration).deleteLead(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
653
813
|
}
|
|
814
|
+
/**
|
|
815
|
+
* Same as `deleteLead`, but resolves with the response body together with the HTTP status and headers.
|
|
816
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
817
|
+
* @param {LeadsApiDeleteLeadRequest} requestParameters Request parameters.
|
|
818
|
+
|
|
819
|
+
* @throws {RequiredError}
|
|
820
|
+
* @memberof LeadsApi
|
|
821
|
+
*/
|
|
822
|
+
deleteLeadWithHttpInfo(requestParameters) {
|
|
823
|
+
return (0, exports.LeadsApiFp)(this.configuration).deleteLeadWithHttpInfo(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
824
|
+
}
|
|
654
825
|
/**
|
|
655
826
|
* Returns multiple archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
|
|
656
827
|
* @summary Get all archived leads
|
|
@@ -662,6 +833,17 @@ class LeadsApi extends base_1.BaseAPI {
|
|
|
662
833
|
getArchivedLeads(requestParameters = {}) {
|
|
663
834
|
return (0, exports.LeadsApiFp)(this.configuration).getArchivedLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(this.axios, this.basePath));
|
|
664
835
|
}
|
|
836
|
+
/**
|
|
837
|
+
* Same as `getArchivedLeads`, but resolves with the response body together with the HTTP status and headers.
|
|
838
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
839
|
+
* @param {LeadsApiGetArchivedLeadsRequest} requestParameters Request parameters.
|
|
840
|
+
|
|
841
|
+
* @throws {RequiredError}
|
|
842
|
+
* @memberof LeadsApi
|
|
843
|
+
*/
|
|
844
|
+
getArchivedLeadsWithHttpInfo(requestParameters = {}) {
|
|
845
|
+
return (0, exports.LeadsApiFp)(this.configuration).getArchivedLeadsWithHttpInfo(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(this.axios, this.basePath));
|
|
846
|
+
}
|
|
665
847
|
/**
|
|
666
848
|
* Returns details of a specific lead. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals.
|
|
667
849
|
* @summary Get one lead
|
|
@@ -673,6 +855,17 @@ class LeadsApi extends base_1.BaseAPI {
|
|
|
673
855
|
getLead(requestParameters) {
|
|
674
856
|
return (0, exports.LeadsApiFp)(this.configuration).getLead(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
675
857
|
}
|
|
858
|
+
/**
|
|
859
|
+
* Same as `getLead`, but resolves with the response body together with the HTTP status and headers.
|
|
860
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
861
|
+
* @param {LeadsApiGetLeadRequest} requestParameters Request parameters.
|
|
862
|
+
|
|
863
|
+
* @throws {RequiredError}
|
|
864
|
+
* @memberof LeadsApi
|
|
865
|
+
*/
|
|
866
|
+
getLeadWithHttpInfo(requestParameters) {
|
|
867
|
+
return (0, exports.LeadsApiFp)(this.configuration).getLeadWithHttpInfo(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
868
|
+
}
|
|
676
869
|
/**
|
|
677
870
|
* Lists the users permitted to access a lead.
|
|
678
871
|
* @summary List permitted users
|
|
@@ -684,6 +877,17 @@ class LeadsApi extends base_1.BaseAPI {
|
|
|
684
877
|
getLeadUsers(requestParameters) {
|
|
685
878
|
return (0, exports.LeadsApiFp)(this.configuration).getLeadUsers(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
686
879
|
}
|
|
880
|
+
/**
|
|
881
|
+
* Same as `getLeadUsers`, but resolves with the response body together with the HTTP status and headers.
|
|
882
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
883
|
+
* @param {LeadsApiGetLeadUsersRequest} requestParameters Request parameters.
|
|
884
|
+
|
|
885
|
+
* @throws {RequiredError}
|
|
886
|
+
* @memberof LeadsApi
|
|
887
|
+
*/
|
|
888
|
+
getLeadUsersWithHttpInfo(requestParameters) {
|
|
889
|
+
return (0, exports.LeadsApiFp)(this.configuration).getLeadUsersWithHttpInfo(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
890
|
+
}
|
|
687
891
|
/**
|
|
688
892
|
* Returns multiple not archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
|
|
689
893
|
* @summary Get all leads
|
|
@@ -695,6 +899,17 @@ class LeadsApi extends base_1.BaseAPI {
|
|
|
695
899
|
getLeads(requestParameters = {}) {
|
|
696
900
|
return (0, exports.LeadsApiFp)(this.configuration).getLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.updated_since, requestParameters.sort).then((request) => request(this.axios, this.basePath));
|
|
697
901
|
}
|
|
902
|
+
/**
|
|
903
|
+
* Same as `getLeads`, but resolves with the response body together with the HTTP status and headers.
|
|
904
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
905
|
+
* @param {LeadsApiGetLeadsRequest} requestParameters Request parameters.
|
|
906
|
+
|
|
907
|
+
* @throws {RequiredError}
|
|
908
|
+
* @memberof LeadsApi
|
|
909
|
+
*/
|
|
910
|
+
getLeadsWithHttpInfo(requestParameters = {}) {
|
|
911
|
+
return (0, exports.LeadsApiFp)(this.configuration).getLeadsWithHttpInfo(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.updated_since, requestParameters.sort).then((request) => request(this.axios, this.basePath));
|
|
912
|
+
}
|
|
698
913
|
/**
|
|
699
914
|
* Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
|
|
700
915
|
* @summary Search leads
|
|
@@ -706,6 +921,17 @@ class LeadsApi extends base_1.BaseAPI {
|
|
|
706
921
|
searchLeads(requestParameters) {
|
|
707
922
|
return (0, exports.LeadsApiFp)(this.configuration).searchLeads(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.person_id, requestParameters.organization_id, requestParameters.include_fields, requestParameters.start, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
|
708
923
|
}
|
|
924
|
+
/**
|
|
925
|
+
* Same as `searchLeads`, but resolves with the response body together with the HTTP status and headers.
|
|
926
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
927
|
+
* @param {LeadsApiSearchLeadsRequest} requestParameters Request parameters.
|
|
928
|
+
|
|
929
|
+
* @throws {RequiredError}
|
|
930
|
+
* @memberof LeadsApi
|
|
931
|
+
*/
|
|
932
|
+
searchLeadsWithHttpInfo(requestParameters) {
|
|
933
|
+
return (0, exports.LeadsApiFp)(this.configuration).searchLeadsWithHttpInfo(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.person_id, requestParameters.organization_id, requestParameters.include_fields, requestParameters.start, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
|
934
|
+
}
|
|
709
935
|
/**
|
|
710
936
|
* Updates one or more properties of a lead. Only properties included in the request will be updated. Send `null` to unset a property (applicable for example for `value`, `person_id` or `organization_id`). If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals. See an example given in the <a href=\"https://pipedrive.readme.io/docs/updating-custom-field-value\" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields’ values tutorial</a>.
|
|
711
937
|
* @summary Update a lead
|
|
@@ -717,5 +943,16 @@ class LeadsApi extends base_1.BaseAPI {
|
|
|
717
943
|
updateLead(requestParameters) {
|
|
718
944
|
return (0, exports.LeadsApiFp)(this.configuration).updateLead(requestParameters.id, requestParameters.UpdateLeadRequest).then((request) => request(this.axios, this.basePath));
|
|
719
945
|
}
|
|
946
|
+
/**
|
|
947
|
+
* Same as `updateLead`, but resolves with the response body together with the HTTP status and headers.
|
|
948
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
949
|
+
* @param {LeadsApiUpdateLeadRequest} requestParameters Request parameters.
|
|
950
|
+
|
|
951
|
+
* @throws {RequiredError}
|
|
952
|
+
* @memberof LeadsApi
|
|
953
|
+
*/
|
|
954
|
+
updateLeadWithHttpInfo(requestParameters) {
|
|
955
|
+
return (0, exports.LeadsApiFp)(this.configuration).updateLeadWithHttpInfo(requestParameters.id, requestParameters.UpdateLeadRequest).then((request) => request(this.axios, this.basePath));
|
|
956
|
+
}
|
|
720
957
|
}
|
|
721
958
|
exports.LeadsApi = LeadsApi;
|