pipedrive 32.2.0 → 33.0.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/notes-api.d.ts +18 -2
- package/dist/esm/versions/v1/api/notes-api.js +15 -5
- package/dist/esm/versions/v1/api/project-boards-api.d.ts +117 -0
- package/dist/esm/versions/v1/api/project-boards-api.js +191 -0
- package/dist/esm/versions/v1/api/project-phases-api.d.ts +134 -0
- package/dist/esm/versions/v1/api/project-phases-api.js +200 -0
- package/dist/esm/versions/v1/api/project-templates-api.d.ts +0 -94
- package/dist/esm/versions/v1/api/project-templates-api.js +0 -136
- package/dist/esm/versions/v1/api/projects-api.d.ts +0 -77
- package/dist/esm/versions/v1/api/projects-api.js +0 -131
- package/dist/esm/versions/v1/api.d.ts +2 -0
- package/dist/esm/versions/v1/api.js +2 -0
- package/dist/esm/versions/v1/models/add-note-request-all-of.d.ts +10 -5
- package/dist/esm/versions/v1/models/add-note-request-all-of1.d.ts +10 -0
- package/dist/esm/versions/v1/models/add-note-request-all-of1.js +4 -0
- package/dist/esm/versions/v1/models/index.d.ts +1 -0
- package/dist/esm/versions/v1/models/index.js +1 -0
- package/dist/esm/versions/v1/models/note-request-all-of1.d.ts +5 -0
- package/dist/esm/versions/v1/models/note-task.d.ts +23 -0
- package/dist/esm/versions/v1/models/note-task.js +14 -0
- package/dist/esm/versions/v1/models/note.d.ts +16 -0
- package/dist/esm/versions/v2/api/beta-api.d.ts +1314 -0
- package/dist/esm/versions/v2/api/beta-api.js +1796 -0
- package/dist/esm/versions/v2/api/deal-installments-api.d.ts +294 -0
- package/dist/esm/versions/v2/api/deal-installments-api.js +374 -0
- package/dist/esm/versions/v2/api/deal-products-api.d.ts +482 -0
- package/dist/esm/versions/v2/api/deal-products-api.js +607 -0
- package/dist/esm/versions/v2/api/deals-api.d.ts +32 -696
- package/dist/esm/versions/v2/api/deals-api.js +54 -891
- package/dist/esm/versions/v2/api/organizations-api.d.ts +36 -4
- package/dist/esm/versions/v2/api/organizations-api.js +30 -10
- package/dist/esm/versions/v2/api/persons-api.d.ts +36 -4
- package/dist/esm/versions/v2/api/persons-api.js +30 -10
- package/dist/esm/versions/v2/api/project-boards-api.d.ts +266 -0
- package/dist/esm/versions/v2/api/project-boards-api.js +400 -0
- package/dist/esm/versions/v2/api/project-fields-api.d.ts +457 -0
- package/dist/esm/versions/v2/api/project-fields-api.js +636 -0
- package/dist/esm/versions/v2/api/project-phases-api.d.ts +283 -0
- package/dist/esm/versions/v2/api/project-phases-api.js +409 -0
- package/dist/esm/versions/v2/api/project-templates-api.d.ts +142 -0
- package/dist/esm/versions/v2/api/project-templates-api.js +203 -0
- package/dist/esm/versions/v2/api/projects-api.d.ts +644 -0
- package/dist/esm/versions/v2/api/projects-api.js +829 -0
- package/dist/esm/versions/v2/api/tasks-api.d.ts +333 -0
- package/dist/esm/versions/v2/api/tasks-api.js +437 -0
- package/dist/esm/versions/v2/api.d.ts +9 -0
- package/dist/esm/versions/v2/api.js +9 -0
- package/dist/esm/versions/v2/models/add-deal-request.d.ts +1 -1
- package/dist/esm/versions/v2/models/add-organization-request.d.ts +1 -1
- package/dist/esm/versions/v2/models/add-person-request.d.ts +1 -1
- package/dist/esm/versions/v2/models/add-product-request.d.ts +2 -2
- package/dist/esm/versions/v2/models/add-project-board-request.d.ts +28 -0
- package/dist/esm/versions/v2/models/add-project-board-request.js +14 -0
- package/dist/esm/versions/v2/models/add-project-field-request-important-fields.d.ts +29 -0
- package/dist/esm/versions/v2/models/add-project-field-request-important-fields.js +14 -0
- package/dist/esm/versions/v2/models/add-project-field-request-required-fields.d.ts +24 -0
- package/dist/esm/versions/v2/models/add-project-field-request-required-fields.js +14 -0
- package/dist/esm/versions/v2/models/add-project-field-request-ui-visibility.d.ts +29 -0
- package/dist/esm/versions/v2/models/add-project-field-request-ui-visibility.js +14 -0
- package/dist/esm/versions/v2/models/add-project-field-request.d.ts +71 -0
- package/dist/esm/versions/v2/models/add-project-field-request.js +31 -0
- package/dist/esm/versions/v2/models/add-project-field200-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/add-project-field200-response.js +14 -0
- package/dist/esm/versions/v2/models/add-project-phase-request.d.ts +33 -0
- package/dist/esm/versions/v2/models/add-project-phase-request.js +14 -0
- package/dist/esm/versions/v2/models/add-project-request.d.ts +90 -0
- package/dist/esm/versions/v2/models/add-project-request.js +14 -0
- package/dist/esm/versions/v2/models/add-task-request.d.ts +83 -0
- package/dist/esm/versions/v2/models/add-task-request.js +21 -0
- package/dist/esm/versions/v2/models/add-task-response.d.ts +34 -0
- package/dist/esm/versions/v2/models/add-task-response.js +14 -0
- package/dist/esm/versions/v2/models/base-product-all-of.d.ts +55 -10
- package/dist/esm/versions/v2/models/base-product-all-of.js +5 -7
- package/dist/esm/versions/v2/models/base-product-all-of1.d.ts +32 -0
- package/dist/esm/versions/v2/models/base-product-all-of1.js +21 -0
- package/dist/esm/versions/v2/models/base-product.d.ts +2 -2
- package/dist/esm/versions/v2/models/deal.d.ts +1 -1
- package/dist/esm/versions/v2/models/delete-project-board-response-data.d.ts +23 -0
- package/dist/esm/versions/v2/models/delete-project-board-response-data.js +14 -0
- package/dist/esm/versions/v2/models/delete-project-board-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/delete-project-board-response.js +14 -0
- package/dist/esm/versions/v2/models/delete-project-field200-response-data.d.ts +53 -0
- package/dist/esm/versions/v2/models/delete-project-field200-response-data.js +14 -0
- package/dist/esm/versions/v2/models/delete-project-field200-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/delete-project-field200-response.js +14 -0
- package/dist/esm/versions/v2/models/delete-project-phase-response-data.d.ts +23 -0
- package/dist/esm/versions/v2/models/delete-project-phase-response-data.js +14 -0
- package/dist/esm/versions/v2/models/delete-project-phase-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/delete-project-phase-response.js +14 -0
- package/dist/esm/versions/v2/models/delete-project-response-data.d.ts +23 -0
- package/dist/esm/versions/v2/models/delete-project-response-data.js +14 -0
- package/dist/esm/versions/v2/models/delete-project-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/delete-project-response.js +14 -0
- package/dist/esm/versions/v2/models/delete-task-response-data.d.ts +23 -0
- package/dist/esm/versions/v2/models/delete-task-response-data.js +14 -0
- package/dist/esm/versions/v2/models/delete-task-response.d.ts +34 -0
- package/dist/esm/versions/v2/models/delete-task-response.js +14 -0
- package/dist/esm/versions/v2/models/get-persons-response-all-of.d.ts +3 -3
- package/dist/esm/versions/v2/models/get-project-boards-response-data-inner.d.ts +43 -0
- package/dist/esm/versions/v2/models/get-project-boards-response-data-inner.js +14 -0
- package/dist/esm/versions/v2/models/get-project-boards-response.d.ts +34 -0
- package/dist/esm/versions/v2/models/get-project-boards-response.js +14 -0
- package/dist/esm/versions/v2/models/get-project-changelog-response-data-inner.d.ts +52 -0
- package/dist/esm/versions/v2/models/get-project-changelog-response-data-inner.js +14 -0
- package/dist/esm/versions/v2/models/get-project-changelog-response.d.ts +35 -0
- package/dist/esm/versions/v2/models/get-project-changelog-response.js +14 -0
- package/dist/esm/versions/v2/models/get-project-fields200-response-data-inner-ui-visibility.d.ts +28 -0
- package/dist/esm/versions/v2/models/get-project-fields200-response-data-inner-ui-visibility.js +14 -0
- package/dist/esm/versions/v2/models/get-project-fields200-response-data-inner.d.ts +109 -0
- package/dist/esm/versions/v2/models/get-project-fields200-response-data-inner.js +48 -0
- package/dist/esm/versions/v2/models/get-project-fields200-response.d.ts +35 -0
- package/dist/esm/versions/v2/models/get-project-fields200-response.js +14 -0
- package/dist/esm/versions/v2/models/get-project-permitted-users-response.d.ts +28 -0
- package/dist/esm/versions/v2/models/get-project-permitted-users-response.js +14 -0
- package/dist/esm/versions/v2/models/get-project-phases-response-data-inner.d.ts +48 -0
- package/dist/esm/versions/v2/models/get-project-phases-response-data-inner.js +14 -0
- package/dist/esm/versions/v2/models/get-project-phases-response.d.ts +34 -0
- package/dist/esm/versions/v2/models/get-project-phases-response.js +14 -0
- package/dist/esm/versions/v2/models/get-project-search-response-all-of-data-items-inner-item-deal.d.ts +28 -0
- package/dist/esm/versions/v2/models/get-project-search-response-all-of-data-items-inner-item-deal.js +14 -0
- package/dist/esm/versions/v2/models/get-project-search-response-all-of-data-items-inner-item-organization.d.ts +33 -0
- package/dist/esm/versions/v2/models/get-project-search-response-all-of-data-items-inner-item-organization.js +14 -0
- package/dist/esm/versions/v2/models/get-project-search-response-all-of-data-items-inner-item-owner.d.ts +23 -0
- package/dist/esm/versions/v2/models/get-project-search-response-all-of-data-items-inner-item-owner.js +14 -0
- package/dist/esm/versions/v2/models/get-project-search-response-all-of-data-items-inner-item-person.d.ts +28 -0
- package/dist/esm/versions/v2/models/get-project-search-response-all-of-data-items-inner-item-person.js +14 -0
- package/dist/esm/versions/v2/models/get-project-search-response-all-of-data-items-inner-item-phase.d.ts +28 -0
- package/dist/esm/versions/v2/models/get-project-search-response-all-of-data-items-inner-item-phase.js +14 -0
- package/dist/esm/versions/v2/models/get-project-search-response-all-of-data-items-inner-item.d.ts +98 -0
- package/dist/esm/versions/v2/models/get-project-search-response-all-of-data-items-inner-item.js +14 -0
- package/dist/esm/versions/v2/models/get-project-search-response-all-of-data-items-inner.d.ts +29 -0
- package/dist/esm/versions/v2/models/get-project-search-response-all-of-data-items-inner.js +14 -0
- package/dist/esm/versions/v2/models/get-project-search-response-all-of-data.d.ts +24 -0
- package/dist/esm/versions/v2/models/get-project-search-response-all-of-data.js +14 -0
- package/dist/esm/versions/v2/models/get-project-search-response-all-of.d.ts +30 -0
- package/dist/esm/versions/v2/models/get-project-search-response-all-of.js +14 -0
- package/dist/esm/versions/v2/models/get-project-search-response.d.ts +18 -0
- package/dist/esm/versions/v2/models/get-project-search-response.js +14 -0
- package/dist/esm/versions/v2/models/get-project-template-response.d.ts +34 -0
- package/dist/esm/versions/v2/models/get-project-template-response.js +14 -0
- package/dist/esm/versions/v2/models/get-project-templates-response.d.ts +35 -0
- package/dist/esm/versions/v2/models/get-project-templates-response.js +14 -0
- package/dist/esm/versions/v2/models/get-projects-response-all-of.d.ts +30 -0
- package/dist/esm/versions/v2/models/get-projects-response-all-of.js +14 -0
- package/dist/esm/versions/v2/models/get-projects-response.d.ts +18 -0
- package/dist/esm/versions/v2/models/get-projects-response.js +14 -0
- package/dist/esm/versions/v2/models/get-task-response.d.ts +34 -0
- package/dist/esm/versions/v2/models/get-task-response.js +14 -0
- package/dist/esm/versions/v2/models/get-tasks-response-data-inner.d.ts +93 -0
- package/dist/esm/versions/v2/models/get-tasks-response-data-inner.js +14 -0
- package/dist/esm/versions/v2/models/get-tasks-response.d.ts +35 -0
- package/dist/esm/versions/v2/models/get-tasks-response.js +14 -0
- package/dist/esm/versions/v2/models/index.d.ts +63 -0
- package/dist/esm/versions/v2/models/index.js +63 -0
- package/dist/esm/versions/v2/models/organization-item.d.ts +1 -1
- package/dist/esm/versions/v2/models/person-im-inner.d.ts +33 -0
- package/dist/esm/versions/v2/models/person-im-inner.js +14 -0
- package/dist/esm/versions/v2/models/person-postal-address.d.ts +68 -0
- package/dist/esm/versions/v2/models/person-postal-address.js +14 -0
- package/dist/esm/versions/v2/models/person.d.ts +124 -0
- package/dist/esm/versions/v2/models/person.js +14 -0
- package/dist/esm/versions/v2/models/product-request.d.ts +1 -1
- package/dist/esm/versions/v2/models/project-template.d.ts +53 -0
- package/dist/esm/versions/v2/models/project-template.js +14 -0
- package/dist/esm/versions/v2/models/project.d.ts +115 -0
- package/dist/esm/versions/v2/models/project.js +14 -0
- package/dist/esm/versions/v2/models/update-deal-request.d.ts +1 -1
- package/dist/esm/versions/v2/models/update-organization-field-request.d.ts +0 -5
- package/dist/esm/versions/v2/models/update-organization-request.d.ts +1 -1
- package/dist/esm/versions/v2/models/update-project-board-request.d.ts +28 -0
- package/dist/esm/versions/v2/models/update-project-board-request.js +14 -0
- package/dist/esm/versions/v2/models/update-project-field-request.d.ts +41 -0
- package/dist/esm/versions/v2/models/update-project-field-request.js +14 -0
- package/dist/esm/versions/v2/models/update-project-phase-request.d.ts +33 -0
- package/dist/esm/versions/v2/models/update-project-phase-request.js +14 -0
- package/dist/esm/versions/v2/models/update-project-request.d.ts +90 -0
- package/dist/esm/versions/v2/models/update-project-request.js +14 -0
- package/dist/esm/versions/v2/models/update-task-request.d.ts +83 -0
- package/dist/esm/versions/v2/models/update-task-request.js +21 -0
- package/dist/esm/versions/v2/models/update-task-response.d.ts +34 -0
- package/dist/esm/versions/v2/models/update-task-response.js +14 -0
- package/dist/esm/versions/v2/models/upsert-person-response-data.d.ts +3 -3
- package/dist/esm/versions/v2/models/upsert-project-board-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/upsert-project-board-response.js +14 -0
- package/dist/esm/versions/v2/models/upsert-project-phase-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/upsert-project-phase-response.js +14 -0
- package/dist/esm/versions/v2/models/upsert-project-response-all-of.d.ts +24 -0
- package/dist/esm/versions/v2/models/upsert-project-response-all-of.js +14 -0
- package/dist/esm/versions/v2/models/upsert-project-response.d.ts +18 -0
- package/dist/esm/versions/v2/models/upsert-project-response.js +14 -0
- package/dist/versions/v1/api/notes-api.d.ts +18 -2
- package/dist/versions/v1/api/notes-api.js +15 -5
- package/dist/versions/v1/api/project-boards-api.d.ts +117 -0
- package/dist/versions/v1/api/project-boards-api.js +201 -0
- package/dist/versions/v1/api/project-phases-api.d.ts +134 -0
- package/dist/versions/v1/api/project-phases-api.js +210 -0
- package/dist/versions/v1/api/project-templates-api.d.ts +0 -94
- package/dist/versions/v1/api/project-templates-api.js +0 -136
- package/dist/versions/v1/api/projects-api.d.ts +0 -77
- package/dist/versions/v1/api/projects-api.js +0 -131
- package/dist/versions/v1/api.d.ts +2 -0
- package/dist/versions/v1/api.js +2 -0
- package/dist/versions/v1/models/add-note-request-all-of.d.ts +10 -5
- package/dist/versions/v1/models/add-note-request-all-of1.d.ts +10 -0
- package/dist/versions/v1/models/add-note-request-all-of1.js +5 -1
- package/dist/versions/v1/models/index.d.ts +1 -0
- package/dist/versions/v1/models/index.js +1 -0
- package/dist/versions/v1/models/note-request-all-of1.d.ts +5 -0
- package/dist/versions/v1/models/note-task.d.ts +23 -0
- package/dist/versions/v1/models/note-task.js +15 -0
- package/dist/versions/v1/models/note.d.ts +16 -0
- package/dist/versions/v2/api/beta-api.d.ts +1314 -0
- package/dist/versions/v2/api/beta-api.js +1806 -0
- package/dist/versions/v2/api/deal-installments-api.d.ts +294 -0
- package/dist/versions/v2/api/deal-installments-api.js +384 -0
- package/dist/versions/v2/api/deal-products-api.d.ts +482 -0
- package/dist/versions/v2/api/deal-products-api.js +617 -0
- package/dist/versions/v2/api/deals-api.d.ts +32 -696
- package/dist/versions/v2/api/deals-api.js +54 -891
- package/dist/versions/v2/api/organizations-api.d.ts +36 -4
- package/dist/versions/v2/api/organizations-api.js +30 -10
- package/dist/versions/v2/api/persons-api.d.ts +36 -4
- package/dist/versions/v2/api/persons-api.js +30 -10
- package/dist/versions/v2/api/project-boards-api.d.ts +266 -0
- package/dist/versions/v2/api/project-boards-api.js +410 -0
- package/dist/versions/v2/api/project-fields-api.d.ts +457 -0
- package/dist/versions/v2/api/project-fields-api.js +646 -0
- package/dist/versions/v2/api/project-phases-api.d.ts +283 -0
- package/dist/versions/v2/api/project-phases-api.js +419 -0
- package/dist/versions/v2/api/project-templates-api.d.ts +142 -0
- package/dist/versions/v2/api/project-templates-api.js +213 -0
- package/dist/versions/v2/api/projects-api.d.ts +644 -0
- package/dist/versions/v2/api/projects-api.js +839 -0
- package/dist/versions/v2/api/tasks-api.d.ts +333 -0
- package/dist/versions/v2/api/tasks-api.js +447 -0
- package/dist/versions/v2/api.d.ts +9 -0
- package/dist/versions/v2/api.js +9 -0
- package/dist/versions/v2/models/add-deal-request.d.ts +1 -1
- package/dist/versions/v2/models/add-organization-request.d.ts +1 -1
- package/dist/versions/v2/models/add-person-request.d.ts +1 -1
- package/dist/versions/v2/models/add-product-request.d.ts +2 -2
- package/dist/versions/v2/models/add-project-board-request.d.ts +28 -0
- package/dist/versions/v2/models/add-project-board-request.js +15 -0
- package/dist/versions/v2/models/add-project-field-request-important-fields.d.ts +29 -0
- package/dist/versions/v2/models/add-project-field-request-important-fields.js +15 -0
- package/dist/versions/v2/models/add-project-field-request-required-fields.d.ts +24 -0
- package/dist/versions/v2/models/add-project-field-request-required-fields.js +15 -0
- package/dist/versions/v2/models/add-project-field-request-ui-visibility.d.ts +29 -0
- package/dist/versions/v2/models/add-project-field-request-ui-visibility.js +15 -0
- package/dist/versions/v2/models/add-project-field-request.d.ts +71 -0
- package/dist/versions/v2/models/add-project-field-request.js +34 -0
- package/dist/versions/v2/models/add-project-field200-response.d.ts +29 -0
- package/dist/versions/v2/models/add-project-field200-response.js +15 -0
- package/dist/versions/v2/models/add-project-phase-request.d.ts +33 -0
- package/dist/versions/v2/models/add-project-phase-request.js +15 -0
- package/dist/versions/v2/models/add-project-request.d.ts +90 -0
- package/dist/versions/v2/models/add-project-request.js +15 -0
- package/dist/versions/v2/models/add-task-request.d.ts +83 -0
- package/dist/versions/v2/models/add-task-request.js +24 -0
- package/dist/versions/v2/models/add-task-response.d.ts +34 -0
- package/dist/versions/v2/models/add-task-response.js +15 -0
- package/dist/versions/v2/models/base-product-all-of.d.ts +55 -10
- package/dist/versions/v2/models/base-product-all-of.js +6 -8
- package/dist/versions/v2/models/base-product-all-of1.d.ts +32 -0
- package/dist/versions/v2/models/base-product-all-of1.js +24 -0
- package/dist/versions/v2/models/base-product.d.ts +2 -2
- package/dist/versions/v2/models/deal.d.ts +1 -1
- package/dist/versions/v2/models/delete-project-board-response-data.d.ts +23 -0
- package/dist/versions/v2/models/delete-project-board-response-data.js +15 -0
- package/dist/versions/v2/models/delete-project-board-response.d.ts +29 -0
- package/dist/versions/v2/models/delete-project-board-response.js +15 -0
- package/dist/versions/v2/models/delete-project-field200-response-data.d.ts +53 -0
- package/dist/versions/v2/models/delete-project-field200-response-data.js +15 -0
- package/dist/versions/v2/models/delete-project-field200-response.d.ts +29 -0
- package/dist/versions/v2/models/delete-project-field200-response.js +15 -0
- package/dist/versions/v2/models/delete-project-phase-response-data.d.ts +23 -0
- package/dist/versions/v2/models/delete-project-phase-response-data.js +15 -0
- package/dist/versions/v2/models/delete-project-phase-response.d.ts +29 -0
- package/dist/versions/v2/models/delete-project-phase-response.js +15 -0
- package/dist/versions/v2/models/delete-project-response-data.d.ts +23 -0
- package/dist/versions/v2/models/delete-project-response-data.js +15 -0
- package/dist/versions/v2/models/delete-project-response.d.ts +29 -0
- package/dist/versions/v2/models/delete-project-response.js +15 -0
- package/dist/versions/v2/models/delete-task-response-data.d.ts +23 -0
- package/dist/versions/v2/models/delete-task-response-data.js +15 -0
- package/dist/versions/v2/models/delete-task-response.d.ts +34 -0
- package/dist/versions/v2/models/delete-task-response.js +15 -0
- package/dist/versions/v2/models/get-persons-response-all-of.d.ts +3 -3
- package/dist/versions/v2/models/get-project-boards-response-data-inner.d.ts +43 -0
- package/dist/versions/v2/models/get-project-boards-response-data-inner.js +15 -0
- package/dist/versions/v2/models/get-project-boards-response.d.ts +34 -0
- package/dist/versions/v2/models/get-project-boards-response.js +15 -0
- package/dist/versions/v2/models/get-project-changelog-response-data-inner.d.ts +52 -0
- package/dist/versions/v2/models/get-project-changelog-response-data-inner.js +15 -0
- package/dist/versions/v2/models/get-project-changelog-response.d.ts +35 -0
- package/dist/versions/v2/models/get-project-changelog-response.js +15 -0
- package/dist/versions/v2/models/get-project-fields200-response-data-inner-ui-visibility.d.ts +28 -0
- package/dist/versions/v2/models/get-project-fields200-response-data-inner-ui-visibility.js +15 -0
- package/dist/versions/v2/models/get-project-fields200-response-data-inner.d.ts +109 -0
- package/dist/versions/v2/models/get-project-fields200-response-data-inner.js +51 -0
- package/dist/versions/v2/models/get-project-fields200-response.d.ts +35 -0
- package/dist/versions/v2/models/get-project-fields200-response.js +15 -0
- package/dist/versions/v2/models/get-project-permitted-users-response.d.ts +28 -0
- package/dist/versions/v2/models/get-project-permitted-users-response.js +15 -0
- package/dist/versions/v2/models/get-project-phases-response-data-inner.d.ts +48 -0
- package/dist/versions/v2/models/get-project-phases-response-data-inner.js +15 -0
- package/dist/versions/v2/models/get-project-phases-response.d.ts +34 -0
- package/dist/versions/v2/models/get-project-phases-response.js +15 -0
- package/dist/versions/v2/models/get-project-search-response-all-of-data-items-inner-item-deal.d.ts +28 -0
- package/dist/versions/v2/models/get-project-search-response-all-of-data-items-inner-item-deal.js +15 -0
- package/dist/versions/v2/models/get-project-search-response-all-of-data-items-inner-item-organization.d.ts +33 -0
- package/dist/versions/v2/models/get-project-search-response-all-of-data-items-inner-item-organization.js +15 -0
- package/dist/versions/v2/models/get-project-search-response-all-of-data-items-inner-item-owner.d.ts +23 -0
- package/dist/versions/v2/models/get-project-search-response-all-of-data-items-inner-item-owner.js +15 -0
- package/dist/versions/v2/models/get-project-search-response-all-of-data-items-inner-item-person.d.ts +28 -0
- package/dist/versions/v2/models/get-project-search-response-all-of-data-items-inner-item-person.js +15 -0
- package/dist/versions/v2/models/get-project-search-response-all-of-data-items-inner-item-phase.d.ts +28 -0
- package/dist/versions/v2/models/get-project-search-response-all-of-data-items-inner-item-phase.js +15 -0
- package/dist/versions/v2/models/get-project-search-response-all-of-data-items-inner-item.d.ts +98 -0
- package/dist/versions/v2/models/get-project-search-response-all-of-data-items-inner-item.js +15 -0
- package/dist/versions/v2/models/get-project-search-response-all-of-data-items-inner.d.ts +29 -0
- package/dist/versions/v2/models/get-project-search-response-all-of-data-items-inner.js +15 -0
- package/dist/versions/v2/models/get-project-search-response-all-of-data.d.ts +24 -0
- package/dist/versions/v2/models/get-project-search-response-all-of-data.js +15 -0
- package/dist/versions/v2/models/get-project-search-response-all-of.d.ts +30 -0
- package/dist/versions/v2/models/get-project-search-response-all-of.js +15 -0
- package/dist/versions/v2/models/get-project-search-response.d.ts +18 -0
- package/dist/versions/v2/models/get-project-search-response.js +15 -0
- package/dist/versions/v2/models/get-project-template-response.d.ts +34 -0
- package/dist/versions/v2/models/get-project-template-response.js +15 -0
- package/dist/versions/v2/models/get-project-templates-response.d.ts +35 -0
- package/dist/versions/v2/models/get-project-templates-response.js +15 -0
- package/dist/versions/v2/models/get-projects-response-all-of.d.ts +30 -0
- package/dist/versions/v2/models/get-projects-response-all-of.js +15 -0
- package/dist/versions/v2/models/get-projects-response.d.ts +18 -0
- package/dist/versions/v2/models/get-projects-response.js +15 -0
- package/dist/versions/v2/models/get-task-response.d.ts +34 -0
- package/dist/versions/v2/models/get-task-response.js +15 -0
- package/dist/versions/v2/models/get-tasks-response-data-inner.d.ts +93 -0
- package/dist/versions/v2/models/get-tasks-response-data-inner.js +15 -0
- package/dist/versions/v2/models/get-tasks-response.d.ts +35 -0
- package/dist/versions/v2/models/get-tasks-response.js +15 -0
- package/dist/versions/v2/models/index.d.ts +63 -0
- package/dist/versions/v2/models/index.js +63 -0
- package/dist/versions/v2/models/organization-item.d.ts +1 -1
- package/dist/versions/v2/models/person-im-inner.d.ts +33 -0
- package/dist/versions/v2/models/person-im-inner.js +15 -0
- package/dist/versions/v2/models/person-postal-address.d.ts +68 -0
- package/dist/versions/v2/models/person-postal-address.js +15 -0
- package/dist/versions/v2/models/person.d.ts +124 -0
- package/dist/versions/v2/models/person.js +15 -0
- package/dist/versions/v2/models/product-request.d.ts +1 -1
- package/dist/versions/v2/models/project-template.d.ts +53 -0
- package/dist/versions/v2/models/project-template.js +15 -0
- package/dist/versions/v2/models/project.d.ts +115 -0
- package/dist/versions/v2/models/project.js +15 -0
- package/dist/versions/v2/models/update-deal-request.d.ts +1 -1
- package/dist/versions/v2/models/update-organization-field-request.d.ts +0 -5
- package/dist/versions/v2/models/update-organization-request.d.ts +1 -1
- package/dist/versions/v2/models/update-project-board-request.d.ts +28 -0
- package/dist/versions/v2/models/update-project-board-request.js +15 -0
- package/dist/versions/v2/models/update-project-field-request.d.ts +41 -0
- package/dist/versions/v2/models/update-project-field-request.js +15 -0
- package/dist/versions/v2/models/update-project-phase-request.d.ts +33 -0
- package/dist/versions/v2/models/update-project-phase-request.js +15 -0
- package/dist/versions/v2/models/update-project-request.d.ts +90 -0
- package/dist/versions/v2/models/update-project-request.js +15 -0
- package/dist/versions/v2/models/update-task-request.d.ts +83 -0
- package/dist/versions/v2/models/update-task-request.js +24 -0
- package/dist/versions/v2/models/update-task-response.d.ts +34 -0
- package/dist/versions/v2/models/update-task-response.js +15 -0
- package/dist/versions/v2/models/upsert-person-response-data.d.ts +3 -3
- package/dist/versions/v2/models/upsert-project-board-response.d.ts +29 -0
- package/dist/versions/v2/models/upsert-project-board-response.js +15 -0
- package/dist/versions/v2/models/upsert-project-phase-response.d.ts +29 -0
- package/dist/versions/v2/models/upsert-project-phase-response.js +15 -0
- package/dist/versions/v2/models/upsert-project-response-all-of.d.ts +24 -0
- package/dist/versions/v2/models/upsert-project-response-all-of.js +15 -0
- package/dist/versions/v2/models/upsert-project-response.d.ts +18 -0
- package/dist/versions/v2/models/upsert-project-response.js +15 -0
- package/package.json +3 -2
|
@@ -12,38 +12,24 @@
|
|
|
12
12
|
import type { Configuration } from '../configuration';
|
|
13
13
|
import type { AxiosInstance } from 'axios';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
-
import { AddAInstallmentResponse } from '../models';
|
|
16
15
|
import { AddAdditionalDiscountRequestBody } from '../models';
|
|
17
16
|
import { AddAdditionalDiscountResponse } from '../models';
|
|
18
17
|
import { AddConvertDealToLeadResponse } from '../models';
|
|
19
18
|
import { AddDealFollowerRequest } from '../models';
|
|
20
|
-
import { AddDealProductRequest } from '../models';
|
|
21
|
-
import { AddDealProductResponse } from '../models';
|
|
22
19
|
import { AddDealRequest } from '../models';
|
|
23
20
|
import { AddFollowerResponse } from '../models';
|
|
24
|
-
import { AddInstallmentRequestBody } from '../models';
|
|
25
|
-
import { AddManyDealProductResponse } from '../models';
|
|
26
|
-
import { CreateManyDealProductRequest } from '../models';
|
|
27
21
|
import { DeleteAdditionalDiscountResponse } from '../models';
|
|
28
|
-
import { DeleteDealProductResponse } from '../models';
|
|
29
22
|
import { DeleteDealResponse } from '../models';
|
|
30
23
|
import { DeleteFollowerResponse } from '../models';
|
|
31
|
-
import { DeleteInstallmentResponse } from '../models';
|
|
32
|
-
import { DeleteManyDealProductResponse } from '../models';
|
|
33
24
|
import { GetAdditionalDiscountsResponse } from '../models';
|
|
34
25
|
import { GetConvertResponse1 } from '../models';
|
|
35
26
|
import { GetDealSearchResponse } from '../models';
|
|
36
|
-
import { GetDealsProductsResponse } from '../models';
|
|
37
27
|
import { GetDealsResponse } from '../models';
|
|
38
28
|
import { GetFollowerChangelogsResponse } from '../models';
|
|
39
29
|
import { GetFollowersResponse } from '../models';
|
|
40
|
-
import { GetInstallmentsResponse } from '../models';
|
|
41
30
|
import { UpdateAdditionalDiscountRequestBody } from '../models';
|
|
42
31
|
import { UpdateAdditionalDiscountResponse } from '../models';
|
|
43
|
-
import { UpdateDealProductRequest } from '../models';
|
|
44
32
|
import { UpdateDealRequest } from '../models';
|
|
45
|
-
import { UpdateInstallmentRequestBody } from '../models';
|
|
46
|
-
import { UpdateInstallmentResponse } from '../models';
|
|
47
33
|
import { UpsertDealResponse } from '../models';
|
|
48
34
|
/**
|
|
49
35
|
* DealsApi - axios parameter creator
|
|
@@ -67,24 +53,6 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
67
53
|
* @throws {RequiredError}
|
|
68
54
|
*/
|
|
69
55
|
addDealFollower: (id: number, AddDealFollowerRequest?: AddDealFollowerRequest) => Promise<RequestArgs>;
|
|
70
|
-
/**
|
|
71
|
-
* Adds a product to a deal, creating a new item called a deal-product.
|
|
72
|
-
* @summary Add a product to a deal
|
|
73
|
-
* @param {number} id The ID of the deal
|
|
74
|
-
* @param {AddDealProductRequest} [AddDealProductRequest]
|
|
75
|
-
|
|
76
|
-
* @throws {RequiredError}
|
|
77
|
-
*/
|
|
78
|
-
addDealProduct: (id: number, AddDealProductRequest?: AddDealProductRequest) => Promise<RequestArgs>;
|
|
79
|
-
/**
|
|
80
|
-
* Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
|
|
81
|
-
* @summary Add multiple products to a deal
|
|
82
|
-
* @param {number} id The ID of the deal
|
|
83
|
-
* @param {CreateManyDealProductRequest} [CreateManyDealProductRequest]
|
|
84
|
-
|
|
85
|
-
* @throws {RequiredError}
|
|
86
|
-
*/
|
|
87
|
-
addManyDealProducts: (id: number, CreateManyDealProductRequest?: CreateManyDealProductRequest) => Promise<RequestArgs>;
|
|
88
56
|
/**
|
|
89
57
|
* Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
|
|
90
58
|
* @summary Convert a deal to a lead
|
|
@@ -119,33 +87,6 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
119
87
|
* @throws {RequiredError}
|
|
120
88
|
*/
|
|
121
89
|
deleteDealFollower: (id: number, follower_id: number) => Promise<RequestArgs>;
|
|
122
|
-
/**
|
|
123
|
-
* Deletes a product attachment from a deal, using the `product_attachment_id`.
|
|
124
|
-
* @summary Delete an attached product from a deal
|
|
125
|
-
* @param {number} id The ID of the deal
|
|
126
|
-
* @param {number} product_attachment_id The product attachment ID
|
|
127
|
-
|
|
128
|
-
* @throws {RequiredError}
|
|
129
|
-
*/
|
|
130
|
-
deleteDealProduct: (id: number, product_attachment_id: number) => Promise<RequestArgs>;
|
|
131
|
-
/**
|
|
132
|
-
* Removes an installment from a deal. Only available in Growth and above plans.
|
|
133
|
-
* @summary Delete an installment from a deal
|
|
134
|
-
* @param {number} id The ID of the deal
|
|
135
|
-
* @param {number} installment_id The ID of the installment
|
|
136
|
-
|
|
137
|
-
* @throws {RequiredError}
|
|
138
|
-
*/
|
|
139
|
-
deleteInstallment: (id: number, installment_id: number) => Promise<RequestArgs>;
|
|
140
|
-
/**
|
|
141
|
-
* Deletes multiple products from a deal. If no product IDs are specified, up to 100 products will be removed from the deal. A maximum of 100 product IDs can be provided per request.
|
|
142
|
-
* @summary Delete many products from a deal
|
|
143
|
-
* @param {number} id The ID of the deal
|
|
144
|
-
* @param {string} [ids] Comma-separated list of deal product IDs to delete. If not provided, all deal products will be deleted up to 100 items. Maximum 100 IDs allowed.
|
|
145
|
-
|
|
146
|
-
* @throws {RequiredError}
|
|
147
|
-
*/
|
|
148
|
-
deleteManyDealProducts: (id: number, ids?: string) => Promise<RequestArgs>;
|
|
149
90
|
/**
|
|
150
91
|
* Lists discounts attached to a deal.
|
|
151
92
|
* @summary List discounts added to a deal
|
|
@@ -183,10 +124,12 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
183
124
|
* @param {number} id The ID of the deal
|
|
184
125
|
* @param {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' | 'source_lead_id'} [include_fields] Optional comma separated string array of additional fields to include
|
|
185
126
|
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
127
|
+
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
128
|
+
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
186
129
|
|
|
187
130
|
* @throws {RequiredError}
|
|
188
131
|
*/
|
|
189
|
-
getDeal: (id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' | 'source_lead_id', custom_fields?: string) => Promise<RequestArgs>;
|
|
132
|
+
getDeal: (id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' | 'source_lead_id', custom_fields?: string, include_option_labels?: boolean, include_labels?: boolean) => Promise<RequestArgs>;
|
|
190
133
|
/**
|
|
191
134
|
* Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
|
|
192
135
|
* @summary Get Deal conversion status
|
|
@@ -216,18 +159,6 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
216
159
|
* @throws {RequiredError}
|
|
217
160
|
*/
|
|
218
161
|
getDealFollowersChangelog: (id: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
219
|
-
/**
|
|
220
|
-
* Lists products attached to a deal.
|
|
221
|
-
* @summary List products attached to a deal
|
|
222
|
-
* @param {number} id The ID of the deal
|
|
223
|
-
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
224
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
|
225
|
-
* @param {'id' | 'add_time' | 'update_time' | 'order_nr'} [sort_by] The field to sort by. Supported fields: `id`, `add_time`, `update_time`, `order_nr`.
|
|
226
|
-
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
227
|
-
|
|
228
|
-
* @throws {RequiredError}
|
|
229
|
-
*/
|
|
230
|
-
getDealProducts: (id: number, cursor?: string, limit?: number, sort_by?: 'id' | 'add_time' | 'update_time' | 'order_nr', sort_direction?: 'asc' | 'desc') => Promise<RequestArgs>;
|
|
231
162
|
/**
|
|
232
163
|
* Returns data about all not archived deals.
|
|
233
164
|
* @summary Get all deals
|
|
@@ -245,36 +176,14 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
245
176
|
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
246
177
|
* @param {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' | 'source_lead_id'} [include_fields] Optional comma separated string array of additional fields to include
|
|
247
178
|
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
179
|
+
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
180
|
+
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
248
181
|
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
|
249
182
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
250
183
|
|
|
251
184
|
* @throws {RequiredError}
|
|
252
185
|
*/
|
|
253
|
-
getDeals: (filter_id?: number, ids?: string, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted', updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' | 'source_lead_id', custom_fields?: string, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
254
|
-
/**
|
|
255
|
-
* Returns data about products attached to deals
|
|
256
|
-
* @summary Get deal products of several deals
|
|
257
|
-
* @param {Array<number>} deal_ids An array of integers with the IDs of the deals for which the attached products will be returned. A maximum of 100 deal IDs can be provided.
|
|
258
|
-
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
259
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
|
260
|
-
* @param {'id' | 'deal_id' | 'add_time' | 'update_time' | 'order_nr'} [sort_by] The field to sort by. Supported fields: `id`, `deal_id`, `add_time`, `update_time`, `order_nr`.
|
|
261
|
-
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
262
|
-
|
|
263
|
-
* @throws {RequiredError}
|
|
264
|
-
*/
|
|
265
|
-
getDealsProducts: (deal_ids: Array<number>, cursor?: string, limit?: number, sort_by?: 'id' | 'deal_id' | 'add_time' | 'update_time' | 'order_nr', sort_direction?: 'asc' | 'desc') => Promise<RequestArgs>;
|
|
266
|
-
/**
|
|
267
|
-
* Lists installments attached to a list of deals. Only available in Growth and above plans.
|
|
268
|
-
* @summary List installments added to a list of deals
|
|
269
|
-
* @param {Array<number>} deal_ids An array of integers with the IDs of the deals for which the attached installments will be returned. A maximum of 100 deal IDs can be provided.
|
|
270
|
-
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
271
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
|
272
|
-
* @param {'id' | 'billing_date' | 'deal_id'} [sort_by] The field to sort by. Supported fields: `id`, `billing_date`, `deal_id`.
|
|
273
|
-
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
274
|
-
|
|
275
|
-
* @throws {RequiredError}
|
|
276
|
-
*/
|
|
277
|
-
getInstallments: (deal_ids: Array<number>, cursor?: string, limit?: number, sort_by?: 'id' | 'billing_date' | 'deal_id', sort_direction?: 'asc' | 'desc') => Promise<RequestArgs>;
|
|
186
|
+
getDeals: (filter_id?: number, ids?: string, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted', updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' | 'source_lead_id', custom_fields?: string, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
278
187
|
/**
|
|
279
188
|
* Adds a discount to a deal, changing the deal value if the deal has one-time products attached.
|
|
280
189
|
* @summary Add a discount to a deal
|
|
@@ -284,15 +193,6 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
284
193
|
* @throws {RequiredError}
|
|
285
194
|
*/
|
|
286
195
|
postAdditionalDiscount: (id: number, AddAdditionalDiscountRequestBody?: AddAdditionalDiscountRequestBody) => Promise<RequestArgs>;
|
|
287
|
-
/**
|
|
288
|
-
* Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Growth and above plans.
|
|
289
|
-
* @summary Add an installment to a deal
|
|
290
|
-
* @param {number} id The ID of the deal
|
|
291
|
-
* @param {AddInstallmentRequestBody} [AddInstallmentRequestBody]
|
|
292
|
-
|
|
293
|
-
* @throws {RequiredError}
|
|
294
|
-
*/
|
|
295
|
-
postInstallment: (id: number, AddInstallmentRequestBody?: AddInstallmentRequestBody) => Promise<RequestArgs>;
|
|
296
196
|
/**
|
|
297
197
|
* Searches all deals 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 deals can be filtered by the person ID and the organization ID.
|
|
298
198
|
* @summary Search deals
|
|
@@ -328,26 +228,6 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
328
228
|
* @throws {RequiredError}
|
|
329
229
|
*/
|
|
330
230
|
updateDeal: (id: number, UpdateDealRequest?: UpdateDealRequest) => Promise<RequestArgs>;
|
|
331
|
-
/**
|
|
332
|
-
* Updates the details of the product that has been attached to a deal.
|
|
333
|
-
* @summary Update the product attached to a deal
|
|
334
|
-
* @param {number} id The ID of the deal
|
|
335
|
-
* @param {number} product_attachment_id The ID of the deal-product (the ID of the product attached to the deal)
|
|
336
|
-
* @param {UpdateDealProductRequest} [UpdateDealProductRequest]
|
|
337
|
-
|
|
338
|
-
* @throws {RequiredError}
|
|
339
|
-
*/
|
|
340
|
-
updateDealProduct: (id: number, product_attachment_id: number, UpdateDealProductRequest?: UpdateDealProductRequest) => Promise<RequestArgs>;
|
|
341
|
-
/**
|
|
342
|
-
* Edits an installment added to a deal. Only available in Growth and above plans.
|
|
343
|
-
* @summary Update an installment added to a deal
|
|
344
|
-
* @param {number} id The ID of the deal
|
|
345
|
-
* @param {number} installment_id The ID of the installment
|
|
346
|
-
* @param {UpdateInstallmentRequestBody} [UpdateInstallmentRequestBody]
|
|
347
|
-
|
|
348
|
-
* @throws {RequiredError}
|
|
349
|
-
*/
|
|
350
|
-
updateInstallment: (id: number, installment_id: number, UpdateInstallmentRequestBody?: UpdateInstallmentRequestBody) => Promise<RequestArgs>;
|
|
351
231
|
};
|
|
352
232
|
/**
|
|
353
233
|
* DealsApi - functional programming interface
|
|
@@ -371,24 +251,6 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
371
251
|
* @throws {RequiredError}
|
|
372
252
|
*/
|
|
373
253
|
addDealFollower(id: number, AddDealFollowerRequest?: AddDealFollowerRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddFollowerResponse>>;
|
|
374
|
-
/**
|
|
375
|
-
* Adds a product to a deal, creating a new item called a deal-product.
|
|
376
|
-
* @summary Add a product to a deal
|
|
377
|
-
* @param {number} id The ID of the deal
|
|
378
|
-
* @param {AddDealProductRequest} [AddDealProductRequest]
|
|
379
|
-
|
|
380
|
-
* @throws {RequiredError}
|
|
381
|
-
*/
|
|
382
|
-
addDealProduct(id: number, AddDealProductRequest?: AddDealProductRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealProductResponse>>;
|
|
383
|
-
/**
|
|
384
|
-
* Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
|
|
385
|
-
* @summary Add multiple products to a deal
|
|
386
|
-
* @param {number} id The ID of the deal
|
|
387
|
-
* @param {CreateManyDealProductRequest} [CreateManyDealProductRequest]
|
|
388
|
-
|
|
389
|
-
* @throws {RequiredError}
|
|
390
|
-
*/
|
|
391
|
-
addManyDealProducts(id: number, CreateManyDealProductRequest?: CreateManyDealProductRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddManyDealProductResponse>>;
|
|
392
254
|
/**
|
|
393
255
|
* Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
|
|
394
256
|
* @summary Convert a deal to a lead
|
|
@@ -423,33 +285,6 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
423
285
|
* @throws {RequiredError}
|
|
424
286
|
*/
|
|
425
287
|
deleteDealFollower(id: number, follower_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteFollowerResponse>>;
|
|
426
|
-
/**
|
|
427
|
-
* Deletes a product attachment from a deal, using the `product_attachment_id`.
|
|
428
|
-
* @summary Delete an attached product from a deal
|
|
429
|
-
* @param {number} id The ID of the deal
|
|
430
|
-
* @param {number} product_attachment_id The product attachment ID
|
|
431
|
-
|
|
432
|
-
* @throws {RequiredError}
|
|
433
|
-
*/
|
|
434
|
-
deleteDealProduct(id: number, product_attachment_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteDealProductResponse>>;
|
|
435
|
-
/**
|
|
436
|
-
* Removes an installment from a deal. Only available in Growth and above plans.
|
|
437
|
-
* @summary Delete an installment from a deal
|
|
438
|
-
* @param {number} id The ID of the deal
|
|
439
|
-
* @param {number} installment_id The ID of the installment
|
|
440
|
-
|
|
441
|
-
* @throws {RequiredError}
|
|
442
|
-
*/
|
|
443
|
-
deleteInstallment(id: number, installment_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteInstallmentResponse>>;
|
|
444
|
-
/**
|
|
445
|
-
* Deletes multiple products from a deal. If no product IDs are specified, up to 100 products will be removed from the deal. A maximum of 100 product IDs can be provided per request.
|
|
446
|
-
* @summary Delete many products from a deal
|
|
447
|
-
* @param {number} id The ID of the deal
|
|
448
|
-
* @param {string} [ids] Comma-separated list of deal product IDs to delete. If not provided, all deal products will be deleted up to 100 items. Maximum 100 IDs allowed.
|
|
449
|
-
|
|
450
|
-
* @throws {RequiredError}
|
|
451
|
-
*/
|
|
452
|
-
deleteManyDealProducts(id: number, ids?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteManyDealProductResponse>>;
|
|
453
288
|
/**
|
|
454
289
|
* Lists discounts attached to a deal.
|
|
455
290
|
* @summary List discounts added to a deal
|
|
@@ -487,10 +322,12 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
487
322
|
* @param {number} id The ID of the deal
|
|
488
323
|
* @param {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' | 'source_lead_id'} [include_fields] Optional comma separated string array of additional fields to include
|
|
489
324
|
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
325
|
+
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
326
|
+
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
490
327
|
|
|
491
328
|
* @throws {RequiredError}
|
|
492
329
|
*/
|
|
493
|
-
getDeal(id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' | 'source_lead_id', custom_fields?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertDealResponse>>;
|
|
330
|
+
getDeal(id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' | 'source_lead_id', custom_fields?: string, include_option_labels?: boolean, include_labels?: boolean): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertDealResponse>>;
|
|
494
331
|
/**
|
|
495
332
|
* Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
|
|
496
333
|
* @summary Get Deal conversion status
|
|
@@ -520,18 +357,6 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
520
357
|
* @throws {RequiredError}
|
|
521
358
|
*/
|
|
522
359
|
getDealFollowersChangelog(id: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFollowerChangelogsResponse>>;
|
|
523
|
-
/**
|
|
524
|
-
* Lists products attached to a deal.
|
|
525
|
-
* @summary List products attached to a deal
|
|
526
|
-
* @param {number} id The ID of the deal
|
|
527
|
-
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
528
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
|
529
|
-
* @param {'id' | 'add_time' | 'update_time' | 'order_nr'} [sort_by] The field to sort by. Supported fields: `id`, `add_time`, `update_time`, `order_nr`.
|
|
530
|
-
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
531
|
-
|
|
532
|
-
* @throws {RequiredError}
|
|
533
|
-
*/
|
|
534
|
-
getDealProducts(id: number, cursor?: string, limit?: number, sort_by?: 'id' | 'add_time' | 'update_time' | 'order_nr', sort_direction?: 'asc' | 'desc'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsProductsResponse>>;
|
|
535
360
|
/**
|
|
536
361
|
* Returns data about all not archived deals.
|
|
537
362
|
* @summary Get all deals
|
|
@@ -549,36 +374,14 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
549
374
|
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
550
375
|
* @param {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' | 'source_lead_id'} [include_fields] Optional comma separated string array of additional fields to include
|
|
551
376
|
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
377
|
+
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
378
|
+
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
552
379
|
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
|
553
380
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
554
381
|
|
|
555
382
|
* @throws {RequiredError}
|
|
556
383
|
*/
|
|
557
|
-
getDeals(filter_id?: number, ids?: string, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted', updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' | 'source_lead_id', custom_fields?: string, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsResponse>>;
|
|
558
|
-
/**
|
|
559
|
-
* Returns data about products attached to deals
|
|
560
|
-
* @summary Get deal products of several deals
|
|
561
|
-
* @param {Array<number>} deal_ids An array of integers with the IDs of the deals for which the attached products will be returned. A maximum of 100 deal IDs can be provided.
|
|
562
|
-
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
563
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
|
564
|
-
* @param {'id' | 'deal_id' | 'add_time' | 'update_time' | 'order_nr'} [sort_by] The field to sort by. Supported fields: `id`, `deal_id`, `add_time`, `update_time`, `order_nr`.
|
|
565
|
-
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
566
|
-
|
|
567
|
-
* @throws {RequiredError}
|
|
568
|
-
*/
|
|
569
|
-
getDealsProducts(deal_ids: Array<number>, cursor?: string, limit?: number, sort_by?: 'id' | 'deal_id' | 'add_time' | 'update_time' | 'order_nr', sort_direction?: 'asc' | 'desc'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsProductsResponse>>;
|
|
570
|
-
/**
|
|
571
|
-
* Lists installments attached to a list of deals. Only available in Growth and above plans.
|
|
572
|
-
* @summary List installments added to a list of deals
|
|
573
|
-
* @param {Array<number>} deal_ids An array of integers with the IDs of the deals for which the attached installments will be returned. A maximum of 100 deal IDs can be provided.
|
|
574
|
-
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
575
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
|
576
|
-
* @param {'id' | 'billing_date' | 'deal_id'} [sort_by] The field to sort by. Supported fields: `id`, `billing_date`, `deal_id`.
|
|
577
|
-
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
578
|
-
|
|
579
|
-
* @throws {RequiredError}
|
|
580
|
-
*/
|
|
581
|
-
getInstallments(deal_ids: Array<number>, cursor?: string, limit?: number, sort_by?: 'id' | 'billing_date' | 'deal_id', sort_direction?: 'asc' | 'desc'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetInstallmentsResponse>>;
|
|
384
|
+
getDeals(filter_id?: number, ids?: string, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted', updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' | 'source_lead_id', custom_fields?: string, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsResponse>>;
|
|
582
385
|
/**
|
|
583
386
|
* Adds a discount to a deal, changing the deal value if the deal has one-time products attached.
|
|
584
387
|
* @summary Add a discount to a deal
|
|
@@ -588,15 +391,6 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
588
391
|
* @throws {RequiredError}
|
|
589
392
|
*/
|
|
590
393
|
postAdditionalDiscount(id: number, AddAdditionalDiscountRequestBody?: AddAdditionalDiscountRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddAdditionalDiscountResponse>>;
|
|
591
|
-
/**
|
|
592
|
-
* Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Growth and above plans.
|
|
593
|
-
* @summary Add an installment to a deal
|
|
594
|
-
* @param {number} id The ID of the deal
|
|
595
|
-
* @param {AddInstallmentRequestBody} [AddInstallmentRequestBody]
|
|
596
|
-
|
|
597
|
-
* @throws {RequiredError}
|
|
598
|
-
*/
|
|
599
|
-
postInstallment(id: number, AddInstallmentRequestBody?: AddInstallmentRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddAInstallmentResponse>>;
|
|
600
394
|
/**
|
|
601
395
|
* Searches all deals 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 deals can be filtered by the person ID and the organization ID.
|
|
602
396
|
* @summary Search deals
|
|
@@ -632,26 +426,6 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
632
426
|
* @throws {RequiredError}
|
|
633
427
|
*/
|
|
634
428
|
updateDeal(id: number, UpdateDealRequest?: UpdateDealRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertDealResponse>>;
|
|
635
|
-
/**
|
|
636
|
-
* Updates the details of the product that has been attached to a deal.
|
|
637
|
-
* @summary Update the product attached to a deal
|
|
638
|
-
* @param {number} id The ID of the deal
|
|
639
|
-
* @param {number} product_attachment_id The ID of the deal-product (the ID of the product attached to the deal)
|
|
640
|
-
* @param {UpdateDealProductRequest} [UpdateDealProductRequest]
|
|
641
|
-
|
|
642
|
-
* @throws {RequiredError}
|
|
643
|
-
*/
|
|
644
|
-
updateDealProduct(id: number, product_attachment_id: number, UpdateDealProductRequest?: UpdateDealProductRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealProductResponse>>;
|
|
645
|
-
/**
|
|
646
|
-
* Edits an installment added to a deal. Only available in Growth and above plans.
|
|
647
|
-
* @summary Update an installment added to a deal
|
|
648
|
-
* @param {number} id The ID of the deal
|
|
649
|
-
* @param {number} installment_id The ID of the installment
|
|
650
|
-
* @param {UpdateInstallmentRequestBody} [UpdateInstallmentRequestBody]
|
|
651
|
-
|
|
652
|
-
* @throws {RequiredError}
|
|
653
|
-
*/
|
|
654
|
-
updateInstallment(id: number, installment_id: number, UpdateInstallmentRequestBody?: UpdateInstallmentRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpdateInstallmentResponse>>;
|
|
655
429
|
};
|
|
656
430
|
/**
|
|
657
431
|
* DealsApi - factory interface
|
|
@@ -674,22 +448,6 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
674
448
|
* @throws {RequiredError}
|
|
675
449
|
*/
|
|
676
450
|
addDealFollower(requestParameters: DealsApiAddDealFollowerRequest): Promise<AddFollowerResponse>;
|
|
677
|
-
/**
|
|
678
|
-
* Adds a product to a deal, creating a new item called a deal-product.
|
|
679
|
-
* @summary Add a product to a deal
|
|
680
|
-
* @param {DealsApiAddDealProductRequest} requestParameters Request parameters.
|
|
681
|
-
|
|
682
|
-
* @throws {RequiredError}
|
|
683
|
-
*/
|
|
684
|
-
addDealProduct(requestParameters: DealsApiAddDealProductRequest): Promise<AddDealProductResponse>;
|
|
685
|
-
/**
|
|
686
|
-
* Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
|
|
687
|
-
* @summary Add multiple products to a deal
|
|
688
|
-
* @param {DealsApiAddManyDealProductsRequest} requestParameters Request parameters.
|
|
689
|
-
|
|
690
|
-
* @throws {RequiredError}
|
|
691
|
-
*/
|
|
692
|
-
addManyDealProducts(requestParameters: DealsApiAddManyDealProductsRequest): Promise<AddManyDealProductResponse>;
|
|
693
451
|
/**
|
|
694
452
|
* Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
|
|
695
453
|
* @summary Convert a deal to a lead
|
|
@@ -722,30 +480,6 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
722
480
|
* @throws {RequiredError}
|
|
723
481
|
*/
|
|
724
482
|
deleteDealFollower(requestParameters: DealsApiDeleteDealFollowerRequest): Promise<DeleteFollowerResponse>;
|
|
725
|
-
/**
|
|
726
|
-
* Deletes a product attachment from a deal, using the `product_attachment_id`.
|
|
727
|
-
* @summary Delete an attached product from a deal
|
|
728
|
-
* @param {DealsApiDeleteDealProductRequest} requestParameters Request parameters.
|
|
729
|
-
|
|
730
|
-
* @throws {RequiredError}
|
|
731
|
-
*/
|
|
732
|
-
deleteDealProduct(requestParameters: DealsApiDeleteDealProductRequest): Promise<DeleteDealProductResponse>;
|
|
733
|
-
/**
|
|
734
|
-
* Removes an installment from a deal. Only available in Growth and above plans.
|
|
735
|
-
* @summary Delete an installment from a deal
|
|
736
|
-
* @param {DealsApiDeleteInstallmentRequest} requestParameters Request parameters.
|
|
737
|
-
|
|
738
|
-
* @throws {RequiredError}
|
|
739
|
-
*/
|
|
740
|
-
deleteInstallment(requestParameters: DealsApiDeleteInstallmentRequest): Promise<DeleteInstallmentResponse>;
|
|
741
|
-
/**
|
|
742
|
-
* Deletes multiple products from a deal. If no product IDs are specified, up to 100 products will be removed from the deal. A maximum of 100 product IDs can be provided per request.
|
|
743
|
-
* @summary Delete many products from a deal
|
|
744
|
-
* @param {DealsApiDeleteManyDealProductsRequest} requestParameters Request parameters.
|
|
745
|
-
|
|
746
|
-
* @throws {RequiredError}
|
|
747
|
-
*/
|
|
748
|
-
deleteManyDealProducts(requestParameters: DealsApiDeleteManyDealProductsRequest): Promise<DeleteManyDealProductResponse>;
|
|
749
483
|
/**
|
|
750
484
|
* Lists discounts attached to a deal.
|
|
751
485
|
* @summary List discounts added to a deal
|
|
@@ -794,14 +528,6 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
794
528
|
* @throws {RequiredError}
|
|
795
529
|
*/
|
|
796
530
|
getDealFollowersChangelog(requestParameters: DealsApiGetDealFollowersChangelogRequest): Promise<GetFollowerChangelogsResponse>;
|
|
797
|
-
/**
|
|
798
|
-
* Lists products attached to a deal.
|
|
799
|
-
* @summary List products attached to a deal
|
|
800
|
-
* @param {DealsApiGetDealProductsRequest} requestParameters Request parameters.
|
|
801
|
-
|
|
802
|
-
* @throws {RequiredError}
|
|
803
|
-
*/
|
|
804
|
-
getDealProducts(requestParameters: DealsApiGetDealProductsRequest): Promise<GetDealsProductsResponse>;
|
|
805
531
|
/**
|
|
806
532
|
* Returns data about all not archived deals.
|
|
807
533
|
* @summary Get all deals
|
|
@@ -810,22 +536,6 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
810
536
|
* @throws {RequiredError}
|
|
811
537
|
*/
|
|
812
538
|
getDeals(requestParameters?: DealsApiGetDealsRequest): Promise<GetDealsResponse>;
|
|
813
|
-
/**
|
|
814
|
-
* Returns data about products attached to deals
|
|
815
|
-
* @summary Get deal products of several deals
|
|
816
|
-
* @param {DealsApiGetDealsProductsRequest} requestParameters Request parameters.
|
|
817
|
-
|
|
818
|
-
* @throws {RequiredError}
|
|
819
|
-
*/
|
|
820
|
-
getDealsProducts(requestParameters: DealsApiGetDealsProductsRequest): Promise<GetDealsProductsResponse>;
|
|
821
|
-
/**
|
|
822
|
-
* Lists installments attached to a list of deals. Only available in Growth and above plans.
|
|
823
|
-
* @summary List installments added to a list of deals
|
|
824
|
-
* @param {DealsApiGetInstallmentsRequest} requestParameters Request parameters.
|
|
825
|
-
|
|
826
|
-
* @throws {RequiredError}
|
|
827
|
-
*/
|
|
828
|
-
getInstallments(requestParameters: DealsApiGetInstallmentsRequest): Promise<GetInstallmentsResponse>;
|
|
829
539
|
/**
|
|
830
540
|
* Adds a discount to a deal, changing the deal value if the deal has one-time products attached.
|
|
831
541
|
* @summary Add a discount to a deal
|
|
@@ -834,14 +544,6 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
834
544
|
* @throws {RequiredError}
|
|
835
545
|
*/
|
|
836
546
|
postAdditionalDiscount(requestParameters: DealsApiPostAdditionalDiscountRequest): Promise<AddAdditionalDiscountResponse>;
|
|
837
|
-
/**
|
|
838
|
-
* Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Growth and above plans.
|
|
839
|
-
* @summary Add an installment to a deal
|
|
840
|
-
* @param {DealsApiPostInstallmentRequest} requestParameters Request parameters.
|
|
841
|
-
|
|
842
|
-
* @throws {RequiredError}
|
|
843
|
-
*/
|
|
844
|
-
postInstallment(requestParameters: DealsApiPostInstallmentRequest): Promise<AddAInstallmentResponse>;
|
|
845
547
|
/**
|
|
846
548
|
* Searches all deals 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 deals can be filtered by the person ID and the organization ID.
|
|
847
549
|
* @summary Search deals
|
|
@@ -866,22 +568,6 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
866
568
|
* @throws {RequiredError}
|
|
867
569
|
*/
|
|
868
570
|
updateDeal(requestParameters: DealsApiUpdateDealRequest): Promise<UpsertDealResponse>;
|
|
869
|
-
/**
|
|
870
|
-
* Updates the details of the product that has been attached to a deal.
|
|
871
|
-
* @summary Update the product attached to a deal
|
|
872
|
-
* @param {DealsApiUpdateDealProductRequest} requestParameters Request parameters.
|
|
873
|
-
|
|
874
|
-
* @throws {RequiredError}
|
|
875
|
-
*/
|
|
876
|
-
updateDealProduct(requestParameters: DealsApiUpdateDealProductRequest): Promise<AddDealProductResponse>;
|
|
877
|
-
/**
|
|
878
|
-
* Edits an installment added to a deal. Only available in Growth and above plans.
|
|
879
|
-
* @summary Update an installment added to a deal
|
|
880
|
-
* @param {DealsApiUpdateInstallmentRequest} requestParameters Request parameters.
|
|
881
|
-
|
|
882
|
-
* @throws {RequiredError}
|
|
883
|
-
*/
|
|
884
|
-
updateInstallment(requestParameters: DealsApiUpdateInstallmentRequest): Promise<UpdateInstallmentResponse>;
|
|
885
571
|
};
|
|
886
572
|
/**
|
|
887
573
|
* Request parameters for addDeal operation in DealsApi.
|
|
@@ -915,44 +601,6 @@ export interface DealsApiAddDealFollowerRequest {
|
|
|
915
601
|
*/
|
|
916
602
|
readonly AddDealFollowerRequest?: AddDealFollowerRequest;
|
|
917
603
|
}
|
|
918
|
-
/**
|
|
919
|
-
* Request parameters for addDealProduct operation in DealsApi.
|
|
920
|
-
* @export
|
|
921
|
-
* @interface DealsApiAddDealProductRequest
|
|
922
|
-
*/
|
|
923
|
-
export interface DealsApiAddDealProductRequest {
|
|
924
|
-
/**
|
|
925
|
-
* The ID of the deal
|
|
926
|
-
* @type {number}
|
|
927
|
-
* @memberof DealsApiAddDealProduct
|
|
928
|
-
*/
|
|
929
|
-
readonly id: number;
|
|
930
|
-
/**
|
|
931
|
-
*
|
|
932
|
-
* @type {AddDealProductRequest}
|
|
933
|
-
* @memberof DealsApiAddDealProduct
|
|
934
|
-
*/
|
|
935
|
-
readonly AddDealProductRequest?: AddDealProductRequest;
|
|
936
|
-
}
|
|
937
|
-
/**
|
|
938
|
-
* Request parameters for addManyDealProducts operation in DealsApi.
|
|
939
|
-
* @export
|
|
940
|
-
* @interface DealsApiAddManyDealProductsRequest
|
|
941
|
-
*/
|
|
942
|
-
export interface DealsApiAddManyDealProductsRequest {
|
|
943
|
-
/**
|
|
944
|
-
* The ID of the deal
|
|
945
|
-
* @type {number}
|
|
946
|
-
* @memberof DealsApiAddManyDealProducts
|
|
947
|
-
*/
|
|
948
|
-
readonly id: number;
|
|
949
|
-
/**
|
|
950
|
-
*
|
|
951
|
-
* @type {CreateManyDealProductRequest}
|
|
952
|
-
* @memberof DealsApiAddManyDealProducts
|
|
953
|
-
*/
|
|
954
|
-
readonly CreateManyDealProductRequest?: CreateManyDealProductRequest;
|
|
955
|
-
}
|
|
956
604
|
/**
|
|
957
605
|
* Request parameters for convertDealToLead operation in DealsApi.
|
|
958
606
|
* @export
|
|
@@ -1017,63 +665,6 @@ export interface DealsApiDeleteDealFollowerRequest {
|
|
|
1017
665
|
*/
|
|
1018
666
|
readonly follower_id: number;
|
|
1019
667
|
}
|
|
1020
|
-
/**
|
|
1021
|
-
* Request parameters for deleteDealProduct operation in DealsApi.
|
|
1022
|
-
* @export
|
|
1023
|
-
* @interface DealsApiDeleteDealProductRequest
|
|
1024
|
-
*/
|
|
1025
|
-
export interface DealsApiDeleteDealProductRequest {
|
|
1026
|
-
/**
|
|
1027
|
-
* The ID of the deal
|
|
1028
|
-
* @type {number}
|
|
1029
|
-
* @memberof DealsApiDeleteDealProduct
|
|
1030
|
-
*/
|
|
1031
|
-
readonly id: number;
|
|
1032
|
-
/**
|
|
1033
|
-
* The product attachment ID
|
|
1034
|
-
* @type {number}
|
|
1035
|
-
* @memberof DealsApiDeleteDealProduct
|
|
1036
|
-
*/
|
|
1037
|
-
readonly product_attachment_id: number;
|
|
1038
|
-
}
|
|
1039
|
-
/**
|
|
1040
|
-
* Request parameters for deleteInstallment operation in DealsApi.
|
|
1041
|
-
* @export
|
|
1042
|
-
* @interface DealsApiDeleteInstallmentRequest
|
|
1043
|
-
*/
|
|
1044
|
-
export interface DealsApiDeleteInstallmentRequest {
|
|
1045
|
-
/**
|
|
1046
|
-
* The ID of the deal
|
|
1047
|
-
* @type {number}
|
|
1048
|
-
* @memberof DealsApiDeleteInstallment
|
|
1049
|
-
*/
|
|
1050
|
-
readonly id: number;
|
|
1051
|
-
/**
|
|
1052
|
-
* The ID of the installment
|
|
1053
|
-
* @type {number}
|
|
1054
|
-
* @memberof DealsApiDeleteInstallment
|
|
1055
|
-
*/
|
|
1056
|
-
readonly installment_id: number;
|
|
1057
|
-
}
|
|
1058
|
-
/**
|
|
1059
|
-
* Request parameters for deleteManyDealProducts operation in DealsApi.
|
|
1060
|
-
* @export
|
|
1061
|
-
* @interface DealsApiDeleteManyDealProductsRequest
|
|
1062
|
-
*/
|
|
1063
|
-
export interface DealsApiDeleteManyDealProductsRequest {
|
|
1064
|
-
/**
|
|
1065
|
-
* The ID of the deal
|
|
1066
|
-
* @type {number}
|
|
1067
|
-
* @memberof DealsApiDeleteManyDealProducts
|
|
1068
|
-
*/
|
|
1069
|
-
readonly id: number;
|
|
1070
|
-
/**
|
|
1071
|
-
* Comma-separated list of deal product IDs to delete. If not provided, all deal products will be deleted up to 100 items. Maximum 100 IDs allowed.
|
|
1072
|
-
* @type {string}
|
|
1073
|
-
* @memberof DealsApiDeleteManyDealProducts
|
|
1074
|
-
*/
|
|
1075
|
-
readonly ids?: string;
|
|
1076
|
-
}
|
|
1077
668
|
/**
|
|
1078
669
|
* Request parameters for getAdditionalDiscounts operation in DealsApi.
|
|
1079
670
|
* @export
|
|
@@ -1214,6 +805,18 @@ export interface DealsApiGetDealRequest {
|
|
|
1214
805
|
* @memberof DealsApiGetDeal
|
|
1215
806
|
*/
|
|
1216
807
|
readonly custom_fields?: string;
|
|
808
|
+
/**
|
|
809
|
+
* When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
810
|
+
* @type {boolean}
|
|
811
|
+
* @memberof DealsApiGetDeal
|
|
812
|
+
*/
|
|
813
|
+
readonly include_option_labels?: boolean;
|
|
814
|
+
/**
|
|
815
|
+
* When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
816
|
+
* @type {boolean}
|
|
817
|
+
* @memberof DealsApiGetDeal
|
|
818
|
+
*/
|
|
819
|
+
readonly include_labels?: boolean;
|
|
1217
820
|
}
|
|
1218
821
|
/**
|
|
1219
822
|
* Request parameters for getDealConversionStatus operation in DealsApi.
|
|
@@ -1284,43 +887,6 @@ export interface DealsApiGetDealFollowersChangelogRequest {
|
|
|
1284
887
|
*/
|
|
1285
888
|
readonly cursor?: string;
|
|
1286
889
|
}
|
|
1287
|
-
/**
|
|
1288
|
-
* Request parameters for getDealProducts operation in DealsApi.
|
|
1289
|
-
* @export
|
|
1290
|
-
* @interface DealsApiGetDealProductsRequest
|
|
1291
|
-
*/
|
|
1292
|
-
export interface DealsApiGetDealProductsRequest {
|
|
1293
|
-
/**
|
|
1294
|
-
* The ID of the deal
|
|
1295
|
-
* @type {number}
|
|
1296
|
-
* @memberof DealsApiGetDealProducts
|
|
1297
|
-
*/
|
|
1298
|
-
readonly id: number;
|
|
1299
|
-
/**
|
|
1300
|
-
* For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
1301
|
-
* @type {string}
|
|
1302
|
-
* @memberof DealsApiGetDealProducts
|
|
1303
|
-
*/
|
|
1304
|
-
readonly cursor?: string;
|
|
1305
|
-
/**
|
|
1306
|
-
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
|
1307
|
-
* @type {number}
|
|
1308
|
-
* @memberof DealsApiGetDealProducts
|
|
1309
|
-
*/
|
|
1310
|
-
readonly limit?: number;
|
|
1311
|
-
/**
|
|
1312
|
-
* The field to sort by. Supported fields: `id`, `add_time`, `update_time`, `order_nr`.
|
|
1313
|
-
* @type {'id' | 'add_time' | 'update_time' | 'order_nr'}
|
|
1314
|
-
* @memberof DealsApiGetDealProducts
|
|
1315
|
-
*/
|
|
1316
|
-
readonly sort_by?: 'id' | 'add_time' | 'update_time' | 'order_nr';
|
|
1317
|
-
/**
|
|
1318
|
-
* The sorting direction. Supported values: `asc`, `desc`.
|
|
1319
|
-
* @type {'asc' | 'desc'}
|
|
1320
|
-
* @memberof DealsApiGetDealProducts
|
|
1321
|
-
*/
|
|
1322
|
-
readonly sort_direction?: 'asc' | 'desc';
|
|
1323
|
-
}
|
|
1324
890
|
/**
|
|
1325
891
|
* Request parameters for getDeals operation in DealsApi.
|
|
1326
892
|
* @export
|
|
@@ -1412,91 +978,29 @@ export interface DealsApiGetDealsRequest {
|
|
|
1412
978
|
*/
|
|
1413
979
|
readonly custom_fields?: string;
|
|
1414
980
|
/**
|
|
1415
|
-
*
|
|
1416
|
-
* @type {
|
|
981
|
+
* When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
982
|
+
* @type {boolean}
|
|
1417
983
|
* @memberof DealsApiGetDeals
|
|
1418
984
|
*/
|
|
1419
|
-
readonly
|
|
985
|
+
readonly include_option_labels?: boolean;
|
|
1420
986
|
/**
|
|
1421
|
-
*
|
|
1422
|
-
* @type {
|
|
987
|
+
* When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
988
|
+
* @type {boolean}
|
|
1423
989
|
* @memberof DealsApiGetDeals
|
|
1424
990
|
*/
|
|
1425
|
-
readonly
|
|
1426
|
-
}
|
|
1427
|
-
/**
|
|
1428
|
-
* Request parameters for getDealsProducts operation in DealsApi.
|
|
1429
|
-
* @export
|
|
1430
|
-
* @interface DealsApiGetDealsProductsRequest
|
|
1431
|
-
*/
|
|
1432
|
-
export interface DealsApiGetDealsProductsRequest {
|
|
1433
|
-
/**
|
|
1434
|
-
* An array of integers with the IDs of the deals for which the attached products will be returned. A maximum of 100 deal IDs can be provided.
|
|
1435
|
-
* @type {Array<number>}
|
|
1436
|
-
* @memberof DealsApiGetDealsProducts
|
|
1437
|
-
*/
|
|
1438
|
-
readonly deal_ids: Array<number>;
|
|
1439
|
-
/**
|
|
1440
|
-
* For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
1441
|
-
* @type {string}
|
|
1442
|
-
* @memberof DealsApiGetDealsProducts
|
|
1443
|
-
*/
|
|
1444
|
-
readonly cursor?: string;
|
|
991
|
+
readonly include_labels?: boolean;
|
|
1445
992
|
/**
|
|
1446
993
|
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
|
1447
994
|
* @type {number}
|
|
1448
|
-
* @memberof
|
|
995
|
+
* @memberof DealsApiGetDeals
|
|
1449
996
|
*/
|
|
1450
997
|
readonly limit?: number;
|
|
1451
|
-
/**
|
|
1452
|
-
* The field to sort by. Supported fields: `id`, `deal_id`, `add_time`, `update_time`, `order_nr`.
|
|
1453
|
-
* @type {'id' | 'deal_id' | 'add_time' | 'update_time' | 'order_nr'}
|
|
1454
|
-
* @memberof DealsApiGetDealsProducts
|
|
1455
|
-
*/
|
|
1456
|
-
readonly sort_by?: 'id' | 'deal_id' | 'add_time' | 'update_time' | 'order_nr';
|
|
1457
|
-
/**
|
|
1458
|
-
* The sorting direction. Supported values: `asc`, `desc`.
|
|
1459
|
-
* @type {'asc' | 'desc'}
|
|
1460
|
-
* @memberof DealsApiGetDealsProducts
|
|
1461
|
-
*/
|
|
1462
|
-
readonly sort_direction?: 'asc' | 'desc';
|
|
1463
|
-
}
|
|
1464
|
-
/**
|
|
1465
|
-
* Request parameters for getInstallments operation in DealsApi.
|
|
1466
|
-
* @export
|
|
1467
|
-
* @interface DealsApiGetInstallmentsRequest
|
|
1468
|
-
*/
|
|
1469
|
-
export interface DealsApiGetInstallmentsRequest {
|
|
1470
|
-
/**
|
|
1471
|
-
* An array of integers with the IDs of the deals for which the attached installments will be returned. A maximum of 100 deal IDs can be provided.
|
|
1472
|
-
* @type {Array<number>}
|
|
1473
|
-
* @memberof DealsApiGetInstallments
|
|
1474
|
-
*/
|
|
1475
|
-
readonly deal_ids: Array<number>;
|
|
1476
998
|
/**
|
|
1477
999
|
* For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
1478
1000
|
* @type {string}
|
|
1479
|
-
* @memberof
|
|
1001
|
+
* @memberof DealsApiGetDeals
|
|
1480
1002
|
*/
|
|
1481
1003
|
readonly cursor?: string;
|
|
1482
|
-
/**
|
|
1483
|
-
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
|
1484
|
-
* @type {number}
|
|
1485
|
-
* @memberof DealsApiGetInstallments
|
|
1486
|
-
*/
|
|
1487
|
-
readonly limit?: number;
|
|
1488
|
-
/**
|
|
1489
|
-
* The field to sort by. Supported fields: `id`, `billing_date`, `deal_id`.
|
|
1490
|
-
* @type {'id' | 'billing_date' | 'deal_id'}
|
|
1491
|
-
* @memberof DealsApiGetInstallments
|
|
1492
|
-
*/
|
|
1493
|
-
readonly sort_by?: 'id' | 'billing_date' | 'deal_id';
|
|
1494
|
-
/**
|
|
1495
|
-
* The sorting direction. Supported values: `asc`, `desc`.
|
|
1496
|
-
* @type {'asc' | 'desc'}
|
|
1497
|
-
* @memberof DealsApiGetInstallments
|
|
1498
|
-
*/
|
|
1499
|
-
readonly sort_direction?: 'asc' | 'desc';
|
|
1500
1004
|
}
|
|
1501
1005
|
/**
|
|
1502
1006
|
* Request parameters for postAdditionalDiscount operation in DealsApi.
|
|
@@ -1517,25 +1021,6 @@ export interface DealsApiPostAdditionalDiscountRequest {
|
|
|
1517
1021
|
*/
|
|
1518
1022
|
readonly AddAdditionalDiscountRequestBody?: AddAdditionalDiscountRequestBody;
|
|
1519
1023
|
}
|
|
1520
|
-
/**
|
|
1521
|
-
* Request parameters for postInstallment operation in DealsApi.
|
|
1522
|
-
* @export
|
|
1523
|
-
* @interface DealsApiPostInstallmentRequest
|
|
1524
|
-
*/
|
|
1525
|
-
export interface DealsApiPostInstallmentRequest {
|
|
1526
|
-
/**
|
|
1527
|
-
* The ID of the deal
|
|
1528
|
-
* @type {number}
|
|
1529
|
-
* @memberof DealsApiPostInstallment
|
|
1530
|
-
*/
|
|
1531
|
-
readonly id: number;
|
|
1532
|
-
/**
|
|
1533
|
-
*
|
|
1534
|
-
* @type {AddInstallmentRequestBody}
|
|
1535
|
-
* @memberof DealsApiPostInstallment
|
|
1536
|
-
*/
|
|
1537
|
-
readonly AddInstallmentRequestBody?: AddInstallmentRequestBody;
|
|
1538
|
-
}
|
|
1539
1024
|
/**
|
|
1540
1025
|
* Request parameters for searchDeals operation in DealsApi.
|
|
1541
1026
|
* @export
|
|
@@ -1641,56 +1126,6 @@ export interface DealsApiUpdateDealRequest {
|
|
|
1641
1126
|
*/
|
|
1642
1127
|
readonly UpdateDealRequest?: UpdateDealRequest;
|
|
1643
1128
|
}
|
|
1644
|
-
/**
|
|
1645
|
-
* Request parameters for updateDealProduct operation in DealsApi.
|
|
1646
|
-
* @export
|
|
1647
|
-
* @interface DealsApiUpdateDealProductRequest
|
|
1648
|
-
*/
|
|
1649
|
-
export interface DealsApiUpdateDealProductRequest {
|
|
1650
|
-
/**
|
|
1651
|
-
* The ID of the deal
|
|
1652
|
-
* @type {number}
|
|
1653
|
-
* @memberof DealsApiUpdateDealProduct
|
|
1654
|
-
*/
|
|
1655
|
-
readonly id: number;
|
|
1656
|
-
/**
|
|
1657
|
-
* The ID of the deal-product (the ID of the product attached to the deal)
|
|
1658
|
-
* @type {number}
|
|
1659
|
-
* @memberof DealsApiUpdateDealProduct
|
|
1660
|
-
*/
|
|
1661
|
-
readonly product_attachment_id: number;
|
|
1662
|
-
/**
|
|
1663
|
-
*
|
|
1664
|
-
* @type {UpdateDealProductRequest}
|
|
1665
|
-
* @memberof DealsApiUpdateDealProduct
|
|
1666
|
-
*/
|
|
1667
|
-
readonly UpdateDealProductRequest?: UpdateDealProductRequest;
|
|
1668
|
-
}
|
|
1669
|
-
/**
|
|
1670
|
-
* Request parameters for updateInstallment operation in DealsApi.
|
|
1671
|
-
* @export
|
|
1672
|
-
* @interface DealsApiUpdateInstallmentRequest
|
|
1673
|
-
*/
|
|
1674
|
-
export interface DealsApiUpdateInstallmentRequest {
|
|
1675
|
-
/**
|
|
1676
|
-
* The ID of the deal
|
|
1677
|
-
* @type {number}
|
|
1678
|
-
* @memberof DealsApiUpdateInstallment
|
|
1679
|
-
*/
|
|
1680
|
-
readonly id: number;
|
|
1681
|
-
/**
|
|
1682
|
-
* The ID of the installment
|
|
1683
|
-
* @type {number}
|
|
1684
|
-
* @memberof DealsApiUpdateInstallment
|
|
1685
|
-
*/
|
|
1686
|
-
readonly installment_id: number;
|
|
1687
|
-
/**
|
|
1688
|
-
*
|
|
1689
|
-
* @type {UpdateInstallmentRequestBody}
|
|
1690
|
-
* @memberof DealsApiUpdateInstallment
|
|
1691
|
-
*/
|
|
1692
|
-
readonly UpdateInstallmentRequestBody?: UpdateInstallmentRequestBody;
|
|
1693
|
-
}
|
|
1694
1129
|
/**
|
|
1695
1130
|
* DealsApi - object-oriented interface
|
|
1696
1131
|
* @export
|
|
@@ -1716,24 +1151,6 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1716
1151
|
* @memberof DealsApi
|
|
1717
1152
|
*/
|
|
1718
1153
|
addDealFollower(requestParameters: DealsApiAddDealFollowerRequest): Promise<AddFollowerResponse>;
|
|
1719
|
-
/**
|
|
1720
|
-
* Adds a product to a deal, creating a new item called a deal-product.
|
|
1721
|
-
* @summary Add a product to a deal
|
|
1722
|
-
* @param {DealsApiAddDealProductRequest} requestParameters Request parameters.
|
|
1723
|
-
|
|
1724
|
-
* @throws {RequiredError}
|
|
1725
|
-
* @memberof DealsApi
|
|
1726
|
-
*/
|
|
1727
|
-
addDealProduct(requestParameters: DealsApiAddDealProductRequest): Promise<AddDealProductResponse>;
|
|
1728
|
-
/**
|
|
1729
|
-
* Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
|
|
1730
|
-
* @summary Add multiple products to a deal
|
|
1731
|
-
* @param {DealsApiAddManyDealProductsRequest} requestParameters Request parameters.
|
|
1732
|
-
|
|
1733
|
-
* @throws {RequiredError}
|
|
1734
|
-
* @memberof DealsApi
|
|
1735
|
-
*/
|
|
1736
|
-
addManyDealProducts(requestParameters: DealsApiAddManyDealProductsRequest): Promise<AddManyDealProductResponse>;
|
|
1737
1154
|
/**
|
|
1738
1155
|
* Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
|
|
1739
1156
|
* @summary Convert a deal to a lead
|
|
@@ -1770,33 +1187,6 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1770
1187
|
* @memberof DealsApi
|
|
1771
1188
|
*/
|
|
1772
1189
|
deleteDealFollower(requestParameters: DealsApiDeleteDealFollowerRequest): Promise<DeleteFollowerResponse>;
|
|
1773
|
-
/**
|
|
1774
|
-
* Deletes a product attachment from a deal, using the `product_attachment_id`.
|
|
1775
|
-
* @summary Delete an attached product from a deal
|
|
1776
|
-
* @param {DealsApiDeleteDealProductRequest} requestParameters Request parameters.
|
|
1777
|
-
|
|
1778
|
-
* @throws {RequiredError}
|
|
1779
|
-
* @memberof DealsApi
|
|
1780
|
-
*/
|
|
1781
|
-
deleteDealProduct(requestParameters: DealsApiDeleteDealProductRequest): Promise<DeleteDealProductResponse>;
|
|
1782
|
-
/**
|
|
1783
|
-
* Removes an installment from a deal. Only available in Growth and above plans.
|
|
1784
|
-
* @summary Delete an installment from a deal
|
|
1785
|
-
* @param {DealsApiDeleteInstallmentRequest} requestParameters Request parameters.
|
|
1786
|
-
|
|
1787
|
-
* @throws {RequiredError}
|
|
1788
|
-
* @memberof DealsApi
|
|
1789
|
-
*/
|
|
1790
|
-
deleteInstallment(requestParameters: DealsApiDeleteInstallmentRequest): Promise<DeleteInstallmentResponse>;
|
|
1791
|
-
/**
|
|
1792
|
-
* Deletes multiple products from a deal. If no product IDs are specified, up to 100 products will be removed from the deal. A maximum of 100 product IDs can be provided per request.
|
|
1793
|
-
* @summary Delete many products from a deal
|
|
1794
|
-
* @param {DealsApiDeleteManyDealProductsRequest} requestParameters Request parameters.
|
|
1795
|
-
|
|
1796
|
-
* @throws {RequiredError}
|
|
1797
|
-
* @memberof DealsApi
|
|
1798
|
-
*/
|
|
1799
|
-
deleteManyDealProducts(requestParameters: DealsApiDeleteManyDealProductsRequest): Promise<DeleteManyDealProductResponse>;
|
|
1800
1190
|
/**
|
|
1801
1191
|
* Lists discounts attached to a deal.
|
|
1802
1192
|
* @summary List discounts added to a deal
|
|
@@ -1851,15 +1241,6 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1851
1241
|
* @memberof DealsApi
|
|
1852
1242
|
*/
|
|
1853
1243
|
getDealFollowersChangelog(requestParameters: DealsApiGetDealFollowersChangelogRequest): Promise<GetFollowerChangelogsResponse>;
|
|
1854
|
-
/**
|
|
1855
|
-
* Lists products attached to a deal.
|
|
1856
|
-
* @summary List products attached to a deal
|
|
1857
|
-
* @param {DealsApiGetDealProductsRequest} requestParameters Request parameters.
|
|
1858
|
-
|
|
1859
|
-
* @throws {RequiredError}
|
|
1860
|
-
* @memberof DealsApi
|
|
1861
|
-
*/
|
|
1862
|
-
getDealProducts(requestParameters: DealsApiGetDealProductsRequest): Promise<GetDealsProductsResponse>;
|
|
1863
1244
|
/**
|
|
1864
1245
|
* Returns data about all not archived deals.
|
|
1865
1246
|
* @summary Get all deals
|
|
@@ -1869,24 +1250,6 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1869
1250
|
* @memberof DealsApi
|
|
1870
1251
|
*/
|
|
1871
1252
|
getDeals(requestParameters?: DealsApiGetDealsRequest): Promise<GetDealsResponse>;
|
|
1872
|
-
/**
|
|
1873
|
-
* Returns data about products attached to deals
|
|
1874
|
-
* @summary Get deal products of several deals
|
|
1875
|
-
* @param {DealsApiGetDealsProductsRequest} requestParameters Request parameters.
|
|
1876
|
-
|
|
1877
|
-
* @throws {RequiredError}
|
|
1878
|
-
* @memberof DealsApi
|
|
1879
|
-
*/
|
|
1880
|
-
getDealsProducts(requestParameters: DealsApiGetDealsProductsRequest): Promise<GetDealsProductsResponse>;
|
|
1881
|
-
/**
|
|
1882
|
-
* Lists installments attached to a list of deals. Only available in Growth and above plans.
|
|
1883
|
-
* @summary List installments added to a list of deals
|
|
1884
|
-
* @param {DealsApiGetInstallmentsRequest} requestParameters Request parameters.
|
|
1885
|
-
|
|
1886
|
-
* @throws {RequiredError}
|
|
1887
|
-
* @memberof DealsApi
|
|
1888
|
-
*/
|
|
1889
|
-
getInstallments(requestParameters: DealsApiGetInstallmentsRequest): Promise<GetInstallmentsResponse>;
|
|
1890
1253
|
/**
|
|
1891
1254
|
* Adds a discount to a deal, changing the deal value if the deal has one-time products attached.
|
|
1892
1255
|
* @summary Add a discount to a deal
|
|
@@ -1896,15 +1259,6 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1896
1259
|
* @memberof DealsApi
|
|
1897
1260
|
*/
|
|
1898
1261
|
postAdditionalDiscount(requestParameters: DealsApiPostAdditionalDiscountRequest): Promise<AddAdditionalDiscountResponse>;
|
|
1899
|
-
/**
|
|
1900
|
-
* Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Growth and above plans.
|
|
1901
|
-
* @summary Add an installment to a deal
|
|
1902
|
-
* @param {DealsApiPostInstallmentRequest} requestParameters Request parameters.
|
|
1903
|
-
|
|
1904
|
-
* @throws {RequiredError}
|
|
1905
|
-
* @memberof DealsApi
|
|
1906
|
-
*/
|
|
1907
|
-
postInstallment(requestParameters: DealsApiPostInstallmentRequest): Promise<AddAInstallmentResponse>;
|
|
1908
1262
|
/**
|
|
1909
1263
|
* Searches all deals 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 deals can be filtered by the person ID and the organization ID.
|
|
1910
1264
|
* @summary Search deals
|
|
@@ -1932,22 +1286,4 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1932
1286
|
* @memberof DealsApi
|
|
1933
1287
|
*/
|
|
1934
1288
|
updateDeal(requestParameters: DealsApiUpdateDealRequest): Promise<UpsertDealResponse>;
|
|
1935
|
-
/**
|
|
1936
|
-
* Updates the details of the product that has been attached to a deal.
|
|
1937
|
-
* @summary Update the product attached to a deal
|
|
1938
|
-
* @param {DealsApiUpdateDealProductRequest} requestParameters Request parameters.
|
|
1939
|
-
|
|
1940
|
-
* @throws {RequiredError}
|
|
1941
|
-
* @memberof DealsApi
|
|
1942
|
-
*/
|
|
1943
|
-
updateDealProduct(requestParameters: DealsApiUpdateDealProductRequest): Promise<AddDealProductResponse>;
|
|
1944
|
-
/**
|
|
1945
|
-
* Edits an installment added to a deal. Only available in Growth and above plans.
|
|
1946
|
-
* @summary Update an installment added to a deal
|
|
1947
|
-
* @param {DealsApiUpdateInstallmentRequest} requestParameters Request parameters.
|
|
1948
|
-
|
|
1949
|
-
* @throws {RequiredError}
|
|
1950
|
-
* @memberof DealsApi
|
|
1951
|
-
*/
|
|
1952
|
-
updateInstallment(requestParameters: DealsApiUpdateInstallmentRequest): Promise<UpdateInstallmentResponse>;
|
|
1953
1289
|
}
|