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
|
@@ -188,6 +188,19 @@ export const LeadLabelsApiFp = function (configuration) {
|
|
|
188
188
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
189
189
|
});
|
|
190
190
|
},
|
|
191
|
+
/**
|
|
192
|
+
* Same as `addLeadLabel`, but resolves with the response body together with the HTTP status and headers.
|
|
193
|
+
* @summary Add a lead label
|
|
194
|
+
* @param {AddLeadLabelRequest} [AddLeadLabelRequest]
|
|
195
|
+
|
|
196
|
+
* @throws {RequiredError}
|
|
197
|
+
*/
|
|
198
|
+
addLeadLabelWithHttpInfo(AddLeadLabelRequest) {
|
|
199
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
200
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.addLeadLabel(AddLeadLabelRequest);
|
|
201
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
202
|
+
});
|
|
203
|
+
},
|
|
191
204
|
/**
|
|
192
205
|
* Deletes a specific lead label.
|
|
193
206
|
* @summary Delete a lead label
|
|
@@ -201,6 +214,19 @@ export const LeadLabelsApiFp = function (configuration) {
|
|
|
201
214
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
202
215
|
});
|
|
203
216
|
},
|
|
217
|
+
/**
|
|
218
|
+
* Same as `deleteLeadLabel`, but resolves with the response body together with the HTTP status and headers.
|
|
219
|
+
* @summary Delete a lead label
|
|
220
|
+
* @param {string} id The ID of the lead label
|
|
221
|
+
|
|
222
|
+
* @throws {RequiredError}
|
|
223
|
+
*/
|
|
224
|
+
deleteLeadLabelWithHttpInfo(id) {
|
|
225
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
226
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteLeadLabel(id);
|
|
227
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
228
|
+
});
|
|
229
|
+
},
|
|
204
230
|
/**
|
|
205
231
|
* Returns details of all lead labels. This endpoint does not support pagination and all labels are always returned.
|
|
206
232
|
* @summary Get all lead labels
|
|
@@ -213,6 +239,18 @@ export const LeadLabelsApiFp = function (configuration) {
|
|
|
213
239
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
214
240
|
});
|
|
215
241
|
},
|
|
242
|
+
/**
|
|
243
|
+
* Same as `getLeadLabels`, but resolves with the response body together with the HTTP status and headers.
|
|
244
|
+
* @summary Get all lead labels
|
|
245
|
+
|
|
246
|
+
* @throws {RequiredError}
|
|
247
|
+
*/
|
|
248
|
+
getLeadLabelsWithHttpInfo() {
|
|
249
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
250
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getLeadLabels();
|
|
251
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
252
|
+
});
|
|
253
|
+
},
|
|
216
254
|
/**
|
|
217
255
|
* Updates one or more properties of a lead label. Only properties included in the request will be updated.
|
|
218
256
|
* @summary Update a lead label
|
|
@@ -227,6 +265,20 @@ export const LeadLabelsApiFp = function (configuration) {
|
|
|
227
265
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
228
266
|
});
|
|
229
267
|
},
|
|
268
|
+
/**
|
|
269
|
+
* Same as `updateLeadLabel`, but resolves with the response body together with the HTTP status and headers.
|
|
270
|
+
* @summary Update a lead label
|
|
271
|
+
* @param {string} id The ID of the lead label
|
|
272
|
+
* @param {UpdateLeadLabelRequest} [UpdateLeadLabelRequest]
|
|
273
|
+
|
|
274
|
+
* @throws {RequiredError}
|
|
275
|
+
*/
|
|
276
|
+
updateLeadLabelWithHttpInfo(id, UpdateLeadLabelRequest) {
|
|
277
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
278
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateLeadLabel(id, UpdateLeadLabelRequest);
|
|
279
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
280
|
+
});
|
|
281
|
+
},
|
|
230
282
|
};
|
|
231
283
|
};
|
|
232
284
|
/**
|
|
@@ -246,6 +298,9 @@ export const LeadLabelsApiFactory = function (configuration, basePath, axios) {
|
|
|
246
298
|
addLeadLabel(requestParameters = {}) {
|
|
247
299
|
return localVarFp.addLeadLabel(requestParameters.AddLeadLabelRequest).then((request) => request(axios, basePath));
|
|
248
300
|
},
|
|
301
|
+
addLeadLabelWithHttpInfo(requestParameters = {}) {
|
|
302
|
+
return localVarFp.addLeadLabelWithHttpInfo(requestParameters.AddLeadLabelRequest).then((request) => request(axios, basePath));
|
|
303
|
+
},
|
|
249
304
|
/**
|
|
250
305
|
* Deletes a specific lead label.
|
|
251
306
|
* @summary Delete a lead label
|
|
@@ -256,6 +311,9 @@ export const LeadLabelsApiFactory = function (configuration, basePath, axios) {
|
|
|
256
311
|
deleteLeadLabel(requestParameters) {
|
|
257
312
|
return localVarFp.deleteLeadLabel(requestParameters.id).then((request) => request(axios, basePath));
|
|
258
313
|
},
|
|
314
|
+
deleteLeadLabelWithHttpInfo(requestParameters) {
|
|
315
|
+
return localVarFp.deleteLeadLabelWithHttpInfo(requestParameters.id).then((request) => request(axios, basePath));
|
|
316
|
+
},
|
|
259
317
|
/**
|
|
260
318
|
* Returns details of all lead labels. This endpoint does not support pagination and all labels are always returned.
|
|
261
319
|
* @summary Get all lead labels
|
|
@@ -265,6 +323,9 @@ export const LeadLabelsApiFactory = function (configuration, basePath, axios) {
|
|
|
265
323
|
getLeadLabels() {
|
|
266
324
|
return localVarFp.getLeadLabels().then((request) => request(axios, basePath));
|
|
267
325
|
},
|
|
326
|
+
getLeadLabelsWithHttpInfo() {
|
|
327
|
+
return localVarFp.getLeadLabelsWithHttpInfo().then((request) => request(axios, basePath));
|
|
328
|
+
},
|
|
268
329
|
/**
|
|
269
330
|
* Updates one or more properties of a lead label. Only properties included in the request will be updated.
|
|
270
331
|
* @summary Update a lead label
|
|
@@ -275,6 +336,9 @@ export const LeadLabelsApiFactory = function (configuration, basePath, axios) {
|
|
|
275
336
|
updateLeadLabel(requestParameters) {
|
|
276
337
|
return localVarFp.updateLeadLabel(requestParameters.id, requestParameters.UpdateLeadLabelRequest).then((request) => request(axios, basePath));
|
|
277
338
|
},
|
|
339
|
+
updateLeadLabelWithHttpInfo(requestParameters) {
|
|
340
|
+
return localVarFp.updateLeadLabelWithHttpInfo(requestParameters.id, requestParameters.UpdateLeadLabelRequest).then((request) => request(axios, basePath));
|
|
341
|
+
},
|
|
278
342
|
};
|
|
279
343
|
};
|
|
280
344
|
/**
|
|
@@ -295,6 +359,17 @@ export class LeadLabelsApi extends BaseAPI {
|
|
|
295
359
|
addLeadLabel(requestParameters = {}) {
|
|
296
360
|
return LeadLabelsApiFp(this.configuration).addLeadLabel(requestParameters.AddLeadLabelRequest).then((request) => request(this.axios, this.basePath));
|
|
297
361
|
}
|
|
362
|
+
/**
|
|
363
|
+
* Same as `addLeadLabel`, but resolves with the response body together with the HTTP status and headers.
|
|
364
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
365
|
+
* @param {LeadLabelsApiAddLeadLabelRequest} requestParameters Request parameters.
|
|
366
|
+
|
|
367
|
+
* @throws {RequiredError}
|
|
368
|
+
* @memberof LeadLabelsApi
|
|
369
|
+
*/
|
|
370
|
+
addLeadLabelWithHttpInfo(requestParameters = {}) {
|
|
371
|
+
return LeadLabelsApiFp(this.configuration).addLeadLabelWithHttpInfo(requestParameters.AddLeadLabelRequest).then((request) => request(this.axios, this.basePath));
|
|
372
|
+
}
|
|
298
373
|
/**
|
|
299
374
|
* Deletes a specific lead label.
|
|
300
375
|
* @summary Delete a lead label
|
|
@@ -306,6 +381,17 @@ export class LeadLabelsApi extends BaseAPI {
|
|
|
306
381
|
deleteLeadLabel(requestParameters) {
|
|
307
382
|
return LeadLabelsApiFp(this.configuration).deleteLeadLabel(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
308
383
|
}
|
|
384
|
+
/**
|
|
385
|
+
* Same as `deleteLeadLabel`, but resolves with the response body together with the HTTP status and headers.
|
|
386
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
387
|
+
* @param {LeadLabelsApiDeleteLeadLabelRequest} requestParameters Request parameters.
|
|
388
|
+
|
|
389
|
+
* @throws {RequiredError}
|
|
390
|
+
* @memberof LeadLabelsApi
|
|
391
|
+
*/
|
|
392
|
+
deleteLeadLabelWithHttpInfo(requestParameters) {
|
|
393
|
+
return LeadLabelsApiFp(this.configuration).deleteLeadLabelWithHttpInfo(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
394
|
+
}
|
|
309
395
|
/**
|
|
310
396
|
* Returns details of all lead labels. This endpoint does not support pagination and all labels are always returned.
|
|
311
397
|
* @summary Get all lead labels
|
|
@@ -316,6 +402,16 @@ export class LeadLabelsApi extends BaseAPI {
|
|
|
316
402
|
getLeadLabels() {
|
|
317
403
|
return LeadLabelsApiFp(this.configuration).getLeadLabels().then((request) => request(this.axios, this.basePath));
|
|
318
404
|
}
|
|
405
|
+
/**
|
|
406
|
+
* Same as `getLeadLabels`, but resolves with the response body together with the HTTP status and headers.
|
|
407
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
408
|
+
|
|
409
|
+
* @throws {RequiredError}
|
|
410
|
+
* @memberof LeadLabelsApi
|
|
411
|
+
*/
|
|
412
|
+
getLeadLabelsWithHttpInfo() {
|
|
413
|
+
return LeadLabelsApiFp(this.configuration).getLeadLabelsWithHttpInfo().then((request) => request(this.axios, this.basePath));
|
|
414
|
+
}
|
|
319
415
|
/**
|
|
320
416
|
* Updates one or more properties of a lead label. Only properties included in the request will be updated.
|
|
321
417
|
* @summary Update a lead label
|
|
@@ -327,4 +423,15 @@ export class LeadLabelsApi extends BaseAPI {
|
|
|
327
423
|
updateLeadLabel(requestParameters) {
|
|
328
424
|
return LeadLabelsApiFp(this.configuration).updateLeadLabel(requestParameters.id, requestParameters.UpdateLeadLabelRequest).then((request) => request(this.axios, this.basePath));
|
|
329
425
|
}
|
|
426
|
+
/**
|
|
427
|
+
* Same as `updateLeadLabel`, but resolves with the response body together with the HTTP status and headers.
|
|
428
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
429
|
+
* @param {LeadLabelsApiUpdateLeadLabelRequest} requestParameters Request parameters.
|
|
430
|
+
|
|
431
|
+
* @throws {RequiredError}
|
|
432
|
+
* @memberof LeadLabelsApi
|
|
433
|
+
*/
|
|
434
|
+
updateLeadLabelWithHttpInfo(requestParameters) {
|
|
435
|
+
return LeadLabelsApiFp(this.configuration).updateLeadLabelWithHttpInfo(requestParameters.id, requestParameters.UpdateLeadLabelRequest).then((request) => request(this.axios, this.basePath));
|
|
436
|
+
}
|
|
330
437
|
}
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { Configuration } from '../configuration';
|
|
13
13
|
import type { AxiosInstance } from 'axios';
|
|
14
|
-
import { RequestArgs, BaseAPI } from '../base';
|
|
14
|
+
import { RequestArgs, BaseAPI, ApiResponse } from '../base';
|
|
15
15
|
import { GetLeadsSourceResponse } from '../models';
|
|
16
16
|
/**
|
|
17
17
|
* LeadSourcesApi - axios parameter creator
|
|
@@ -38,6 +38,13 @@ export declare const LeadSourcesApiFp: (configuration?: Configuration) => {
|
|
|
38
38
|
* @throws {RequiredError}
|
|
39
39
|
*/
|
|
40
40
|
getLeadSources(): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadsSourceResponse>>;
|
|
41
|
+
/**
|
|
42
|
+
* Same as `getLeadSources`, but resolves with the response body together with the HTTP status and headers.
|
|
43
|
+
* @summary Get all lead sources
|
|
44
|
+
|
|
45
|
+
* @throws {RequiredError}
|
|
46
|
+
*/
|
|
47
|
+
getLeadSourcesWithHttpInfo(): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetLeadsSourceResponse>>>;
|
|
41
48
|
};
|
|
42
49
|
/**
|
|
43
50
|
* LeadSourcesApi - factory interface
|
|
@@ -51,6 +58,7 @@ export declare const LeadSourcesApiFactory: (configuration?: Configuration, base
|
|
|
51
58
|
* @throws {RequiredError}
|
|
52
59
|
*/
|
|
53
60
|
getLeadSources(): Promise<GetLeadsSourceResponse>;
|
|
61
|
+
getLeadSourcesWithHttpInfo(): Promise<ApiResponse<GetLeadsSourceResponse>>;
|
|
54
62
|
};
|
|
55
63
|
/**
|
|
56
64
|
* LeadSourcesApi - object-oriented interface
|
|
@@ -67,4 +75,12 @@ export declare class LeadSourcesApi extends BaseAPI {
|
|
|
67
75
|
* @memberof LeadSourcesApi
|
|
68
76
|
*/
|
|
69
77
|
getLeadSources(): Promise<GetLeadsSourceResponse>;
|
|
78
|
+
/**
|
|
79
|
+
* Same as `getLeadSources`, but resolves with the response body together with the HTTP status and headers.
|
|
80
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
81
|
+
|
|
82
|
+
* @throws {RequiredError}
|
|
83
|
+
* @memberof LeadSourcesApi
|
|
84
|
+
*/
|
|
85
|
+
getLeadSourcesWithHttpInfo(): Promise<ApiResponse<GetLeadsSourceResponse>>;
|
|
70
86
|
}
|
|
@@ -83,6 +83,18 @@ export const LeadSourcesApiFp = function (configuration) {
|
|
|
83
83
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
84
84
|
});
|
|
85
85
|
},
|
|
86
|
+
/**
|
|
87
|
+
* Same as `getLeadSources`, but resolves with the response body together with the HTTP status and headers.
|
|
88
|
+
* @summary Get all lead sources
|
|
89
|
+
|
|
90
|
+
* @throws {RequiredError}
|
|
91
|
+
*/
|
|
92
|
+
getLeadSourcesWithHttpInfo() {
|
|
93
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
94
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getLeadSources();
|
|
95
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
96
|
+
});
|
|
97
|
+
},
|
|
86
98
|
};
|
|
87
99
|
};
|
|
88
100
|
/**
|
|
@@ -101,6 +113,9 @@ export const LeadSourcesApiFactory = function (configuration, basePath, axios) {
|
|
|
101
113
|
getLeadSources() {
|
|
102
114
|
return localVarFp.getLeadSources().then((request) => request(axios, basePath));
|
|
103
115
|
},
|
|
116
|
+
getLeadSourcesWithHttpInfo() {
|
|
117
|
+
return localVarFp.getLeadSourcesWithHttpInfo().then((request) => request(axios, basePath));
|
|
118
|
+
},
|
|
104
119
|
};
|
|
105
120
|
};
|
|
106
121
|
/**
|
|
@@ -120,4 +135,14 @@ export class LeadSourcesApi extends BaseAPI {
|
|
|
120
135
|
getLeadSources() {
|
|
121
136
|
return LeadSourcesApiFp(this.configuration).getLeadSources().then((request) => request(this.axios, this.basePath));
|
|
122
137
|
}
|
|
138
|
+
/**
|
|
139
|
+
* Same as `getLeadSources`, but resolves with the response body together with the HTTP status and headers.
|
|
140
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
141
|
+
|
|
142
|
+
* @throws {RequiredError}
|
|
143
|
+
* @memberof LeadSourcesApi
|
|
144
|
+
*/
|
|
145
|
+
getLeadSourcesWithHttpInfo() {
|
|
146
|
+
return LeadSourcesApiFp(this.configuration).getLeadSourcesWithHttpInfo().then((request) => request(this.axios, this.basePath));
|
|
147
|
+
}
|
|
123
148
|
}
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { Configuration } from '../configuration';
|
|
13
13
|
import type { AxiosInstance } from 'axios';
|
|
14
|
-
import { RequestArgs, BaseAPI } from '../base';
|
|
14
|
+
import { RequestArgs, BaseAPI, ApiResponse } from '../base';
|
|
15
15
|
import { AddLeadRequest } from '../models';
|
|
16
16
|
import { GetLeadIdResponse } from '../models';
|
|
17
17
|
import { GetLeadResponse } from '../models';
|
|
@@ -123,6 +123,14 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
|
|
|
123
123
|
* @throws {RequiredError}
|
|
124
124
|
*/
|
|
125
125
|
addLead(AddLeadRequest?: AddLeadRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadResponse>>;
|
|
126
|
+
/**
|
|
127
|
+
* Same as `addLead`, but resolves with the response body together with the HTTP status and headers.
|
|
128
|
+
* @summary Add a lead
|
|
129
|
+
* @param {AddLeadRequest} [AddLeadRequest]
|
|
130
|
+
|
|
131
|
+
* @throws {RequiredError}
|
|
132
|
+
*/
|
|
133
|
+
addLeadWithHttpInfo(AddLeadRequest?: AddLeadRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetLeadResponse>>>;
|
|
126
134
|
/**
|
|
127
135
|
* Deletes a specific lead.
|
|
128
136
|
* @summary Delete a lead
|
|
@@ -131,6 +139,14 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
|
|
|
131
139
|
* @throws {RequiredError}
|
|
132
140
|
*/
|
|
133
141
|
deleteLead(id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadIdResponse>>;
|
|
142
|
+
/**
|
|
143
|
+
* Same as `deleteLead`, but resolves with the response body together with the HTTP status and headers.
|
|
144
|
+
* @summary Delete a lead
|
|
145
|
+
* @param {string} id The ID of the lead
|
|
146
|
+
|
|
147
|
+
* @throws {RequiredError}
|
|
148
|
+
*/
|
|
149
|
+
deleteLeadWithHttpInfo(id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetLeadIdResponse>>>;
|
|
134
150
|
/**
|
|
135
151
|
* 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.
|
|
136
152
|
* @summary Get all archived leads
|
|
@@ -145,6 +161,20 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
|
|
|
145
161
|
* @throws {RequiredError}
|
|
146
162
|
*/
|
|
147
163
|
getArchivedLeads(limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, sort?: 'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadsResponse>>;
|
|
164
|
+
/**
|
|
165
|
+
* Same as `getArchivedLeads`, but resolves with the response body together with the HTTP status and headers.
|
|
166
|
+
* @summary Get all archived leads
|
|
167
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
|
|
168
|
+
* @param {number} [start] For pagination, the position that represents the first result for the page
|
|
169
|
+
* @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.
|
|
170
|
+
* @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.
|
|
171
|
+
* @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.
|
|
172
|
+
* @param {number} [filter_id] The ID of the filter to use
|
|
173
|
+
* @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).
|
|
174
|
+
|
|
175
|
+
* @throws {RequiredError}
|
|
176
|
+
*/
|
|
177
|
+
getArchivedLeadsWithHttpInfo(limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, sort?: 'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetLeadsResponse>>>;
|
|
148
178
|
/**
|
|
149
179
|
* 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.
|
|
150
180
|
* @summary Get one lead
|
|
@@ -153,6 +183,14 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
|
|
|
153
183
|
* @throws {RequiredError}
|
|
154
184
|
*/
|
|
155
185
|
getLead(id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadResponse>>;
|
|
186
|
+
/**
|
|
187
|
+
* Same as `getLead`, but resolves with the response body together with the HTTP status and headers.
|
|
188
|
+
* @summary Get one lead
|
|
189
|
+
* @param {string} id The ID of the lead
|
|
190
|
+
|
|
191
|
+
* @throws {RequiredError}
|
|
192
|
+
*/
|
|
193
|
+
getLeadWithHttpInfo(id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetLeadResponse>>>;
|
|
156
194
|
/**
|
|
157
195
|
* Lists the users permitted to access a lead.
|
|
158
196
|
* @summary List permitted users
|
|
@@ -161,6 +199,14 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
|
|
|
161
199
|
* @throws {RequiredError}
|
|
162
200
|
*/
|
|
163
201
|
getLeadUsers(id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UserIds>>;
|
|
202
|
+
/**
|
|
203
|
+
* Same as `getLeadUsers`, but resolves with the response body together with the HTTP status and headers.
|
|
204
|
+
* @summary List permitted users
|
|
205
|
+
* @param {string} id The ID of the lead
|
|
206
|
+
|
|
207
|
+
* @throws {RequiredError}
|
|
208
|
+
*/
|
|
209
|
+
getLeadUsersWithHttpInfo(id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<UserIds>>>;
|
|
164
210
|
/**
|
|
165
211
|
* 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.
|
|
166
212
|
* @summary Get all leads
|
|
@@ -176,6 +222,21 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
|
|
|
176
222
|
* @throws {RequiredError}
|
|
177
223
|
*/
|
|
178
224
|
getLeads(limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, updated_since?: string, sort?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadsResponse>>;
|
|
225
|
+
/**
|
|
226
|
+
* Same as `getLeads`, but resolves with the response body together with the HTTP status and headers.
|
|
227
|
+
* @summary Get all leads
|
|
228
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
|
|
229
|
+
* @param {number} [start] For pagination, the position that represents the first result for the page
|
|
230
|
+
* @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.
|
|
231
|
+
* @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.
|
|
232
|
+
* @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.
|
|
233
|
+
* @param {number} [filter_id] The ID of the filter to use
|
|
234
|
+
* @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.
|
|
235
|
+
* @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.
|
|
236
|
+
|
|
237
|
+
* @throws {RequiredError}
|
|
238
|
+
*/
|
|
239
|
+
getLeadsWithHttpInfo(limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, updated_since?: string, sort?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetLeadsResponse>>>;
|
|
179
240
|
/**
|
|
180
241
|
* 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.
|
|
181
242
|
* @summary Search leads
|
|
@@ -191,6 +252,21 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
|
|
|
191
252
|
* @throws {RequiredError}
|
|
192
253
|
*/
|
|
193
254
|
searchLeads(term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, include_fields?: Set<'lead.was_seen'>, start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadSearchResponse>>;
|
|
255
|
+
/**
|
|
256
|
+
* Same as `searchLeads`, but resolves with the response body together with the HTTP status and headers.
|
|
257
|
+
* @summary Search leads
|
|
258
|
+
* @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.
|
|
259
|
+
* @param {Set<'custom_fields' | 'notes' | 'title'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
260
|
+
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
261
|
+
* @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
|
|
262
|
+
* @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
|
|
263
|
+
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
264
|
+
* @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.
|
|
265
|
+
* @param {number} [limit] Items shown per page
|
|
266
|
+
|
|
267
|
+
* @throws {RequiredError}
|
|
268
|
+
*/
|
|
269
|
+
searchLeadsWithHttpInfo(term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, include_fields?: Set<'lead.was_seen'>, start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetLeadSearchResponse>>>;
|
|
194
270
|
/**
|
|
195
271
|
* 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>.
|
|
196
272
|
* @summary Update a lead
|
|
@@ -200,6 +276,15 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
|
|
|
200
276
|
* @throws {RequiredError}
|
|
201
277
|
*/
|
|
202
278
|
updateLead(id: string, UpdateLeadRequest?: UpdateLeadRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadResponse>>;
|
|
279
|
+
/**
|
|
280
|
+
* Same as `updateLead`, but resolves with the response body together with the HTTP status and headers.
|
|
281
|
+
* @summary Update a lead
|
|
282
|
+
* @param {string} id The ID of the lead
|
|
283
|
+
* @param {UpdateLeadRequest} [UpdateLeadRequest]
|
|
284
|
+
|
|
285
|
+
* @throws {RequiredError}
|
|
286
|
+
*/
|
|
287
|
+
updateLeadWithHttpInfo(id: string, UpdateLeadRequest?: UpdateLeadRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetLeadResponse>>>;
|
|
203
288
|
};
|
|
204
289
|
/**
|
|
205
290
|
* LeadsApi - factory interface
|
|
@@ -214,6 +299,7 @@ export declare const LeadsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
214
299
|
* @throws {RequiredError}
|
|
215
300
|
*/
|
|
216
301
|
addLead(requestParameters?: LeadsApiAddLeadRequest): Promise<GetLeadResponse>;
|
|
302
|
+
addLeadWithHttpInfo(requestParameters?: LeadsApiAddLeadRequest): Promise<ApiResponse<GetLeadResponse>>;
|
|
217
303
|
/**
|
|
218
304
|
* Deletes a specific lead.
|
|
219
305
|
* @summary Delete a lead
|
|
@@ -222,6 +308,7 @@ export declare const LeadsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
222
308
|
* @throws {RequiredError}
|
|
223
309
|
*/
|
|
224
310
|
deleteLead(requestParameters: LeadsApiDeleteLeadRequest): Promise<GetLeadIdResponse>;
|
|
311
|
+
deleteLeadWithHttpInfo(requestParameters: LeadsApiDeleteLeadRequest): Promise<ApiResponse<GetLeadIdResponse>>;
|
|
225
312
|
/**
|
|
226
313
|
* 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.
|
|
227
314
|
* @summary Get all archived leads
|
|
@@ -230,6 +317,7 @@ export declare const LeadsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
230
317
|
* @throws {RequiredError}
|
|
231
318
|
*/
|
|
232
319
|
getArchivedLeads(requestParameters?: LeadsApiGetArchivedLeadsRequest): Promise<GetLeadsResponse>;
|
|
320
|
+
getArchivedLeadsWithHttpInfo(requestParameters?: LeadsApiGetArchivedLeadsRequest): Promise<ApiResponse<GetLeadsResponse>>;
|
|
233
321
|
/**
|
|
234
322
|
* 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.
|
|
235
323
|
* @summary Get one lead
|
|
@@ -238,6 +326,7 @@ export declare const LeadsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
238
326
|
* @throws {RequiredError}
|
|
239
327
|
*/
|
|
240
328
|
getLead(requestParameters: LeadsApiGetLeadRequest): Promise<GetLeadResponse>;
|
|
329
|
+
getLeadWithHttpInfo(requestParameters: LeadsApiGetLeadRequest): Promise<ApiResponse<GetLeadResponse>>;
|
|
241
330
|
/**
|
|
242
331
|
* Lists the users permitted to access a lead.
|
|
243
332
|
* @summary List permitted users
|
|
@@ -246,6 +335,7 @@ export declare const LeadsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
246
335
|
* @throws {RequiredError}
|
|
247
336
|
*/
|
|
248
337
|
getLeadUsers(requestParameters: LeadsApiGetLeadUsersRequest): Promise<UserIds>;
|
|
338
|
+
getLeadUsersWithHttpInfo(requestParameters: LeadsApiGetLeadUsersRequest): Promise<ApiResponse<UserIds>>;
|
|
249
339
|
/**
|
|
250
340
|
* 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.
|
|
251
341
|
* @summary Get all leads
|
|
@@ -254,6 +344,7 @@ export declare const LeadsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
254
344
|
* @throws {RequiredError}
|
|
255
345
|
*/
|
|
256
346
|
getLeads(requestParameters?: LeadsApiGetLeadsRequest): Promise<GetLeadsResponse>;
|
|
347
|
+
getLeadsWithHttpInfo(requestParameters?: LeadsApiGetLeadsRequest): Promise<ApiResponse<GetLeadsResponse>>;
|
|
257
348
|
/**
|
|
258
349
|
* 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.
|
|
259
350
|
* @summary Search leads
|
|
@@ -262,6 +353,7 @@ export declare const LeadsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
262
353
|
* @throws {RequiredError}
|
|
263
354
|
*/
|
|
264
355
|
searchLeads(requestParameters: LeadsApiSearchLeadsRequest): Promise<GetLeadSearchResponse>;
|
|
356
|
+
searchLeadsWithHttpInfo(requestParameters: LeadsApiSearchLeadsRequest): Promise<ApiResponse<GetLeadSearchResponse>>;
|
|
265
357
|
/**
|
|
266
358
|
* 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>.
|
|
267
359
|
* @summary Update a lead
|
|
@@ -270,6 +362,7 @@ export declare const LeadsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
270
362
|
* @throws {RequiredError}
|
|
271
363
|
*/
|
|
272
364
|
updateLead(requestParameters: LeadsApiUpdateLeadRequest): Promise<GetLeadResponse>;
|
|
365
|
+
updateLeadWithHttpInfo(requestParameters: LeadsApiUpdateLeadRequest): Promise<ApiResponse<GetLeadResponse>>;
|
|
273
366
|
};
|
|
274
367
|
/**
|
|
275
368
|
* Request parameters for addLead operation in LeadsApi.
|
|
@@ -517,6 +610,15 @@ export declare class LeadsApi extends BaseAPI {
|
|
|
517
610
|
* @memberof LeadsApi
|
|
518
611
|
*/
|
|
519
612
|
addLead(requestParameters?: LeadsApiAddLeadRequest): Promise<GetLeadResponse>;
|
|
613
|
+
/**
|
|
614
|
+
* Same as `addLead`, but resolves with the response body together with the HTTP status and headers.
|
|
615
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
616
|
+
* @param {LeadsApiAddLeadRequest} requestParameters Request parameters.
|
|
617
|
+
|
|
618
|
+
* @throws {RequiredError}
|
|
619
|
+
* @memberof LeadsApi
|
|
620
|
+
*/
|
|
621
|
+
addLeadWithHttpInfo(requestParameters?: LeadsApiAddLeadRequest): Promise<ApiResponse<GetLeadResponse>>;
|
|
520
622
|
/**
|
|
521
623
|
* Deletes a specific lead.
|
|
522
624
|
* @summary Delete a lead
|
|
@@ -526,6 +628,15 @@ export declare class LeadsApi extends BaseAPI {
|
|
|
526
628
|
* @memberof LeadsApi
|
|
527
629
|
*/
|
|
528
630
|
deleteLead(requestParameters: LeadsApiDeleteLeadRequest): Promise<GetLeadIdResponse>;
|
|
631
|
+
/**
|
|
632
|
+
* Same as `deleteLead`, but resolves with the response body together with the HTTP status and headers.
|
|
633
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
634
|
+
* @param {LeadsApiDeleteLeadRequest} requestParameters Request parameters.
|
|
635
|
+
|
|
636
|
+
* @throws {RequiredError}
|
|
637
|
+
* @memberof LeadsApi
|
|
638
|
+
*/
|
|
639
|
+
deleteLeadWithHttpInfo(requestParameters: LeadsApiDeleteLeadRequest): Promise<ApiResponse<GetLeadIdResponse>>;
|
|
529
640
|
/**
|
|
530
641
|
* Returns multiple archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
|
|
531
642
|
* @summary Get all archived leads
|
|
@@ -535,6 +646,15 @@ export declare class LeadsApi extends BaseAPI {
|
|
|
535
646
|
* @memberof LeadsApi
|
|
536
647
|
*/
|
|
537
648
|
getArchivedLeads(requestParameters?: LeadsApiGetArchivedLeadsRequest): Promise<GetLeadsResponse>;
|
|
649
|
+
/**
|
|
650
|
+
* Same as `getArchivedLeads`, but resolves with the response body together with the HTTP status and headers.
|
|
651
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
652
|
+
* @param {LeadsApiGetArchivedLeadsRequest} requestParameters Request parameters.
|
|
653
|
+
|
|
654
|
+
* @throws {RequiredError}
|
|
655
|
+
* @memberof LeadsApi
|
|
656
|
+
*/
|
|
657
|
+
getArchivedLeadsWithHttpInfo(requestParameters?: LeadsApiGetArchivedLeadsRequest): Promise<ApiResponse<GetLeadsResponse>>;
|
|
538
658
|
/**
|
|
539
659
|
* 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.
|
|
540
660
|
* @summary Get one lead
|
|
@@ -544,6 +664,15 @@ export declare class LeadsApi extends BaseAPI {
|
|
|
544
664
|
* @memberof LeadsApi
|
|
545
665
|
*/
|
|
546
666
|
getLead(requestParameters: LeadsApiGetLeadRequest): Promise<GetLeadResponse>;
|
|
667
|
+
/**
|
|
668
|
+
* Same as `getLead`, but resolves with the response body together with the HTTP status and headers.
|
|
669
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
670
|
+
* @param {LeadsApiGetLeadRequest} requestParameters Request parameters.
|
|
671
|
+
|
|
672
|
+
* @throws {RequiredError}
|
|
673
|
+
* @memberof LeadsApi
|
|
674
|
+
*/
|
|
675
|
+
getLeadWithHttpInfo(requestParameters: LeadsApiGetLeadRequest): Promise<ApiResponse<GetLeadResponse>>;
|
|
547
676
|
/**
|
|
548
677
|
* Lists the users permitted to access a lead.
|
|
549
678
|
* @summary List permitted users
|
|
@@ -553,6 +682,15 @@ export declare class LeadsApi extends BaseAPI {
|
|
|
553
682
|
* @memberof LeadsApi
|
|
554
683
|
*/
|
|
555
684
|
getLeadUsers(requestParameters: LeadsApiGetLeadUsersRequest): Promise<UserIds>;
|
|
685
|
+
/**
|
|
686
|
+
* Same as `getLeadUsers`, but resolves with the response body together with the HTTP status and headers.
|
|
687
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
688
|
+
* @param {LeadsApiGetLeadUsersRequest} requestParameters Request parameters.
|
|
689
|
+
|
|
690
|
+
* @throws {RequiredError}
|
|
691
|
+
* @memberof LeadsApi
|
|
692
|
+
*/
|
|
693
|
+
getLeadUsersWithHttpInfo(requestParameters: LeadsApiGetLeadUsersRequest): Promise<ApiResponse<UserIds>>;
|
|
556
694
|
/**
|
|
557
695
|
* 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.
|
|
558
696
|
* @summary Get all leads
|
|
@@ -562,6 +700,15 @@ export declare class LeadsApi extends BaseAPI {
|
|
|
562
700
|
* @memberof LeadsApi
|
|
563
701
|
*/
|
|
564
702
|
getLeads(requestParameters?: LeadsApiGetLeadsRequest): Promise<GetLeadsResponse>;
|
|
703
|
+
/**
|
|
704
|
+
* Same as `getLeads`, but resolves with the response body together with the HTTP status and headers.
|
|
705
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
706
|
+
* @param {LeadsApiGetLeadsRequest} requestParameters Request parameters.
|
|
707
|
+
|
|
708
|
+
* @throws {RequiredError}
|
|
709
|
+
* @memberof LeadsApi
|
|
710
|
+
*/
|
|
711
|
+
getLeadsWithHttpInfo(requestParameters?: LeadsApiGetLeadsRequest): Promise<ApiResponse<GetLeadsResponse>>;
|
|
565
712
|
/**
|
|
566
713
|
* 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.
|
|
567
714
|
* @summary Search leads
|
|
@@ -571,6 +718,15 @@ export declare class LeadsApi extends BaseAPI {
|
|
|
571
718
|
* @memberof LeadsApi
|
|
572
719
|
*/
|
|
573
720
|
searchLeads(requestParameters: LeadsApiSearchLeadsRequest): Promise<GetLeadSearchResponse>;
|
|
721
|
+
/**
|
|
722
|
+
* Same as `searchLeads`, but resolves with the response body together with the HTTP status and headers.
|
|
723
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
724
|
+
* @param {LeadsApiSearchLeadsRequest} requestParameters Request parameters.
|
|
725
|
+
|
|
726
|
+
* @throws {RequiredError}
|
|
727
|
+
* @memberof LeadsApi
|
|
728
|
+
*/
|
|
729
|
+
searchLeadsWithHttpInfo(requestParameters: LeadsApiSearchLeadsRequest): Promise<ApiResponse<GetLeadSearchResponse>>;
|
|
574
730
|
/**
|
|
575
731
|
* 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>.
|
|
576
732
|
* @summary Update a lead
|
|
@@ -580,4 +736,13 @@ export declare class LeadsApi extends BaseAPI {
|
|
|
580
736
|
* @memberof LeadsApi
|
|
581
737
|
*/
|
|
582
738
|
updateLead(requestParameters: LeadsApiUpdateLeadRequest): Promise<GetLeadResponse>;
|
|
739
|
+
/**
|
|
740
|
+
* Same as `updateLead`, but resolves with the response body together with the HTTP status and headers.
|
|
741
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
742
|
+
* @param {LeadsApiUpdateLeadRequest} requestParameters Request parameters.
|
|
743
|
+
|
|
744
|
+
* @throws {RequiredError}
|
|
745
|
+
* @memberof LeadsApi
|
|
746
|
+
*/
|
|
747
|
+
updateLeadWithHttpInfo(requestParameters: LeadsApiUpdateLeadRequest): Promise<ApiResponse<GetLeadResponse>>;
|
|
583
748
|
}
|