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
|
@@ -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 { AddDealFollowerRequest } from '../models';
|
|
16
16
|
import { AddDealFollowerResponse } from '../models';
|
|
17
17
|
import { AddDealParticipantRequest } from '../models';
|
|
@@ -260,6 +260,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
260
260
|
* @throws {RequiredError}
|
|
261
261
|
*/
|
|
262
262
|
addDealFollower(id: number, AddDealFollowerRequest?: AddDealFollowerRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFollowerResponse>>;
|
|
263
|
+
/**
|
|
264
|
+
* Same as `addDealFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
265
|
+
* @summary Add a follower to a deal
|
|
266
|
+
* @param {number} id The ID of the deal
|
|
267
|
+
* @param {AddDealFollowerRequest} [AddDealFollowerRequest]
|
|
268
|
+
|
|
269
|
+
* @throws {RequiredError}
|
|
270
|
+
*/
|
|
271
|
+
addDealFollowerWithHttpInfo(id: number, AddDealFollowerRequest?: AddDealFollowerRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddDealFollowerResponse>>>;
|
|
263
272
|
/**
|
|
264
273
|
* Adds a participant to a deal.
|
|
265
274
|
* @summary Add a participant to a deal
|
|
@@ -269,6 +278,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
269
278
|
* @throws {RequiredError}
|
|
270
279
|
*/
|
|
271
280
|
addDealParticipant(id: number, AddDealParticipantRequest?: AddDealParticipantRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddParticipantsResponse>>;
|
|
281
|
+
/**
|
|
282
|
+
* Same as `addDealParticipant`, but resolves with the response body together with the HTTP status and headers.
|
|
283
|
+
* @summary Add a participant to a deal
|
|
284
|
+
* @param {number} id The ID of the deal
|
|
285
|
+
* @param {AddDealParticipantRequest} [AddDealParticipantRequest]
|
|
286
|
+
|
|
287
|
+
* @throws {RequiredError}
|
|
288
|
+
*/
|
|
289
|
+
addDealParticipantWithHttpInfo(id: number, AddDealParticipantRequest?: AddDealParticipantRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddParticipantsResponse>>>;
|
|
272
290
|
/**
|
|
273
291
|
* Deletes a follower from a deal.
|
|
274
292
|
* @summary Delete a follower from a deal
|
|
@@ -278,6 +296,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
278
296
|
* @throws {RequiredError}
|
|
279
297
|
*/
|
|
280
298
|
deleteDealFollower(id: number, follower_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteDealFollowerResponse>>;
|
|
299
|
+
/**
|
|
300
|
+
* Same as `deleteDealFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
301
|
+
* @summary Delete a follower from a deal
|
|
302
|
+
* @param {number} id The ID of the deal
|
|
303
|
+
* @param {number} follower_id The ID of the relationship between the follower and the deal
|
|
304
|
+
|
|
305
|
+
* @throws {RequiredError}
|
|
306
|
+
*/
|
|
307
|
+
deleteDealFollowerWithHttpInfo(id: number, follower_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<DeleteDealFollowerResponse>>>;
|
|
281
308
|
/**
|
|
282
309
|
* Deletes a participant from a deal.
|
|
283
310
|
* @summary Delete a participant from a deal
|
|
@@ -287,6 +314,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
287
314
|
* @throws {RequiredError}
|
|
288
315
|
*/
|
|
289
316
|
deleteDealParticipant(id: number, deal_participant_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteDealParticipantResponse>>;
|
|
317
|
+
/**
|
|
318
|
+
* Same as `deleteDealParticipant`, but resolves with the response body together with the HTTP status and headers.
|
|
319
|
+
* @summary Delete a participant from a deal
|
|
320
|
+
* @param {number} id The ID of the deal
|
|
321
|
+
* @param {number} deal_participant_id The ID of the participant of the deal
|
|
322
|
+
|
|
323
|
+
* @throws {RequiredError}
|
|
324
|
+
*/
|
|
325
|
+
deleteDealParticipantWithHttpInfo(id: number, deal_participant_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<DeleteDealParticipantResponse>>>;
|
|
290
326
|
/**
|
|
291
327
|
* Duplicates a deal.
|
|
292
328
|
* @summary Duplicate deal
|
|
@@ -295,6 +331,14 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
295
331
|
* @throws {RequiredError}
|
|
296
332
|
*/
|
|
297
333
|
duplicateDeal(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDuplicatedDealResponse>>;
|
|
334
|
+
/**
|
|
335
|
+
* Same as `duplicateDeal`, but resolves with the response body together with the HTTP status and headers.
|
|
336
|
+
* @summary Duplicate deal
|
|
337
|
+
* @param {number} id The ID of the deal
|
|
338
|
+
|
|
339
|
+
* @throws {RequiredError}
|
|
340
|
+
*/
|
|
341
|
+
duplicateDealWithHttpInfo(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetDuplicatedDealResponse>>>;
|
|
298
342
|
/**
|
|
299
343
|
* Returns all archived deals.
|
|
300
344
|
* @summary Get all archived deals
|
|
@@ -314,6 +358,25 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
314
358
|
* @throws {RequiredError}
|
|
315
359
|
*/
|
|
316
360
|
getArchivedDeals(user_id?: number, filter_id?: number, person_id?: number, org_id?: number, product_id?: number, pipeline_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted', start?: number, limit?: number, sort?: string, owned_by_you?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsResponse>>;
|
|
361
|
+
/**
|
|
362
|
+
* Same as `getArchivedDeals`, but resolves with the response body together with the HTTP status and headers.
|
|
363
|
+
* @summary Get all archived deals
|
|
364
|
+
* @param {number} [user_id] If supplied, only deals matching the given user will be returned. However, `filter_id` and `owned_by_you` takes precedence over `user_id` when supplied.
|
|
365
|
+
* @param {number} [filter_id] The ID of the filter to use
|
|
366
|
+
* @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
|
|
367
|
+
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
368
|
+
* @param {number} [product_id] If supplied, only deals linked to the specified product are returned. If filter_id is provided, this is ignored.
|
|
369
|
+
* @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
|
|
370
|
+
* @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
|
|
371
|
+
* @param {'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted'} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included.
|
|
372
|
+
* @param {number} [start] Pagination start
|
|
373
|
+
* @param {number} [limit] Items shown per page
|
|
374
|
+
* @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).
|
|
375
|
+
* @param {0 | 1} [owned_by_you] When supplied, only deals owned by you are returned. However, `filter_id` takes precedence over `owned_by_you` when both are supplied.
|
|
376
|
+
* @deprecated
|
|
377
|
+
* @throws {RequiredError}
|
|
378
|
+
*/
|
|
379
|
+
getArchivedDealsWithHttpInfo(user_id?: number, filter_id?: number, person_id?: number, org_id?: number, product_id?: number, pipeline_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted', start?: number, limit?: number, sort?: string, owned_by_you?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetDealsResponse>>>;
|
|
317
380
|
/**
|
|
318
381
|
* Returns a summary of all archived deals.
|
|
319
382
|
* @summary Get archived deals summary
|
|
@@ -326,6 +389,18 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
326
389
|
* @throws {RequiredError}
|
|
327
390
|
*/
|
|
328
391
|
getArchivedDealsSummary(status?: 'open' | 'won' | 'lost', filter_id?: number, user_id?: number, pipeline_id?: number, stage_id?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsSummaryResponse>>;
|
|
392
|
+
/**
|
|
393
|
+
* Same as `getArchivedDealsSummary`, but resolves with the response body together with the HTTP status and headers.
|
|
394
|
+
* @summary Get archived deals summary
|
|
395
|
+
* @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.
|
|
396
|
+
* @param {number} [filter_id] <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
|
|
397
|
+
* @param {number} [user_id] Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.
|
|
398
|
+
* @param {number} [pipeline_id] Only deals within the given pipeline will be returned
|
|
399
|
+
* @param {number} [stage_id] Only deals within the given stage will be returned
|
|
400
|
+
* @deprecated
|
|
401
|
+
* @throws {RequiredError}
|
|
402
|
+
*/
|
|
403
|
+
getArchivedDealsSummaryWithHttpInfo(status?: 'open' | 'won' | 'lost', filter_id?: number, user_id?: number, pipeline_id?: number, stage_id?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetDealsSummaryResponse>>>;
|
|
329
404
|
/**
|
|
330
405
|
* Returns archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
|
|
331
406
|
* @summary Get archived deals timeline
|
|
@@ -342,6 +417,22 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
342
417
|
* @throws {RequiredError}
|
|
343
418
|
*/
|
|
344
419
|
getArchivedDealsTimeline(start_date: string, interval: 'day' | 'week' | 'month' | 'quarter', amount: number, field_key: string, user_id?: number, pipeline_id?: number, filter_id?: number, exclude_deals?: 0 | 1, totals_convert_currency?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsTimelineResponse>>;
|
|
420
|
+
/**
|
|
421
|
+
* Same as `getArchivedDealsTimeline`, but resolves with the response body together with the HTTP status and headers.
|
|
422
|
+
* @summary Get archived deals timeline
|
|
423
|
+
* @param {string} start_date The date when the first interval starts. Format: YYYY-MM-DD.
|
|
424
|
+
* @param {'day' | 'week' | 'month' | 'quarter'} interval The type of the interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>`day`</td><td>Day</td></tr><tr><td>`week`</td><td>A full week (7 days) starting from `start_date`</td></tr><tr><td>`month`</td><td>A full month (depending on the number of days in given month) starting from `start_date`</td></tr><tr><td>`quarter`</td><td>A full quarter (3 months) starting from `start_date`</td></tr></table>
|
|
425
|
+
* @param {number} amount The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months).
|
|
426
|
+
* @param {string} field_key The date field key which deals will be retrieved from
|
|
427
|
+
* @param {number} [user_id] If supplied, only deals matching the given user will be returned
|
|
428
|
+
* @param {number} [pipeline_id] If supplied, only deals matching the given pipeline will be returned
|
|
429
|
+
* @param {number} [filter_id] If supplied, only deals matching the given filter will be returned
|
|
430
|
+
* @param {0 | 1} [exclude_deals] Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned.
|
|
431
|
+
* @param {string} [totals_convert_currency] The 3-letter currency code of any of the supported currencies. When supplied, `totals_converted` is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to `default_currency` in which case the user\'s default currency is used.
|
|
432
|
+
* @deprecated
|
|
433
|
+
* @throws {RequiredError}
|
|
434
|
+
*/
|
|
435
|
+
getArchivedDealsTimelineWithHttpInfo(start_date: string, interval: 'day' | 'week' | 'month' | 'quarter', amount: number, field_key: string, user_id?: number, pipeline_id?: number, filter_id?: number, exclude_deals?: 0 | 1, totals_convert_currency?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetDealsTimelineResponse>>>;
|
|
345
436
|
/**
|
|
346
437
|
* Lists updates about field values of a deal.
|
|
347
438
|
* @summary List updates about deal field values
|
|
@@ -352,6 +443,16 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
352
443
|
* @throws {RequiredError}
|
|
353
444
|
*/
|
|
354
445
|
getDealChangelog(id: number, cursor?: string, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetChangelogResponse>>;
|
|
446
|
+
/**
|
|
447
|
+
* Same as `getDealChangelog`, but resolves with the response body together with the HTTP status and headers.
|
|
448
|
+
* @summary List updates about deal field values
|
|
449
|
+
* @param {number} id The ID of the deal
|
|
450
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
451
|
+
* @param {number} [limit] Items shown per page
|
|
452
|
+
|
|
453
|
+
* @throws {RequiredError}
|
|
454
|
+
*/
|
|
455
|
+
getDealChangelogWithHttpInfo(id: number, cursor?: string, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetChangelogResponse>>>;
|
|
355
456
|
/**
|
|
356
457
|
* Lists files associated with a deal.
|
|
357
458
|
* @summary List files attached to a deal
|
|
@@ -363,6 +464,17 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
363
464
|
* @throws {RequiredError}
|
|
364
465
|
*/
|
|
365
466
|
getDealFiles(id: number, start?: number, limit?: number, sort?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedFilesResponse>>;
|
|
467
|
+
/**
|
|
468
|
+
* Same as `getDealFiles`, but resolves with the response body together with the HTTP status and headers.
|
|
469
|
+
* @summary List files attached to a deal
|
|
470
|
+
* @param {number} id The ID of the deal
|
|
471
|
+
* @param {number} [start] Pagination start
|
|
472
|
+
* @param {number} [limit] Items shown per page. Please note that a maximum value of 100 is allowed.
|
|
473
|
+
* @param {string} [sort] Supported fields: `id`, `update_time`
|
|
474
|
+
|
|
475
|
+
* @throws {RequiredError}
|
|
476
|
+
*/
|
|
477
|
+
getDealFilesWithHttpInfo(id: number, start?: number, limit?: number, sort?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetAssociatedFilesResponse>>>;
|
|
366
478
|
/**
|
|
367
479
|
* Lists the followers of a deal.
|
|
368
480
|
* @summary List followers of a deal
|
|
@@ -371,6 +483,14 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
371
483
|
* @throws {RequiredError}
|
|
372
484
|
*/
|
|
373
485
|
getDealFollowers(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetListFollowersResponse>>;
|
|
486
|
+
/**
|
|
487
|
+
* Same as `getDealFollowers`, but resolves with the response body together with the HTTP status and headers.
|
|
488
|
+
* @summary List followers of a deal
|
|
489
|
+
* @param {number} id The ID of the deal
|
|
490
|
+
|
|
491
|
+
* @throws {RequiredError}
|
|
492
|
+
*/
|
|
493
|
+
getDealFollowersWithHttpInfo(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetListFollowersResponse>>>;
|
|
374
494
|
/**
|
|
375
495
|
* Lists mail messages associated with a deal.
|
|
376
496
|
* @summary List mail messages associated with a deal
|
|
@@ -382,6 +502,17 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
382
502
|
* @throws {RequiredError}
|
|
383
503
|
*/
|
|
384
504
|
getDealMailMessages(id: number, start?: number, limit?: number, include_body?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedMailMessagesResponse>>;
|
|
505
|
+
/**
|
|
506
|
+
* Same as `getDealMailMessages`, but resolves with the response body together with the HTTP status and headers.
|
|
507
|
+
* @summary List mail messages associated with a deal
|
|
508
|
+
* @param {number} id The ID of the deal
|
|
509
|
+
* @param {number} [start] Pagination start
|
|
510
|
+
* @param {number} [limit] Items shown per page
|
|
511
|
+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. `0` = Don\'t include, `1` = Include.
|
|
512
|
+
|
|
513
|
+
* @throws {RequiredError}
|
|
514
|
+
*/
|
|
515
|
+
getDealMailMessagesWithHttpInfo(id: number, start?: number, limit?: number, include_body?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetAssociatedMailMessagesResponse>>>;
|
|
385
516
|
/**
|
|
386
517
|
* Lists the participants associated with a deal.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
|
|
387
518
|
* @summary List participants of a deal
|
|
@@ -392,6 +523,16 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
392
523
|
* @throws {RequiredError}
|
|
393
524
|
*/
|
|
394
525
|
getDealParticipants(id: number, start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealParticipantsResponse>>;
|
|
526
|
+
/**
|
|
527
|
+
* Same as `getDealParticipants`, but resolves with the response body together with the HTTP status and headers.
|
|
528
|
+
* @summary List participants of a deal
|
|
529
|
+
* @param {number} id The ID of the deal
|
|
530
|
+
* @param {number} [start] Pagination start
|
|
531
|
+
* @param {number} [limit] Items shown per page
|
|
532
|
+
|
|
533
|
+
* @throws {RequiredError}
|
|
534
|
+
*/
|
|
535
|
+
getDealParticipantsWithHttpInfo(id: number, start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetDealParticipantsResponse>>>;
|
|
395
536
|
/**
|
|
396
537
|
* List updates about participants of a deal. This is a cursor-paginated endpoint. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>.
|
|
397
538
|
* @summary List updates about participants of a deal
|
|
@@ -402,6 +543,16 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
402
543
|
* @throws {RequiredError}
|
|
403
544
|
*/
|
|
404
545
|
getDealParticipantsChangelog(id: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetParticipantsChangelogResponse>>;
|
|
546
|
+
/**
|
|
547
|
+
* Same as `getDealParticipantsChangelog`, but resolves with the response body together with the HTTP status and headers.
|
|
548
|
+
* @summary List updates about participants of a deal
|
|
549
|
+
* @param {number} id The ID of the deal
|
|
550
|
+
* @param {number} [limit] Items shown per page
|
|
551
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
552
|
+
|
|
553
|
+
* @throws {RequiredError}
|
|
554
|
+
*/
|
|
555
|
+
getDealParticipantsChangelogWithHttpInfo(id: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetParticipantsChangelogResponse>>>;
|
|
405
556
|
/**
|
|
406
557
|
* Lists updates about a deal.
|
|
407
558
|
* @summary List updates about a deal
|
|
@@ -414,6 +565,18 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
414
565
|
* @throws {RequiredError}
|
|
415
566
|
*/
|
|
416
567
|
getDealUpdates(id: number, start?: number, limit?: number, all_changes?: string, items?: Set<string>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealUpdatesResponse>>;
|
|
568
|
+
/**
|
|
569
|
+
* Same as `getDealUpdates`, but resolves with the response body together with the HTTP status and headers.
|
|
570
|
+
* @summary List updates about a deal
|
|
571
|
+
* @param {number} id The ID of the deal
|
|
572
|
+
* @param {number} [start] Pagination start
|
|
573
|
+
* @param {number} [limit] Items shown per page
|
|
574
|
+
* @param {string} [all_changes] Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
|
|
575
|
+
* @param {Set<string>} [items] A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).
|
|
576
|
+
|
|
577
|
+
* @throws {RequiredError}
|
|
578
|
+
*/
|
|
579
|
+
getDealUpdatesWithHttpInfo(id: number, start?: number, limit?: number, all_changes?: string, items?: Set<string>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetDealUpdatesResponse>>>;
|
|
417
580
|
/**
|
|
418
581
|
* Lists the users permitted to access a deal.
|
|
419
582
|
* @summary List permitted users
|
|
@@ -422,6 +585,14 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
422
585
|
* @throws {RequiredError}
|
|
423
586
|
*/
|
|
424
587
|
getDealUsers(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPermittedUsersResponse>>;
|
|
588
|
+
/**
|
|
589
|
+
* Same as `getDealUsers`, but resolves with the response body together with the HTTP status and headers.
|
|
590
|
+
* @summary List permitted users
|
|
591
|
+
* @param {number} id The ID of the deal
|
|
592
|
+
|
|
593
|
+
* @throws {RequiredError}
|
|
594
|
+
*/
|
|
595
|
+
getDealUsersWithHttpInfo(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetPermittedUsersResponse>>>;
|
|
425
596
|
/**
|
|
426
597
|
* Returns a summary of all not archived deals.
|
|
427
598
|
* @summary Get deals summary
|
|
@@ -434,6 +605,18 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
434
605
|
* @throws {RequiredError}
|
|
435
606
|
*/
|
|
436
607
|
getDealsSummary(status?: 'open' | 'won' | 'lost', filter_id?: number, user_id?: number, pipeline_id?: number, stage_id?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsSummaryResponse>>;
|
|
608
|
+
/**
|
|
609
|
+
* Same as `getDealsSummary`, but resolves with the response body together with the HTTP status and headers.
|
|
610
|
+
* @summary Get deals summary
|
|
611
|
+
* @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.
|
|
612
|
+
* @param {number} [filter_id] <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
|
|
613
|
+
* @param {number} [user_id] Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.
|
|
614
|
+
* @param {number} [pipeline_id] Only deals within the given pipeline will be returned
|
|
615
|
+
* @param {number} [stage_id] Only deals within the given stage will be returned
|
|
616
|
+
|
|
617
|
+
* @throws {RequiredError}
|
|
618
|
+
*/
|
|
619
|
+
getDealsSummaryWithHttpInfo(status?: 'open' | 'won' | 'lost', filter_id?: number, user_id?: number, pipeline_id?: number, stage_id?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetDealsSummaryResponse>>>;
|
|
437
620
|
/**
|
|
438
621
|
* Returns not archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
|
|
439
622
|
* @summary Get deals timeline
|
|
@@ -450,6 +633,22 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
450
633
|
* @throws {RequiredError}
|
|
451
634
|
*/
|
|
452
635
|
getDealsTimeline(start_date: string, interval: 'day' | 'week' | 'month' | 'quarter', amount: number, field_key: string, user_id?: number, pipeline_id?: number, filter_id?: number, exclude_deals?: 0 | 1, totals_convert_currency?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsTimelineResponse>>;
|
|
636
|
+
/**
|
|
637
|
+
* Same as `getDealsTimeline`, but resolves with the response body together with the HTTP status and headers.
|
|
638
|
+
* @summary Get deals timeline
|
|
639
|
+
* @param {string} start_date The date when the first interval starts. Format: YYYY-MM-DD.
|
|
640
|
+
* @param {'day' | 'week' | 'month' | 'quarter'} interval The type of the interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>`day`</td><td>Day</td></tr><tr><td>`week`</td><td>A full week (7 days) starting from `start_date`</td></tr><tr><td>`month`</td><td>A full month (depending on the number of days in given month) starting from `start_date`</td></tr><tr><td>`quarter`</td><td>A full quarter (3 months) starting from `start_date`</td></tr></table>
|
|
641
|
+
* @param {number} amount The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months).
|
|
642
|
+
* @param {string} field_key The date field key which deals will be retrieved from
|
|
643
|
+
* @param {number} [user_id] If supplied, only deals matching the given user will be returned
|
|
644
|
+
* @param {number} [pipeline_id] If supplied, only deals matching the given pipeline will be returned
|
|
645
|
+
* @param {number} [filter_id] If supplied, only deals matching the given filter will be returned
|
|
646
|
+
* @param {0 | 1} [exclude_deals] Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned.
|
|
647
|
+
* @param {string} [totals_convert_currency] The 3-letter currency code of any of the supported currencies. When supplied, `totals_converted` is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to `default_currency` in which case the user\'s default currency is used.
|
|
648
|
+
|
|
649
|
+
* @throws {RequiredError}
|
|
650
|
+
*/
|
|
651
|
+
getDealsTimelineWithHttpInfo(start_date: string, interval: 'day' | 'week' | 'month' | 'quarter', amount: number, field_key: string, user_id?: number, pipeline_id?: number, filter_id?: number, exclude_deals?: 0 | 1, totals_convert_currency?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetDealsTimelineResponse>>>;
|
|
453
652
|
/**
|
|
454
653
|
* Merges a deal with another deal. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/merging-two-deals\" target=\"_blank\" rel=\"noopener noreferrer\">merging two deals</a>.
|
|
455
654
|
* @summary Merge two deals
|
|
@@ -459,6 +658,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
459
658
|
* @throws {RequiredError}
|
|
460
659
|
*/
|
|
461
660
|
mergeDeals(id: number, MergeDealsRequest?: MergeDealsRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetMergedDealResponse>>;
|
|
661
|
+
/**
|
|
662
|
+
* Same as `mergeDeals`, but resolves with the response body together with the HTTP status and headers.
|
|
663
|
+
* @summary Merge two deals
|
|
664
|
+
* @param {number} id The ID of the deal
|
|
665
|
+
* @param {MergeDealsRequest} [MergeDealsRequest]
|
|
666
|
+
|
|
667
|
+
* @throws {RequiredError}
|
|
668
|
+
*/
|
|
669
|
+
mergeDealsWithHttpInfo(id: number, MergeDealsRequest?: MergeDealsRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetMergedDealResponse>>>;
|
|
462
670
|
};
|
|
463
671
|
/**
|
|
464
672
|
* DealsApi - factory interface
|
|
@@ -473,6 +681,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
473
681
|
* @throws {RequiredError}
|
|
474
682
|
*/
|
|
475
683
|
addDealFollower(requestParameters: DealsApiAddDealFollowerRequest): Promise<AddDealFollowerResponse>;
|
|
684
|
+
addDealFollowerWithHttpInfo(requestParameters: DealsApiAddDealFollowerRequest): Promise<ApiResponse<AddDealFollowerResponse>>;
|
|
476
685
|
/**
|
|
477
686
|
* Adds a participant to a deal.
|
|
478
687
|
* @summary Add a participant to a deal
|
|
@@ -481,6 +690,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
481
690
|
* @throws {RequiredError}
|
|
482
691
|
*/
|
|
483
692
|
addDealParticipant(requestParameters: DealsApiAddDealParticipantRequest): Promise<AddParticipantsResponse>;
|
|
693
|
+
addDealParticipantWithHttpInfo(requestParameters: DealsApiAddDealParticipantRequest): Promise<ApiResponse<AddParticipantsResponse>>;
|
|
484
694
|
/**
|
|
485
695
|
* Deletes a follower from a deal.
|
|
486
696
|
* @summary Delete a follower from a deal
|
|
@@ -489,6 +699,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
489
699
|
* @throws {RequiredError}
|
|
490
700
|
*/
|
|
491
701
|
deleteDealFollower(requestParameters: DealsApiDeleteDealFollowerRequest): Promise<DeleteDealFollowerResponse>;
|
|
702
|
+
deleteDealFollowerWithHttpInfo(requestParameters: DealsApiDeleteDealFollowerRequest): Promise<ApiResponse<DeleteDealFollowerResponse>>;
|
|
492
703
|
/**
|
|
493
704
|
* Deletes a participant from a deal.
|
|
494
705
|
* @summary Delete a participant from a deal
|
|
@@ -497,6 +708,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
497
708
|
* @throws {RequiredError}
|
|
498
709
|
*/
|
|
499
710
|
deleteDealParticipant(requestParameters: DealsApiDeleteDealParticipantRequest): Promise<DeleteDealParticipantResponse>;
|
|
711
|
+
deleteDealParticipantWithHttpInfo(requestParameters: DealsApiDeleteDealParticipantRequest): Promise<ApiResponse<DeleteDealParticipantResponse>>;
|
|
500
712
|
/**
|
|
501
713
|
* Duplicates a deal.
|
|
502
714
|
* @summary Duplicate deal
|
|
@@ -505,6 +717,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
505
717
|
* @throws {RequiredError}
|
|
506
718
|
*/
|
|
507
719
|
duplicateDeal(requestParameters: DealsApiDuplicateDealRequest): Promise<GetDuplicatedDealResponse>;
|
|
720
|
+
duplicateDealWithHttpInfo(requestParameters: DealsApiDuplicateDealRequest): Promise<ApiResponse<GetDuplicatedDealResponse>>;
|
|
508
721
|
/**
|
|
509
722
|
* Returns all archived deals.
|
|
510
723
|
* @summary Get all archived deals
|
|
@@ -513,6 +726,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
513
726
|
* @throws {RequiredError}
|
|
514
727
|
*/
|
|
515
728
|
getArchivedDeals(requestParameters?: DealsApiGetArchivedDealsRequest): Promise<GetDealsResponse>;
|
|
729
|
+
getArchivedDealsWithHttpInfo(requestParameters?: DealsApiGetArchivedDealsRequest): Promise<ApiResponse<GetDealsResponse>>;
|
|
516
730
|
/**
|
|
517
731
|
* Returns a summary of all archived deals.
|
|
518
732
|
* @summary Get archived deals summary
|
|
@@ -521,6 +735,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
521
735
|
* @throws {RequiredError}
|
|
522
736
|
*/
|
|
523
737
|
getArchivedDealsSummary(requestParameters?: DealsApiGetArchivedDealsSummaryRequest): Promise<GetDealsSummaryResponse>;
|
|
738
|
+
getArchivedDealsSummaryWithHttpInfo(requestParameters?: DealsApiGetArchivedDealsSummaryRequest): Promise<ApiResponse<GetDealsSummaryResponse>>;
|
|
524
739
|
/**
|
|
525
740
|
* Returns archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
|
|
526
741
|
* @summary Get archived deals timeline
|
|
@@ -529,6 +744,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
529
744
|
* @throws {RequiredError}
|
|
530
745
|
*/
|
|
531
746
|
getArchivedDealsTimeline(requestParameters: DealsApiGetArchivedDealsTimelineRequest): Promise<GetDealsTimelineResponse>;
|
|
747
|
+
getArchivedDealsTimelineWithHttpInfo(requestParameters: DealsApiGetArchivedDealsTimelineRequest): Promise<ApiResponse<GetDealsTimelineResponse>>;
|
|
532
748
|
/**
|
|
533
749
|
* Lists updates about field values of a deal.
|
|
534
750
|
* @summary List updates about deal field values
|
|
@@ -537,6 +753,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
537
753
|
* @throws {RequiredError}
|
|
538
754
|
*/
|
|
539
755
|
getDealChangelog(requestParameters: DealsApiGetDealChangelogRequest): Promise<GetChangelogResponse>;
|
|
756
|
+
getDealChangelogWithHttpInfo(requestParameters: DealsApiGetDealChangelogRequest): Promise<ApiResponse<GetChangelogResponse>>;
|
|
540
757
|
/**
|
|
541
758
|
* Lists files associated with a deal.
|
|
542
759
|
* @summary List files attached to a deal
|
|
@@ -545,6 +762,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
545
762
|
* @throws {RequiredError}
|
|
546
763
|
*/
|
|
547
764
|
getDealFiles(requestParameters: DealsApiGetDealFilesRequest): Promise<GetAssociatedFilesResponse>;
|
|
765
|
+
getDealFilesWithHttpInfo(requestParameters: DealsApiGetDealFilesRequest): Promise<ApiResponse<GetAssociatedFilesResponse>>;
|
|
548
766
|
/**
|
|
549
767
|
* Lists the followers of a deal.
|
|
550
768
|
* @summary List followers of a deal
|
|
@@ -553,6 +771,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
553
771
|
* @throws {RequiredError}
|
|
554
772
|
*/
|
|
555
773
|
getDealFollowers(requestParameters: DealsApiGetDealFollowersRequest): Promise<GetListFollowersResponse>;
|
|
774
|
+
getDealFollowersWithHttpInfo(requestParameters: DealsApiGetDealFollowersRequest): Promise<ApiResponse<GetListFollowersResponse>>;
|
|
556
775
|
/**
|
|
557
776
|
* Lists mail messages associated with a deal.
|
|
558
777
|
* @summary List mail messages associated with a deal
|
|
@@ -561,6 +780,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
561
780
|
* @throws {RequiredError}
|
|
562
781
|
*/
|
|
563
782
|
getDealMailMessages(requestParameters: DealsApiGetDealMailMessagesRequest): Promise<GetAssociatedMailMessagesResponse>;
|
|
783
|
+
getDealMailMessagesWithHttpInfo(requestParameters: DealsApiGetDealMailMessagesRequest): Promise<ApiResponse<GetAssociatedMailMessagesResponse>>;
|
|
564
784
|
/**
|
|
565
785
|
* Lists the participants associated with a deal.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
|
|
566
786
|
* @summary List participants of a deal
|
|
@@ -569,6 +789,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
569
789
|
* @throws {RequiredError}
|
|
570
790
|
*/
|
|
571
791
|
getDealParticipants(requestParameters: DealsApiGetDealParticipantsRequest): Promise<GetDealParticipantsResponse>;
|
|
792
|
+
getDealParticipantsWithHttpInfo(requestParameters: DealsApiGetDealParticipantsRequest): Promise<ApiResponse<GetDealParticipantsResponse>>;
|
|
572
793
|
/**
|
|
573
794
|
* List updates about participants of a deal. This is a cursor-paginated endpoint. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>.
|
|
574
795
|
* @summary List updates about participants of a deal
|
|
@@ -577,6 +798,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
577
798
|
* @throws {RequiredError}
|
|
578
799
|
*/
|
|
579
800
|
getDealParticipantsChangelog(requestParameters: DealsApiGetDealParticipantsChangelogRequest): Promise<GetParticipantsChangelogResponse>;
|
|
801
|
+
getDealParticipantsChangelogWithHttpInfo(requestParameters: DealsApiGetDealParticipantsChangelogRequest): Promise<ApiResponse<GetParticipantsChangelogResponse>>;
|
|
580
802
|
/**
|
|
581
803
|
* Lists updates about a deal.
|
|
582
804
|
* @summary List updates about a deal
|
|
@@ -585,6 +807,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
585
807
|
* @throws {RequiredError}
|
|
586
808
|
*/
|
|
587
809
|
getDealUpdates(requestParameters: DealsApiGetDealUpdatesRequest): Promise<GetDealUpdatesResponse>;
|
|
810
|
+
getDealUpdatesWithHttpInfo(requestParameters: DealsApiGetDealUpdatesRequest): Promise<ApiResponse<GetDealUpdatesResponse>>;
|
|
588
811
|
/**
|
|
589
812
|
* Lists the users permitted to access a deal.
|
|
590
813
|
* @summary List permitted users
|
|
@@ -593,6 +816,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
593
816
|
* @throws {RequiredError}
|
|
594
817
|
*/
|
|
595
818
|
getDealUsers(requestParameters: DealsApiGetDealUsersRequest): Promise<GetPermittedUsersResponse>;
|
|
819
|
+
getDealUsersWithHttpInfo(requestParameters: DealsApiGetDealUsersRequest): Promise<ApiResponse<GetPermittedUsersResponse>>;
|
|
596
820
|
/**
|
|
597
821
|
* Returns a summary of all not archived deals.
|
|
598
822
|
* @summary Get deals summary
|
|
@@ -601,6 +825,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
601
825
|
* @throws {RequiredError}
|
|
602
826
|
*/
|
|
603
827
|
getDealsSummary(requestParameters?: DealsApiGetDealsSummaryRequest): Promise<GetDealsSummaryResponse>;
|
|
828
|
+
getDealsSummaryWithHttpInfo(requestParameters?: DealsApiGetDealsSummaryRequest): Promise<ApiResponse<GetDealsSummaryResponse>>;
|
|
604
829
|
/**
|
|
605
830
|
* Returns not archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
|
|
606
831
|
* @summary Get deals timeline
|
|
@@ -609,6 +834,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
609
834
|
* @throws {RequiredError}
|
|
610
835
|
*/
|
|
611
836
|
getDealsTimeline(requestParameters: DealsApiGetDealsTimelineRequest): Promise<GetDealsTimelineResponse>;
|
|
837
|
+
getDealsTimelineWithHttpInfo(requestParameters: DealsApiGetDealsTimelineRequest): Promise<ApiResponse<GetDealsTimelineResponse>>;
|
|
612
838
|
/**
|
|
613
839
|
* Merges a deal with another deal. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/merging-two-deals\" target=\"_blank\" rel=\"noopener noreferrer\">merging two deals</a>.
|
|
614
840
|
* @summary Merge two deals
|
|
@@ -617,6 +843,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
617
843
|
* @throws {RequiredError}
|
|
618
844
|
*/
|
|
619
845
|
mergeDeals(requestParameters: DealsApiMergeDealsRequest): Promise<GetMergedDealResponse>;
|
|
846
|
+
mergeDealsWithHttpInfo(requestParameters: DealsApiMergeDealsRequest): Promise<ApiResponse<GetMergedDealResponse>>;
|
|
620
847
|
};
|
|
621
848
|
/**
|
|
622
849
|
* Request parameters for addDealFollower operation in DealsApi.
|
|
@@ -1217,6 +1444,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1217
1444
|
* @memberof DealsApi
|
|
1218
1445
|
*/
|
|
1219
1446
|
addDealFollower(requestParameters: DealsApiAddDealFollowerRequest): Promise<AddDealFollowerResponse>;
|
|
1447
|
+
/**
|
|
1448
|
+
* Same as `addDealFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
1449
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1450
|
+
* @param {DealsApiAddDealFollowerRequest} requestParameters Request parameters.
|
|
1451
|
+
|
|
1452
|
+
* @throws {RequiredError}
|
|
1453
|
+
* @memberof DealsApi
|
|
1454
|
+
*/
|
|
1455
|
+
addDealFollowerWithHttpInfo(requestParameters: DealsApiAddDealFollowerRequest): Promise<ApiResponse<AddDealFollowerResponse>>;
|
|
1220
1456
|
/**
|
|
1221
1457
|
* Adds a participant to a deal.
|
|
1222
1458
|
* @summary Add a participant to a deal
|
|
@@ -1226,6 +1462,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1226
1462
|
* @memberof DealsApi
|
|
1227
1463
|
*/
|
|
1228
1464
|
addDealParticipant(requestParameters: DealsApiAddDealParticipantRequest): Promise<AddParticipantsResponse>;
|
|
1465
|
+
/**
|
|
1466
|
+
* Same as `addDealParticipant`, but resolves with the response body together with the HTTP status and headers.
|
|
1467
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1468
|
+
* @param {DealsApiAddDealParticipantRequest} requestParameters Request parameters.
|
|
1469
|
+
|
|
1470
|
+
* @throws {RequiredError}
|
|
1471
|
+
* @memberof DealsApi
|
|
1472
|
+
*/
|
|
1473
|
+
addDealParticipantWithHttpInfo(requestParameters: DealsApiAddDealParticipantRequest): Promise<ApiResponse<AddParticipantsResponse>>;
|
|
1229
1474
|
/**
|
|
1230
1475
|
* Deletes a follower from a deal.
|
|
1231
1476
|
* @summary Delete a follower from a deal
|
|
@@ -1235,6 +1480,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1235
1480
|
* @memberof DealsApi
|
|
1236
1481
|
*/
|
|
1237
1482
|
deleteDealFollower(requestParameters: DealsApiDeleteDealFollowerRequest): Promise<DeleteDealFollowerResponse>;
|
|
1483
|
+
/**
|
|
1484
|
+
* Same as `deleteDealFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
1485
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1486
|
+
* @param {DealsApiDeleteDealFollowerRequest} requestParameters Request parameters.
|
|
1487
|
+
|
|
1488
|
+
* @throws {RequiredError}
|
|
1489
|
+
* @memberof DealsApi
|
|
1490
|
+
*/
|
|
1491
|
+
deleteDealFollowerWithHttpInfo(requestParameters: DealsApiDeleteDealFollowerRequest): Promise<ApiResponse<DeleteDealFollowerResponse>>;
|
|
1238
1492
|
/**
|
|
1239
1493
|
* Deletes a participant from a deal.
|
|
1240
1494
|
* @summary Delete a participant from a deal
|
|
@@ -1244,6 +1498,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1244
1498
|
* @memberof DealsApi
|
|
1245
1499
|
*/
|
|
1246
1500
|
deleteDealParticipant(requestParameters: DealsApiDeleteDealParticipantRequest): Promise<DeleteDealParticipantResponse>;
|
|
1501
|
+
/**
|
|
1502
|
+
* Same as `deleteDealParticipant`, but resolves with the response body together with the HTTP status and headers.
|
|
1503
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1504
|
+
* @param {DealsApiDeleteDealParticipantRequest} requestParameters Request parameters.
|
|
1505
|
+
|
|
1506
|
+
* @throws {RequiredError}
|
|
1507
|
+
* @memberof DealsApi
|
|
1508
|
+
*/
|
|
1509
|
+
deleteDealParticipantWithHttpInfo(requestParameters: DealsApiDeleteDealParticipantRequest): Promise<ApiResponse<DeleteDealParticipantResponse>>;
|
|
1247
1510
|
/**
|
|
1248
1511
|
* Duplicates a deal.
|
|
1249
1512
|
* @summary Duplicate deal
|
|
@@ -1253,6 +1516,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1253
1516
|
* @memberof DealsApi
|
|
1254
1517
|
*/
|
|
1255
1518
|
duplicateDeal(requestParameters: DealsApiDuplicateDealRequest): Promise<GetDuplicatedDealResponse>;
|
|
1519
|
+
/**
|
|
1520
|
+
* Same as `duplicateDeal`, but resolves with the response body together with the HTTP status and headers.
|
|
1521
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1522
|
+
* @param {DealsApiDuplicateDealRequest} requestParameters Request parameters.
|
|
1523
|
+
|
|
1524
|
+
* @throws {RequiredError}
|
|
1525
|
+
* @memberof DealsApi
|
|
1526
|
+
*/
|
|
1527
|
+
duplicateDealWithHttpInfo(requestParameters: DealsApiDuplicateDealRequest): Promise<ApiResponse<GetDuplicatedDealResponse>>;
|
|
1256
1528
|
/**
|
|
1257
1529
|
* Returns all archived deals.
|
|
1258
1530
|
* @summary Get all archived deals
|
|
@@ -1262,6 +1534,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1262
1534
|
* @memberof DealsApi
|
|
1263
1535
|
*/
|
|
1264
1536
|
getArchivedDeals(requestParameters?: DealsApiGetArchivedDealsRequest): Promise<GetDealsResponse>;
|
|
1537
|
+
/**
|
|
1538
|
+
* Same as `getArchivedDeals`, but resolves with the response body together with the HTTP status and headers.
|
|
1539
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1540
|
+
* @param {DealsApiGetArchivedDealsRequest} requestParameters Request parameters.
|
|
1541
|
+
* @deprecated
|
|
1542
|
+
* @throws {RequiredError}
|
|
1543
|
+
* @memberof DealsApi
|
|
1544
|
+
*/
|
|
1545
|
+
getArchivedDealsWithHttpInfo(requestParameters?: DealsApiGetArchivedDealsRequest): Promise<ApiResponse<GetDealsResponse>>;
|
|
1265
1546
|
/**
|
|
1266
1547
|
* Returns a summary of all archived deals.
|
|
1267
1548
|
* @summary Get archived deals summary
|
|
@@ -1271,6 +1552,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1271
1552
|
* @memberof DealsApi
|
|
1272
1553
|
*/
|
|
1273
1554
|
getArchivedDealsSummary(requestParameters?: DealsApiGetArchivedDealsSummaryRequest): Promise<GetDealsSummaryResponse>;
|
|
1555
|
+
/**
|
|
1556
|
+
* Same as `getArchivedDealsSummary`, but resolves with the response body together with the HTTP status and headers.
|
|
1557
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1558
|
+
* @param {DealsApiGetArchivedDealsSummaryRequest} requestParameters Request parameters.
|
|
1559
|
+
* @deprecated
|
|
1560
|
+
* @throws {RequiredError}
|
|
1561
|
+
* @memberof DealsApi
|
|
1562
|
+
*/
|
|
1563
|
+
getArchivedDealsSummaryWithHttpInfo(requestParameters?: DealsApiGetArchivedDealsSummaryRequest): Promise<ApiResponse<GetDealsSummaryResponse>>;
|
|
1274
1564
|
/**
|
|
1275
1565
|
* Returns archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
|
|
1276
1566
|
* @summary Get archived deals timeline
|
|
@@ -1280,6 +1570,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1280
1570
|
* @memberof DealsApi
|
|
1281
1571
|
*/
|
|
1282
1572
|
getArchivedDealsTimeline(requestParameters: DealsApiGetArchivedDealsTimelineRequest): Promise<GetDealsTimelineResponse>;
|
|
1573
|
+
/**
|
|
1574
|
+
* Same as `getArchivedDealsTimeline`, but resolves with the response body together with the HTTP status and headers.
|
|
1575
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1576
|
+
* @param {DealsApiGetArchivedDealsTimelineRequest} requestParameters Request parameters.
|
|
1577
|
+
* @deprecated
|
|
1578
|
+
* @throws {RequiredError}
|
|
1579
|
+
* @memberof DealsApi
|
|
1580
|
+
*/
|
|
1581
|
+
getArchivedDealsTimelineWithHttpInfo(requestParameters: DealsApiGetArchivedDealsTimelineRequest): Promise<ApiResponse<GetDealsTimelineResponse>>;
|
|
1283
1582
|
/**
|
|
1284
1583
|
* Lists updates about field values of a deal.
|
|
1285
1584
|
* @summary List updates about deal field values
|
|
@@ -1289,6 +1588,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1289
1588
|
* @memberof DealsApi
|
|
1290
1589
|
*/
|
|
1291
1590
|
getDealChangelog(requestParameters: DealsApiGetDealChangelogRequest): Promise<GetChangelogResponse>;
|
|
1591
|
+
/**
|
|
1592
|
+
* Same as `getDealChangelog`, but resolves with the response body together with the HTTP status and headers.
|
|
1593
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1594
|
+
* @param {DealsApiGetDealChangelogRequest} requestParameters Request parameters.
|
|
1595
|
+
|
|
1596
|
+
* @throws {RequiredError}
|
|
1597
|
+
* @memberof DealsApi
|
|
1598
|
+
*/
|
|
1599
|
+
getDealChangelogWithHttpInfo(requestParameters: DealsApiGetDealChangelogRequest): Promise<ApiResponse<GetChangelogResponse>>;
|
|
1292
1600
|
/**
|
|
1293
1601
|
* Lists files associated with a deal.
|
|
1294
1602
|
* @summary List files attached to a deal
|
|
@@ -1298,6 +1606,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1298
1606
|
* @memberof DealsApi
|
|
1299
1607
|
*/
|
|
1300
1608
|
getDealFiles(requestParameters: DealsApiGetDealFilesRequest): Promise<GetAssociatedFilesResponse>;
|
|
1609
|
+
/**
|
|
1610
|
+
* Same as `getDealFiles`, but resolves with the response body together with the HTTP status and headers.
|
|
1611
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1612
|
+
* @param {DealsApiGetDealFilesRequest} requestParameters Request parameters.
|
|
1613
|
+
|
|
1614
|
+
* @throws {RequiredError}
|
|
1615
|
+
* @memberof DealsApi
|
|
1616
|
+
*/
|
|
1617
|
+
getDealFilesWithHttpInfo(requestParameters: DealsApiGetDealFilesRequest): Promise<ApiResponse<GetAssociatedFilesResponse>>;
|
|
1301
1618
|
/**
|
|
1302
1619
|
* Lists the followers of a deal.
|
|
1303
1620
|
* @summary List followers of a deal
|
|
@@ -1307,6 +1624,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1307
1624
|
* @memberof DealsApi
|
|
1308
1625
|
*/
|
|
1309
1626
|
getDealFollowers(requestParameters: DealsApiGetDealFollowersRequest): Promise<GetListFollowersResponse>;
|
|
1627
|
+
/**
|
|
1628
|
+
* Same as `getDealFollowers`, but resolves with the response body together with the HTTP status and headers.
|
|
1629
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1630
|
+
* @param {DealsApiGetDealFollowersRequest} requestParameters Request parameters.
|
|
1631
|
+
|
|
1632
|
+
* @throws {RequiredError}
|
|
1633
|
+
* @memberof DealsApi
|
|
1634
|
+
*/
|
|
1635
|
+
getDealFollowersWithHttpInfo(requestParameters: DealsApiGetDealFollowersRequest): Promise<ApiResponse<GetListFollowersResponse>>;
|
|
1310
1636
|
/**
|
|
1311
1637
|
* Lists mail messages associated with a deal.
|
|
1312
1638
|
* @summary List mail messages associated with a deal
|
|
@@ -1316,6 +1642,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1316
1642
|
* @memberof DealsApi
|
|
1317
1643
|
*/
|
|
1318
1644
|
getDealMailMessages(requestParameters: DealsApiGetDealMailMessagesRequest): Promise<GetAssociatedMailMessagesResponse>;
|
|
1645
|
+
/**
|
|
1646
|
+
* Same as `getDealMailMessages`, but resolves with the response body together with the HTTP status and headers.
|
|
1647
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1648
|
+
* @param {DealsApiGetDealMailMessagesRequest} requestParameters Request parameters.
|
|
1649
|
+
|
|
1650
|
+
* @throws {RequiredError}
|
|
1651
|
+
* @memberof DealsApi
|
|
1652
|
+
*/
|
|
1653
|
+
getDealMailMessagesWithHttpInfo(requestParameters: DealsApiGetDealMailMessagesRequest): Promise<ApiResponse<GetAssociatedMailMessagesResponse>>;
|
|
1319
1654
|
/**
|
|
1320
1655
|
* Lists the participants associated with a deal.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
|
|
1321
1656
|
* @summary List participants of a deal
|
|
@@ -1325,6 +1660,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1325
1660
|
* @memberof DealsApi
|
|
1326
1661
|
*/
|
|
1327
1662
|
getDealParticipants(requestParameters: DealsApiGetDealParticipantsRequest): Promise<GetDealParticipantsResponse>;
|
|
1663
|
+
/**
|
|
1664
|
+
* Same as `getDealParticipants`, but resolves with the response body together with the HTTP status and headers.
|
|
1665
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1666
|
+
* @param {DealsApiGetDealParticipantsRequest} requestParameters Request parameters.
|
|
1667
|
+
|
|
1668
|
+
* @throws {RequiredError}
|
|
1669
|
+
* @memberof DealsApi
|
|
1670
|
+
*/
|
|
1671
|
+
getDealParticipantsWithHttpInfo(requestParameters: DealsApiGetDealParticipantsRequest): Promise<ApiResponse<GetDealParticipantsResponse>>;
|
|
1328
1672
|
/**
|
|
1329
1673
|
* List updates about participants of a deal. This is a cursor-paginated endpoint. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>.
|
|
1330
1674
|
* @summary List updates about participants of a deal
|
|
@@ -1334,6 +1678,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1334
1678
|
* @memberof DealsApi
|
|
1335
1679
|
*/
|
|
1336
1680
|
getDealParticipantsChangelog(requestParameters: DealsApiGetDealParticipantsChangelogRequest): Promise<GetParticipantsChangelogResponse>;
|
|
1681
|
+
/**
|
|
1682
|
+
* Same as `getDealParticipantsChangelog`, but resolves with the response body together with the HTTP status and headers.
|
|
1683
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1684
|
+
* @param {DealsApiGetDealParticipantsChangelogRequest} requestParameters Request parameters.
|
|
1685
|
+
|
|
1686
|
+
* @throws {RequiredError}
|
|
1687
|
+
* @memberof DealsApi
|
|
1688
|
+
*/
|
|
1689
|
+
getDealParticipantsChangelogWithHttpInfo(requestParameters: DealsApiGetDealParticipantsChangelogRequest): Promise<ApiResponse<GetParticipantsChangelogResponse>>;
|
|
1337
1690
|
/**
|
|
1338
1691
|
* Lists updates about a deal.
|
|
1339
1692
|
* @summary List updates about a deal
|
|
@@ -1343,6 +1696,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1343
1696
|
* @memberof DealsApi
|
|
1344
1697
|
*/
|
|
1345
1698
|
getDealUpdates(requestParameters: DealsApiGetDealUpdatesRequest): Promise<GetDealUpdatesResponse>;
|
|
1699
|
+
/**
|
|
1700
|
+
* Same as `getDealUpdates`, but resolves with the response body together with the HTTP status and headers.
|
|
1701
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1702
|
+
* @param {DealsApiGetDealUpdatesRequest} requestParameters Request parameters.
|
|
1703
|
+
|
|
1704
|
+
* @throws {RequiredError}
|
|
1705
|
+
* @memberof DealsApi
|
|
1706
|
+
*/
|
|
1707
|
+
getDealUpdatesWithHttpInfo(requestParameters: DealsApiGetDealUpdatesRequest): Promise<ApiResponse<GetDealUpdatesResponse>>;
|
|
1346
1708
|
/**
|
|
1347
1709
|
* Lists the users permitted to access a deal.
|
|
1348
1710
|
* @summary List permitted users
|
|
@@ -1352,6 +1714,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1352
1714
|
* @memberof DealsApi
|
|
1353
1715
|
*/
|
|
1354
1716
|
getDealUsers(requestParameters: DealsApiGetDealUsersRequest): Promise<import("../models").BaseResponse>;
|
|
1717
|
+
/**
|
|
1718
|
+
* Same as `getDealUsers`, but resolves with the response body together with the HTTP status and headers.
|
|
1719
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1720
|
+
* @param {DealsApiGetDealUsersRequest} requestParameters Request parameters.
|
|
1721
|
+
|
|
1722
|
+
* @throws {RequiredError}
|
|
1723
|
+
* @memberof DealsApi
|
|
1724
|
+
*/
|
|
1725
|
+
getDealUsersWithHttpInfo(requestParameters: DealsApiGetDealUsersRequest): Promise<ApiResponse<import("../models").BaseResponse>>;
|
|
1355
1726
|
/**
|
|
1356
1727
|
* Returns a summary of all not archived deals.
|
|
1357
1728
|
* @summary Get deals summary
|
|
@@ -1361,6 +1732,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1361
1732
|
* @memberof DealsApi
|
|
1362
1733
|
*/
|
|
1363
1734
|
getDealsSummary(requestParameters?: DealsApiGetDealsSummaryRequest): Promise<GetDealsSummaryResponse>;
|
|
1735
|
+
/**
|
|
1736
|
+
* Same as `getDealsSummary`, but resolves with the response body together with the HTTP status and headers.
|
|
1737
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1738
|
+
* @param {DealsApiGetDealsSummaryRequest} requestParameters Request parameters.
|
|
1739
|
+
|
|
1740
|
+
* @throws {RequiredError}
|
|
1741
|
+
* @memberof DealsApi
|
|
1742
|
+
*/
|
|
1743
|
+
getDealsSummaryWithHttpInfo(requestParameters?: DealsApiGetDealsSummaryRequest): Promise<ApiResponse<GetDealsSummaryResponse>>;
|
|
1364
1744
|
/**
|
|
1365
1745
|
* Returns not archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
|
|
1366
1746
|
* @summary Get deals timeline
|
|
@@ -1370,6 +1750,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1370
1750
|
* @memberof DealsApi
|
|
1371
1751
|
*/
|
|
1372
1752
|
getDealsTimeline(requestParameters: DealsApiGetDealsTimelineRequest): Promise<GetDealsTimelineResponse>;
|
|
1753
|
+
/**
|
|
1754
|
+
* Same as `getDealsTimeline`, but resolves with the response body together with the HTTP status and headers.
|
|
1755
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1756
|
+
* @param {DealsApiGetDealsTimelineRequest} requestParameters Request parameters.
|
|
1757
|
+
|
|
1758
|
+
* @throws {RequiredError}
|
|
1759
|
+
* @memberof DealsApi
|
|
1760
|
+
*/
|
|
1761
|
+
getDealsTimelineWithHttpInfo(requestParameters: DealsApiGetDealsTimelineRequest): Promise<ApiResponse<GetDealsTimelineResponse>>;
|
|
1373
1762
|
/**
|
|
1374
1763
|
* Merges a deal with another deal. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/merging-two-deals\" target=\"_blank\" rel=\"noopener noreferrer\">merging two deals</a>.
|
|
1375
1764
|
* @summary Merge two deals
|
|
@@ -1379,4 +1768,13 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1379
1768
|
* @memberof DealsApi
|
|
1380
1769
|
*/
|
|
1381
1770
|
mergeDeals(requestParameters: DealsApiMergeDealsRequest): Promise<GetMergedDealResponse>;
|
|
1771
|
+
/**
|
|
1772
|
+
* Same as `mergeDeals`, but resolves with the response body together with the HTTP status and headers.
|
|
1773
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1774
|
+
* @param {DealsApiMergeDealsRequest} requestParameters Request parameters.
|
|
1775
|
+
|
|
1776
|
+
* @throws {RequiredError}
|
|
1777
|
+
* @memberof DealsApi
|
|
1778
|
+
*/
|
|
1779
|
+
mergeDealsWithHttpInfo(requestParameters: DealsApiMergeDealsRequest): Promise<ApiResponse<GetMergedDealResponse>>;
|
|
1382
1780
|
}
|