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
|
@@ -102,80 +102,6 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
102
102
|
options: localVarRequestOptions,
|
|
103
103
|
};
|
|
104
104
|
}),
|
|
105
|
-
/**
|
|
106
|
-
* Adds a product to a deal, creating a new item called a deal-product.
|
|
107
|
-
* @summary Add a product to a deal
|
|
108
|
-
* @param {number} id The ID of the deal
|
|
109
|
-
* @param {AddDealProductRequest} [AddDealProductRequest]
|
|
110
|
-
|
|
111
|
-
* @throws {RequiredError}
|
|
112
|
-
*/
|
|
113
|
-
addDealProduct: (id, AddDealProductRequest) => __awaiter(this, void 0, void 0, function* () {
|
|
114
|
-
// verify required parameter 'id' is not null or undefined
|
|
115
|
-
assertParamExists('addDealProduct', 'id', id);
|
|
116
|
-
const localVarPath = `/deals/{id}/products`
|
|
117
|
-
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
118
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
119
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
120
|
-
let baseOptions;
|
|
121
|
-
if (configuration) {
|
|
122
|
-
baseOptions = configuration.baseOptions;
|
|
123
|
-
}
|
|
124
|
-
const localVarRequestOptions = Object.assign({ method: 'POST' }, baseOptions);
|
|
125
|
-
const localVarHeaderParameter = {};
|
|
126
|
-
const localVarQueryParameter = {};
|
|
127
|
-
// authentication api_key required
|
|
128
|
-
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
|
129
|
-
// authentication oauth2 required
|
|
130
|
-
// oauth required
|
|
131
|
-
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:full", "deals:full"], configuration);
|
|
132
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
133
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
134
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
135
|
-
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
136
|
-
localVarRequestOptions.data = serializeDataIfNeeded(AddDealProductRequest, localVarRequestOptions, configuration);
|
|
137
|
-
return {
|
|
138
|
-
url: toPathString(localVarUrlObj),
|
|
139
|
-
options: localVarRequestOptions,
|
|
140
|
-
};
|
|
141
|
-
}),
|
|
142
|
-
/**
|
|
143
|
-
* Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
|
|
144
|
-
* @summary Add multiple products to a deal
|
|
145
|
-
* @param {number} id The ID of the deal
|
|
146
|
-
* @param {CreateManyDealProductRequest} [CreateManyDealProductRequest]
|
|
147
|
-
|
|
148
|
-
* @throws {RequiredError}
|
|
149
|
-
*/
|
|
150
|
-
addManyDealProducts: (id, CreateManyDealProductRequest) => __awaiter(this, void 0, void 0, function* () {
|
|
151
|
-
// verify required parameter 'id' is not null or undefined
|
|
152
|
-
assertParamExists('addManyDealProducts', 'id', id);
|
|
153
|
-
const localVarPath = `/deals/{id}/products/bulk`
|
|
154
|
-
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
155
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
156
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
157
|
-
let baseOptions;
|
|
158
|
-
if (configuration) {
|
|
159
|
-
baseOptions = configuration.baseOptions;
|
|
160
|
-
}
|
|
161
|
-
const localVarRequestOptions = Object.assign({ method: 'POST' }, baseOptions);
|
|
162
|
-
const localVarHeaderParameter = {};
|
|
163
|
-
const localVarQueryParameter = {};
|
|
164
|
-
// authentication api_key required
|
|
165
|
-
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
|
166
|
-
// authentication oauth2 required
|
|
167
|
-
// oauth required
|
|
168
|
-
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:full", "deals:full"], configuration);
|
|
169
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
170
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
171
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
172
|
-
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
173
|
-
localVarRequestOptions.data = serializeDataIfNeeded(CreateManyDealProductRequest, localVarRequestOptions, configuration);
|
|
174
|
-
return {
|
|
175
|
-
url: toPathString(localVarUrlObj),
|
|
176
|
-
options: localVarRequestOptions,
|
|
177
|
-
};
|
|
178
|
-
}),
|
|
179
105
|
/**
|
|
180
106
|
* 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.
|
|
181
107
|
* @summary Convert a deal to a lead
|
|
@@ -320,120 +246,6 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
320
246
|
options: localVarRequestOptions,
|
|
321
247
|
};
|
|
322
248
|
}),
|
|
323
|
-
/**
|
|
324
|
-
* Deletes a product attachment from a deal, using the `product_attachment_id`.
|
|
325
|
-
* @summary Delete an attached product from a deal
|
|
326
|
-
* @param {number} id The ID of the deal
|
|
327
|
-
* @param {number} product_attachment_id The product attachment ID
|
|
328
|
-
|
|
329
|
-
* @throws {RequiredError}
|
|
330
|
-
*/
|
|
331
|
-
deleteDealProduct: (id, product_attachment_id) => __awaiter(this, void 0, void 0, function* () {
|
|
332
|
-
// verify required parameter 'id' is not null or undefined
|
|
333
|
-
assertParamExists('deleteDealProduct', 'id', id);
|
|
334
|
-
// verify required parameter 'product_attachment_id' is not null or undefined
|
|
335
|
-
assertParamExists('deleteDealProduct', 'product_attachment_id', product_attachment_id);
|
|
336
|
-
const localVarPath = `/deals/{id}/products/{product_attachment_id}`
|
|
337
|
-
.replace(`{${"id"}}`, encodeURIComponent(String(id)))
|
|
338
|
-
.replace(`{${"product_attachment_id"}}`, encodeURIComponent(String(product_attachment_id)));
|
|
339
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
340
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
341
|
-
let baseOptions;
|
|
342
|
-
if (configuration) {
|
|
343
|
-
baseOptions = configuration.baseOptions;
|
|
344
|
-
}
|
|
345
|
-
const localVarRequestOptions = Object.assign({ method: 'DELETE' }, baseOptions);
|
|
346
|
-
const localVarHeaderParameter = {};
|
|
347
|
-
const localVarQueryParameter = {};
|
|
348
|
-
// authentication api_key required
|
|
349
|
-
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
|
350
|
-
// authentication oauth2 required
|
|
351
|
-
// oauth required
|
|
352
|
-
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:full", "products:full"], configuration);
|
|
353
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
354
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
355
|
-
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
356
|
-
return {
|
|
357
|
-
url: toPathString(localVarUrlObj),
|
|
358
|
-
options: localVarRequestOptions,
|
|
359
|
-
};
|
|
360
|
-
}),
|
|
361
|
-
/**
|
|
362
|
-
* Removes an installment from a deal. Only available in Growth and above plans.
|
|
363
|
-
* @summary Delete an installment from a deal
|
|
364
|
-
* @param {number} id The ID of the deal
|
|
365
|
-
* @param {number} installment_id The ID of the installment
|
|
366
|
-
|
|
367
|
-
* @throws {RequiredError}
|
|
368
|
-
*/
|
|
369
|
-
deleteInstallment: (id, installment_id) => __awaiter(this, void 0, void 0, function* () {
|
|
370
|
-
// verify required parameter 'id' is not null or undefined
|
|
371
|
-
assertParamExists('deleteInstallment', 'id', id);
|
|
372
|
-
// verify required parameter 'installment_id' is not null or undefined
|
|
373
|
-
assertParamExists('deleteInstallment', 'installment_id', installment_id);
|
|
374
|
-
const localVarPath = `/deals/{id}/installments/{installment_id}`
|
|
375
|
-
.replace(`{${"id"}}`, encodeURIComponent(String(id)))
|
|
376
|
-
.replace(`{${"installment_id"}}`, encodeURIComponent(String(installment_id)));
|
|
377
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
378
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
379
|
-
let baseOptions;
|
|
380
|
-
if (configuration) {
|
|
381
|
-
baseOptions = configuration.baseOptions;
|
|
382
|
-
}
|
|
383
|
-
const localVarRequestOptions = Object.assign({ method: 'DELETE' }, baseOptions);
|
|
384
|
-
const localVarHeaderParameter = {};
|
|
385
|
-
const localVarQueryParameter = {};
|
|
386
|
-
// authentication api_key required
|
|
387
|
-
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
|
388
|
-
// authentication oauth2 required
|
|
389
|
-
// oauth required
|
|
390
|
-
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration);
|
|
391
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
392
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
393
|
-
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
394
|
-
return {
|
|
395
|
-
url: toPathString(localVarUrlObj),
|
|
396
|
-
options: localVarRequestOptions,
|
|
397
|
-
};
|
|
398
|
-
}),
|
|
399
|
-
/**
|
|
400
|
-
* 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.
|
|
401
|
-
* @summary Delete many products from a deal
|
|
402
|
-
* @param {number} id The ID of the deal
|
|
403
|
-
* @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.
|
|
404
|
-
|
|
405
|
-
* @throws {RequiredError}
|
|
406
|
-
*/
|
|
407
|
-
deleteManyDealProducts: (id, ids) => __awaiter(this, void 0, void 0, function* () {
|
|
408
|
-
// verify required parameter 'id' is not null or undefined
|
|
409
|
-
assertParamExists('deleteManyDealProducts', 'id', id);
|
|
410
|
-
const localVarPath = `/deals/{id}/products`
|
|
411
|
-
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
412
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
413
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
414
|
-
let baseOptions;
|
|
415
|
-
if (configuration) {
|
|
416
|
-
baseOptions = configuration.baseOptions;
|
|
417
|
-
}
|
|
418
|
-
const localVarRequestOptions = Object.assign({ method: 'DELETE' }, baseOptions);
|
|
419
|
-
const localVarHeaderParameter = {};
|
|
420
|
-
const localVarQueryParameter = {};
|
|
421
|
-
// authentication api_key required
|
|
422
|
-
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
|
423
|
-
// authentication oauth2 required
|
|
424
|
-
// oauth required
|
|
425
|
-
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:full", "deals:full"], configuration);
|
|
426
|
-
if (ids !== undefined) {
|
|
427
|
-
localVarQueryParameter['ids'] = ids;
|
|
428
|
-
}
|
|
429
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
430
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
431
|
-
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
432
|
-
return {
|
|
433
|
-
url: toPathString(localVarUrlObj),
|
|
434
|
-
options: localVarRequestOptions,
|
|
435
|
-
};
|
|
436
|
-
}),
|
|
437
249
|
/**
|
|
438
250
|
* Lists discounts attached to a deal.
|
|
439
251
|
* @summary List discounts added to a deal
|
|
@@ -568,10 +380,12 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
568
380
|
* @param {number} id The ID of the deal
|
|
569
381
|
* @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
|
|
570
382
|
* @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.
|
|
383
|
+
* @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
|
|
384
|
+
* @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 }\'
|
|
571
385
|
|
|
572
386
|
* @throws {RequiredError}
|
|
573
387
|
*/
|
|
574
|
-
getDeal: (id, include_fields, custom_fields) => __awaiter(this, void 0, void 0, function* () {
|
|
388
|
+
getDeal: (id, include_fields, custom_fields, include_option_labels, include_labels) => __awaiter(this, void 0, void 0, function* () {
|
|
575
389
|
// verify required parameter 'id' is not null or undefined
|
|
576
390
|
assertParamExists('getDeal', 'id', id);
|
|
577
391
|
const localVarPath = `/deals/{id}`
|
|
@@ -596,6 +410,12 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
596
410
|
if (custom_fields !== undefined) {
|
|
597
411
|
localVarQueryParameter['custom_fields'] = custom_fields;
|
|
598
412
|
}
|
|
413
|
+
if (include_option_labels !== undefined) {
|
|
414
|
+
localVarQueryParameter['include_option_labels'] = include_option_labels;
|
|
415
|
+
}
|
|
416
|
+
if (include_labels !== undefined) {
|
|
417
|
+
localVarQueryParameter['include_labels'] = include_labels;
|
|
418
|
+
}
|
|
599
419
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
600
420
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
601
421
|
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
@@ -726,56 +546,6 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
726
546
|
options: localVarRequestOptions,
|
|
727
547
|
};
|
|
728
548
|
}),
|
|
729
|
-
/**
|
|
730
|
-
* Lists products attached to a deal.
|
|
731
|
-
* @summary List products attached to a deal
|
|
732
|
-
* @param {number} id The ID of the deal
|
|
733
|
-
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
734
|
-
* @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.
|
|
735
|
-
* @param {'id' | 'add_time' | 'update_time' | 'order_nr'} [sort_by] The field to sort by. Supported fields: `id`, `add_time`, `update_time`, `order_nr`.
|
|
736
|
-
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
737
|
-
|
|
738
|
-
* @throws {RequiredError}
|
|
739
|
-
*/
|
|
740
|
-
getDealProducts: (id, cursor, limit, sort_by, sort_direction) => __awaiter(this, void 0, void 0, function* () {
|
|
741
|
-
// verify required parameter 'id' is not null or undefined
|
|
742
|
-
assertParamExists('getDealProducts', 'id', id);
|
|
743
|
-
const localVarPath = `/deals/{id}/products`
|
|
744
|
-
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
745
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
746
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
747
|
-
let baseOptions;
|
|
748
|
-
if (configuration) {
|
|
749
|
-
baseOptions = configuration.baseOptions;
|
|
750
|
-
}
|
|
751
|
-
const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
|
|
752
|
-
const localVarHeaderParameter = {};
|
|
753
|
-
const localVarQueryParameter = {};
|
|
754
|
-
// authentication api_key required
|
|
755
|
-
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
|
756
|
-
// authentication oauth2 required
|
|
757
|
-
// oauth required
|
|
758
|
-
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:read", "products:full", "deals:read", "deals:full"], configuration);
|
|
759
|
-
if (cursor !== undefined) {
|
|
760
|
-
localVarQueryParameter['cursor'] = cursor;
|
|
761
|
-
}
|
|
762
|
-
if (limit !== undefined) {
|
|
763
|
-
localVarQueryParameter['limit'] = limit;
|
|
764
|
-
}
|
|
765
|
-
if (sort_by !== undefined) {
|
|
766
|
-
localVarQueryParameter['sort_by'] = sort_by;
|
|
767
|
-
}
|
|
768
|
-
if (sort_direction !== undefined) {
|
|
769
|
-
localVarQueryParameter['sort_direction'] = sort_direction;
|
|
770
|
-
}
|
|
771
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
772
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
773
|
-
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
774
|
-
return {
|
|
775
|
-
url: toPathString(localVarUrlObj),
|
|
776
|
-
options: localVarRequestOptions,
|
|
777
|
-
};
|
|
778
|
-
}),
|
|
779
549
|
/**
|
|
780
550
|
* Returns data about all not archived deals.
|
|
781
551
|
* @summary Get all deals
|
|
@@ -793,12 +563,14 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
793
563
|
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
794
564
|
* @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
|
|
795
565
|
* @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.
|
|
566
|
+
* @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
|
|
567
|
+
* @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 }\'
|
|
796
568
|
* @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.
|
|
797
569
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
798
570
|
|
|
799
571
|
* @throws {RequiredError}
|
|
800
572
|
*/
|
|
801
|
-
getDeals: (filter_id, ids, owner_id, person_id, org_id, pipeline_id, stage_id, status, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
|
|
573
|
+
getDeals: (filter_id, ids, owner_id, person_id, org_id, pipeline_id, stage_id, status, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, include_option_labels, include_labels, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
|
|
802
574
|
const localVarPath = `/deals`;
|
|
803
575
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
804
576
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -856,116 +628,18 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
856
628
|
if (custom_fields !== undefined) {
|
|
857
629
|
localVarQueryParameter['custom_fields'] = custom_fields;
|
|
858
630
|
}
|
|
859
|
-
if (
|
|
860
|
-
localVarQueryParameter['
|
|
861
|
-
}
|
|
862
|
-
if (cursor !== undefined) {
|
|
863
|
-
localVarQueryParameter['cursor'] = cursor;
|
|
864
|
-
}
|
|
865
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
866
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
867
|
-
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
868
|
-
return {
|
|
869
|
-
url: toPathString(localVarUrlObj),
|
|
870
|
-
options: localVarRequestOptions,
|
|
871
|
-
};
|
|
872
|
-
}),
|
|
873
|
-
/**
|
|
874
|
-
* Returns data about products attached to deals
|
|
875
|
-
* @summary Get deal products of several deals
|
|
876
|
-
* @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.
|
|
877
|
-
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
878
|
-
* @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.
|
|
879
|
-
* @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`.
|
|
880
|
-
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
881
|
-
|
|
882
|
-
* @throws {RequiredError}
|
|
883
|
-
*/
|
|
884
|
-
getDealsProducts: (deal_ids, cursor, limit, sort_by, sort_direction) => __awaiter(this, void 0, void 0, function* () {
|
|
885
|
-
// verify required parameter 'deal_ids' is not null or undefined
|
|
886
|
-
assertParamExists('getDealsProducts', 'deal_ids', deal_ids);
|
|
887
|
-
const localVarPath = `/deals/products`;
|
|
888
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
889
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
890
|
-
let baseOptions;
|
|
891
|
-
if (configuration) {
|
|
892
|
-
baseOptions = configuration.baseOptions;
|
|
893
|
-
}
|
|
894
|
-
const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
|
|
895
|
-
const localVarHeaderParameter = {};
|
|
896
|
-
const localVarQueryParameter = {};
|
|
897
|
-
// authentication api_key required
|
|
898
|
-
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
|
899
|
-
// authentication oauth2 required
|
|
900
|
-
// oauth required
|
|
901
|
-
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:read", "products:full", "deals:read", "deals:full"], configuration);
|
|
902
|
-
if (deal_ids) {
|
|
903
|
-
localVarQueryParameter['deal_ids'] = deal_ids;
|
|
631
|
+
if (include_option_labels !== undefined) {
|
|
632
|
+
localVarQueryParameter['include_option_labels'] = include_option_labels;
|
|
904
633
|
}
|
|
905
|
-
if (
|
|
906
|
-
localVarQueryParameter['
|
|
634
|
+
if (include_labels !== undefined) {
|
|
635
|
+
localVarQueryParameter['include_labels'] = include_labels;
|
|
907
636
|
}
|
|
908
637
|
if (limit !== undefined) {
|
|
909
638
|
localVarQueryParameter['limit'] = limit;
|
|
910
639
|
}
|
|
911
|
-
if (sort_by !== undefined) {
|
|
912
|
-
localVarQueryParameter['sort_by'] = sort_by;
|
|
913
|
-
}
|
|
914
|
-
if (sort_direction !== undefined) {
|
|
915
|
-
localVarQueryParameter['sort_direction'] = sort_direction;
|
|
916
|
-
}
|
|
917
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
918
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
919
|
-
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
920
|
-
return {
|
|
921
|
-
url: toPathString(localVarUrlObj),
|
|
922
|
-
options: localVarRequestOptions,
|
|
923
|
-
};
|
|
924
|
-
}),
|
|
925
|
-
/**
|
|
926
|
-
* Lists installments attached to a list of deals. Only available in Growth and above plans.
|
|
927
|
-
* @summary List installments added to a list of deals
|
|
928
|
-
* @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.
|
|
929
|
-
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
930
|
-
* @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.
|
|
931
|
-
* @param {'id' | 'billing_date' | 'deal_id'} [sort_by] The field to sort by. Supported fields: `id`, `billing_date`, `deal_id`.
|
|
932
|
-
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
933
|
-
|
|
934
|
-
* @throws {RequiredError}
|
|
935
|
-
*/
|
|
936
|
-
getInstallments: (deal_ids, cursor, limit, sort_by, sort_direction) => __awaiter(this, void 0, void 0, function* () {
|
|
937
|
-
// verify required parameter 'deal_ids' is not null or undefined
|
|
938
|
-
assertParamExists('getInstallments', 'deal_ids', deal_ids);
|
|
939
|
-
const localVarPath = `/deals/installments`;
|
|
940
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
941
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
942
|
-
let baseOptions;
|
|
943
|
-
if (configuration) {
|
|
944
|
-
baseOptions = configuration.baseOptions;
|
|
945
|
-
}
|
|
946
|
-
const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
|
|
947
|
-
const localVarHeaderParameter = {};
|
|
948
|
-
const localVarQueryParameter = {};
|
|
949
|
-
// authentication api_key required
|
|
950
|
-
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
|
951
|
-
// authentication oauth2 required
|
|
952
|
-
// oauth required
|
|
953
|
-
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration);
|
|
954
|
-
if (deal_ids) {
|
|
955
|
-
localVarQueryParameter['deal_ids'] = deal_ids;
|
|
956
|
-
}
|
|
957
640
|
if (cursor !== undefined) {
|
|
958
641
|
localVarQueryParameter['cursor'] = cursor;
|
|
959
642
|
}
|
|
960
|
-
if (limit !== undefined) {
|
|
961
|
-
localVarQueryParameter['limit'] = limit;
|
|
962
|
-
}
|
|
963
|
-
if (sort_by !== undefined) {
|
|
964
|
-
localVarQueryParameter['sort_by'] = sort_by;
|
|
965
|
-
}
|
|
966
|
-
if (sort_direction !== undefined) {
|
|
967
|
-
localVarQueryParameter['sort_direction'] = sort_direction;
|
|
968
|
-
}
|
|
969
643
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
970
644
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
971
645
|
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
@@ -1011,43 +685,6 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
1011
685
|
options: localVarRequestOptions,
|
|
1012
686
|
};
|
|
1013
687
|
}),
|
|
1014
|
-
/**
|
|
1015
|
-
* 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.
|
|
1016
|
-
* @summary Add an installment to a deal
|
|
1017
|
-
* @param {number} id The ID of the deal
|
|
1018
|
-
* @param {AddInstallmentRequestBody} [AddInstallmentRequestBody]
|
|
1019
|
-
|
|
1020
|
-
* @throws {RequiredError}
|
|
1021
|
-
*/
|
|
1022
|
-
postInstallment: (id, AddInstallmentRequestBody) => __awaiter(this, void 0, void 0, function* () {
|
|
1023
|
-
// verify required parameter 'id' is not null or undefined
|
|
1024
|
-
assertParamExists('postInstallment', 'id', id);
|
|
1025
|
-
const localVarPath = `/deals/{id}/installments`
|
|
1026
|
-
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
1027
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1028
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1029
|
-
let baseOptions;
|
|
1030
|
-
if (configuration) {
|
|
1031
|
-
baseOptions = configuration.baseOptions;
|
|
1032
|
-
}
|
|
1033
|
-
const localVarRequestOptions = Object.assign({ method: 'POST' }, baseOptions);
|
|
1034
|
-
const localVarHeaderParameter = {};
|
|
1035
|
-
const localVarQueryParameter = {};
|
|
1036
|
-
// authentication api_key required
|
|
1037
|
-
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
|
1038
|
-
// authentication oauth2 required
|
|
1039
|
-
// oauth required
|
|
1040
|
-
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration);
|
|
1041
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1042
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1043
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1044
|
-
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
1045
|
-
localVarRequestOptions.data = serializeDataIfNeeded(AddInstallmentRequestBody, localVarRequestOptions, configuration);
|
|
1046
|
-
return {
|
|
1047
|
-
url: toPathString(localVarUrlObj),
|
|
1048
|
-
options: localVarRequestOptions,
|
|
1049
|
-
};
|
|
1050
|
-
}),
|
|
1051
688
|
/**
|
|
1052
689
|
* 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.
|
|
1053
690
|
* @summary Search deals
|
|
@@ -1103,114 +740,36 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
1103
740
|
localVarQueryParameter['include_fields'] = include_fields;
|
|
1104
741
|
}
|
|
1105
742
|
if (limit !== undefined) {
|
|
1106
|
-
localVarQueryParameter['limit'] = limit;
|
|
1107
|
-
}
|
|
1108
|
-
if (cursor !== undefined) {
|
|
1109
|
-
localVarQueryParameter['cursor'] = cursor;
|
|
1110
|
-
}
|
|
1111
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1112
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1113
|
-
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
1114
|
-
return {
|
|
1115
|
-
url: toPathString(localVarUrlObj),
|
|
1116
|
-
options: localVarRequestOptions,
|
|
1117
|
-
};
|
|
1118
|
-
}),
|
|
1119
|
-
/**
|
|
1120
|
-
* Edits a discount added to a deal, changing the deal value if the deal has one-time products attached.
|
|
1121
|
-
* @summary Update a discount added to a deal
|
|
1122
|
-
* @param {number} id The ID of the deal
|
|
1123
|
-
* @param {string} discount_id The ID of the discount
|
|
1124
|
-
* @param {UpdateAdditionalDiscountRequestBody} [UpdateAdditionalDiscountRequestBody]
|
|
1125
|
-
|
|
1126
|
-
* @throws {RequiredError}
|
|
1127
|
-
*/
|
|
1128
|
-
updateAdditionalDiscount: (id, discount_id, UpdateAdditionalDiscountRequestBody) => __awaiter(this, void 0, void 0, function* () {
|
|
1129
|
-
// verify required parameter 'id' is not null or undefined
|
|
1130
|
-
assertParamExists('updateAdditionalDiscount', 'id', id);
|
|
1131
|
-
// verify required parameter 'discount_id' is not null or undefined
|
|
1132
|
-
assertParamExists('updateAdditionalDiscount', 'discount_id', discount_id);
|
|
1133
|
-
const localVarPath = `/deals/{id}/discounts/{discount_id}`
|
|
1134
|
-
.replace(`{${"id"}}`, encodeURIComponent(String(id)))
|
|
1135
|
-
.replace(`{${"discount_id"}}`, encodeURIComponent(String(discount_id)));
|
|
1136
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1137
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1138
|
-
let baseOptions;
|
|
1139
|
-
if (configuration) {
|
|
1140
|
-
baseOptions = configuration.baseOptions;
|
|
1141
|
-
}
|
|
1142
|
-
const localVarRequestOptions = Object.assign({ method: 'PATCH' }, baseOptions);
|
|
1143
|
-
const localVarHeaderParameter = {};
|
|
1144
|
-
const localVarQueryParameter = {};
|
|
1145
|
-
// authentication api_key required
|
|
1146
|
-
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
|
1147
|
-
// authentication oauth2 required
|
|
1148
|
-
// oauth required
|
|
1149
|
-
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration);
|
|
1150
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1151
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1152
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1153
|
-
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
1154
|
-
localVarRequestOptions.data = serializeDataIfNeeded(UpdateAdditionalDiscountRequestBody, localVarRequestOptions, configuration);
|
|
1155
|
-
return {
|
|
1156
|
-
url: toPathString(localVarUrlObj),
|
|
1157
|
-
options: localVarRequestOptions,
|
|
1158
|
-
};
|
|
1159
|
-
}),
|
|
1160
|
-
/**
|
|
1161
|
-
* Updates the properties of a deal.
|
|
1162
|
-
* @summary Update a deal
|
|
1163
|
-
* @param {number} id The ID of the deal
|
|
1164
|
-
* @param {UpdateDealRequest} [UpdateDealRequest]
|
|
1165
|
-
|
|
1166
|
-
* @throws {RequiredError}
|
|
1167
|
-
*/
|
|
1168
|
-
updateDeal: (id, UpdateDealRequest) => __awaiter(this, void 0, void 0, function* () {
|
|
1169
|
-
// verify required parameter 'id' is not null or undefined
|
|
1170
|
-
assertParamExists('updateDeal', 'id', id);
|
|
1171
|
-
const localVarPath = `/deals/{id}`
|
|
1172
|
-
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
1173
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1174
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1175
|
-
let baseOptions;
|
|
1176
|
-
if (configuration) {
|
|
1177
|
-
baseOptions = configuration.baseOptions;
|
|
1178
|
-
}
|
|
1179
|
-
const localVarRequestOptions = Object.assign({ method: 'PATCH' }, baseOptions);
|
|
1180
|
-
const localVarHeaderParameter = {};
|
|
1181
|
-
const localVarQueryParameter = {};
|
|
1182
|
-
// authentication api_key required
|
|
1183
|
-
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
|
1184
|
-
// authentication oauth2 required
|
|
1185
|
-
// oauth required
|
|
1186
|
-
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:full"], configuration);
|
|
1187
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
743
|
+
localVarQueryParameter['limit'] = limit;
|
|
744
|
+
}
|
|
745
|
+
if (cursor !== undefined) {
|
|
746
|
+
localVarQueryParameter['cursor'] = cursor;
|
|
747
|
+
}
|
|
1188
748
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1189
749
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1190
750
|
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
1191
|
-
localVarRequestOptions.data = serializeDataIfNeeded(UpdateDealRequest, localVarRequestOptions, configuration);
|
|
1192
751
|
return {
|
|
1193
752
|
url: toPathString(localVarUrlObj),
|
|
1194
753
|
options: localVarRequestOptions,
|
|
1195
754
|
};
|
|
1196
755
|
}),
|
|
1197
756
|
/**
|
|
1198
|
-
*
|
|
1199
|
-
* @summary Update
|
|
757
|
+
* Edits a discount added to a deal, changing the deal value if the deal has one-time products attached.
|
|
758
|
+
* @summary Update a discount added to a deal
|
|
1200
759
|
* @param {number} id The ID of the deal
|
|
1201
|
-
* @param {
|
|
1202
|
-
* @param {
|
|
760
|
+
* @param {string} discount_id The ID of the discount
|
|
761
|
+
* @param {UpdateAdditionalDiscountRequestBody} [UpdateAdditionalDiscountRequestBody]
|
|
1203
762
|
|
|
1204
763
|
* @throws {RequiredError}
|
|
1205
764
|
*/
|
|
1206
|
-
|
|
765
|
+
updateAdditionalDiscount: (id, discount_id, UpdateAdditionalDiscountRequestBody) => __awaiter(this, void 0, void 0, function* () {
|
|
1207
766
|
// verify required parameter 'id' is not null or undefined
|
|
1208
|
-
assertParamExists('
|
|
1209
|
-
// verify required parameter '
|
|
1210
|
-
assertParamExists('
|
|
1211
|
-
const localVarPath = `/deals/{id}/
|
|
767
|
+
assertParamExists('updateAdditionalDiscount', 'id', id);
|
|
768
|
+
// verify required parameter 'discount_id' is not null or undefined
|
|
769
|
+
assertParamExists('updateAdditionalDiscount', 'discount_id', discount_id);
|
|
770
|
+
const localVarPath = `/deals/{id}/discounts/{discount_id}`
|
|
1212
771
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)))
|
|
1213
|
-
.replace(`{${"
|
|
772
|
+
.replace(`{${"discount_id"}}`, encodeURIComponent(String(discount_id)));
|
|
1214
773
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1215
774
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1216
775
|
let baseOptions;
|
|
@@ -1224,34 +783,30 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
1224
783
|
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
|
1225
784
|
// authentication oauth2 required
|
|
1226
785
|
// oauth required
|
|
1227
|
-
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["
|
|
786
|
+
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration);
|
|
1228
787
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1229
788
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1230
789
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1231
790
|
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
1232
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
791
|
+
localVarRequestOptions.data = serializeDataIfNeeded(UpdateAdditionalDiscountRequestBody, localVarRequestOptions, configuration);
|
|
1233
792
|
return {
|
|
1234
793
|
url: toPathString(localVarUrlObj),
|
|
1235
794
|
options: localVarRequestOptions,
|
|
1236
795
|
};
|
|
1237
796
|
}),
|
|
1238
797
|
/**
|
|
1239
|
-
*
|
|
1240
|
-
* @summary Update
|
|
798
|
+
* Updates the properties of a deal.
|
|
799
|
+
* @summary Update a deal
|
|
1241
800
|
* @param {number} id The ID of the deal
|
|
1242
|
-
* @param {
|
|
1243
|
-
* @param {UpdateInstallmentRequestBody} [UpdateInstallmentRequestBody]
|
|
801
|
+
* @param {UpdateDealRequest} [UpdateDealRequest]
|
|
1244
802
|
|
|
1245
803
|
* @throws {RequiredError}
|
|
1246
804
|
*/
|
|
1247
|
-
|
|
805
|
+
updateDeal: (id, UpdateDealRequest) => __awaiter(this, void 0, void 0, function* () {
|
|
1248
806
|
// verify required parameter 'id' is not null or undefined
|
|
1249
|
-
assertParamExists('
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
const localVarPath = `/deals/{id}/installments/{installment_id}`
|
|
1253
|
-
.replace(`{${"id"}}`, encodeURIComponent(String(id)))
|
|
1254
|
-
.replace(`{${"installment_id"}}`, encodeURIComponent(String(installment_id)));
|
|
807
|
+
assertParamExists('updateDeal', 'id', id);
|
|
808
|
+
const localVarPath = `/deals/{id}`
|
|
809
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
1255
810
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1256
811
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1257
812
|
let baseOptions;
|
|
@@ -1265,12 +820,12 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
1265
820
|
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
|
1266
821
|
// authentication oauth2 required
|
|
1267
822
|
// oauth required
|
|
1268
|
-
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:
|
|
823
|
+
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:full"], configuration);
|
|
1269
824
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1270
825
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1271
826
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1272
827
|
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
1273
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
828
|
+
localVarRequestOptions.data = serializeDataIfNeeded(UpdateDealRequest, localVarRequestOptions, configuration);
|
|
1274
829
|
return {
|
|
1275
830
|
url: toPathString(localVarUrlObj),
|
|
1276
831
|
options: localVarRequestOptions,
|
|
@@ -1312,34 +867,6 @@ export const DealsApiFp = function (configuration) {
|
|
|
1312
867
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1313
868
|
});
|
|
1314
869
|
},
|
|
1315
|
-
/**
|
|
1316
|
-
* Adds a product to a deal, creating a new item called a deal-product.
|
|
1317
|
-
* @summary Add a product to a deal
|
|
1318
|
-
* @param {number} id The ID of the deal
|
|
1319
|
-
* @param {AddDealProductRequest} [AddDealProductRequest]
|
|
1320
|
-
|
|
1321
|
-
* @throws {RequiredError}
|
|
1322
|
-
*/
|
|
1323
|
-
addDealProduct(id, AddDealProductRequest) {
|
|
1324
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
1325
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.addDealProduct(id, AddDealProductRequest);
|
|
1326
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1327
|
-
});
|
|
1328
|
-
},
|
|
1329
|
-
/**
|
|
1330
|
-
* Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
|
|
1331
|
-
* @summary Add multiple products to a deal
|
|
1332
|
-
* @param {number} id The ID of the deal
|
|
1333
|
-
* @param {CreateManyDealProductRequest} [CreateManyDealProductRequest]
|
|
1334
|
-
|
|
1335
|
-
* @throws {RequiredError}
|
|
1336
|
-
*/
|
|
1337
|
-
addManyDealProducts(id, CreateManyDealProductRequest) {
|
|
1338
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
1339
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.addManyDealProducts(id, CreateManyDealProductRequest);
|
|
1340
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1341
|
-
});
|
|
1342
|
-
},
|
|
1343
870
|
/**
|
|
1344
871
|
* 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.
|
|
1345
872
|
* @summary Convert a deal to a lead
|
|
@@ -1394,48 +921,6 @@ export const DealsApiFp = function (configuration) {
|
|
|
1394
921
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1395
922
|
});
|
|
1396
923
|
},
|
|
1397
|
-
/**
|
|
1398
|
-
* Deletes a product attachment from a deal, using the `product_attachment_id`.
|
|
1399
|
-
* @summary Delete an attached product from a deal
|
|
1400
|
-
* @param {number} id The ID of the deal
|
|
1401
|
-
* @param {number} product_attachment_id The product attachment ID
|
|
1402
|
-
|
|
1403
|
-
* @throws {RequiredError}
|
|
1404
|
-
*/
|
|
1405
|
-
deleteDealProduct(id, product_attachment_id) {
|
|
1406
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
1407
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteDealProduct(id, product_attachment_id);
|
|
1408
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1409
|
-
});
|
|
1410
|
-
},
|
|
1411
|
-
/**
|
|
1412
|
-
* Removes an installment from a deal. Only available in Growth and above plans.
|
|
1413
|
-
* @summary Delete an installment from a deal
|
|
1414
|
-
* @param {number} id The ID of the deal
|
|
1415
|
-
* @param {number} installment_id The ID of the installment
|
|
1416
|
-
|
|
1417
|
-
* @throws {RequiredError}
|
|
1418
|
-
*/
|
|
1419
|
-
deleteInstallment(id, installment_id) {
|
|
1420
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
1421
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteInstallment(id, installment_id);
|
|
1422
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1423
|
-
});
|
|
1424
|
-
},
|
|
1425
|
-
/**
|
|
1426
|
-
* 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.
|
|
1427
|
-
* @summary Delete many products from a deal
|
|
1428
|
-
* @param {number} id The ID of the deal
|
|
1429
|
-
* @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.
|
|
1430
|
-
|
|
1431
|
-
* @throws {RequiredError}
|
|
1432
|
-
*/
|
|
1433
|
-
deleteManyDealProducts(id, ids) {
|
|
1434
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
1435
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteManyDealProducts(id, ids);
|
|
1436
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1437
|
-
});
|
|
1438
|
-
},
|
|
1439
924
|
/**
|
|
1440
925
|
* Lists discounts attached to a deal.
|
|
1441
926
|
* @summary List discounts added to a deal
|
|
@@ -1483,12 +968,14 @@ export const DealsApiFp = function (configuration) {
|
|
|
1483
968
|
* @param {number} id The ID of the deal
|
|
1484
969
|
* @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
|
|
1485
970
|
* @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.
|
|
971
|
+
* @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
|
|
972
|
+
* @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 }\'
|
|
1486
973
|
|
|
1487
974
|
* @throws {RequiredError}
|
|
1488
975
|
*/
|
|
1489
|
-
getDeal(id, include_fields, custom_fields) {
|
|
976
|
+
getDeal(id, include_fields, custom_fields, include_option_labels, include_labels) {
|
|
1490
977
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1491
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDeal(id, include_fields, custom_fields);
|
|
978
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDeal(id, include_fields, custom_fields, include_option_labels, include_labels);
|
|
1492
979
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1493
980
|
});
|
|
1494
981
|
},
|
|
@@ -1536,23 +1023,6 @@ export const DealsApiFp = function (configuration) {
|
|
|
1536
1023
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1537
1024
|
});
|
|
1538
1025
|
},
|
|
1539
|
-
/**
|
|
1540
|
-
* Lists products attached to a deal.
|
|
1541
|
-
* @summary List products attached to a deal
|
|
1542
|
-
* @param {number} id The ID of the deal
|
|
1543
|
-
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
1544
|
-
* @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.
|
|
1545
|
-
* @param {'id' | 'add_time' | 'update_time' | 'order_nr'} [sort_by] The field to sort by. Supported fields: `id`, `add_time`, `update_time`, `order_nr`.
|
|
1546
|
-
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
1547
|
-
|
|
1548
|
-
* @throws {RequiredError}
|
|
1549
|
-
*/
|
|
1550
|
-
getDealProducts(id, cursor, limit, sort_by, sort_direction) {
|
|
1551
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
1552
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealProducts(id, cursor, limit, sort_by, sort_direction);
|
|
1553
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1554
|
-
});
|
|
1555
|
-
},
|
|
1556
1026
|
/**
|
|
1557
1027
|
* Returns data about all not archived deals.
|
|
1558
1028
|
* @summary Get all deals
|
|
@@ -1570,48 +1040,16 @@ export const DealsApiFp = function (configuration) {
|
|
|
1570
1040
|
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
1571
1041
|
* @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
|
|
1572
1042
|
* @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.
|
|
1043
|
+
* @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
|
|
1044
|
+
* @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 }\'
|
|
1573
1045
|
* @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.
|
|
1574
1046
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
1575
1047
|
|
|
1576
1048
|
* @throws {RequiredError}
|
|
1577
1049
|
*/
|
|
1578
|
-
getDeals(filter_id, ids, owner_id, person_id, org_id, pipeline_id, stage_id, status, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, limit, cursor) {
|
|
1579
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
1580
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDeals(filter_id, ids, owner_id, person_id, org_id, pipeline_id, stage_id, status, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, limit, cursor);
|
|
1581
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1582
|
-
});
|
|
1583
|
-
},
|
|
1584
|
-
/**
|
|
1585
|
-
* Returns data about products attached to deals
|
|
1586
|
-
* @summary Get deal products of several deals
|
|
1587
|
-
* @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.
|
|
1588
|
-
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
1589
|
-
* @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.
|
|
1590
|
-
* @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`.
|
|
1591
|
-
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
1592
|
-
|
|
1593
|
-
* @throws {RequiredError}
|
|
1594
|
-
*/
|
|
1595
|
-
getDealsProducts(deal_ids, cursor, limit, sort_by, sort_direction) {
|
|
1596
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
1597
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealsProducts(deal_ids, cursor, limit, sort_by, sort_direction);
|
|
1598
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1599
|
-
});
|
|
1600
|
-
},
|
|
1601
|
-
/**
|
|
1602
|
-
* Lists installments attached to a list of deals. Only available in Growth and above plans.
|
|
1603
|
-
* @summary List installments added to a list of deals
|
|
1604
|
-
* @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.
|
|
1605
|
-
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
1606
|
-
* @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.
|
|
1607
|
-
* @param {'id' | 'billing_date' | 'deal_id'} [sort_by] The field to sort by. Supported fields: `id`, `billing_date`, `deal_id`.
|
|
1608
|
-
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
1609
|
-
|
|
1610
|
-
* @throws {RequiredError}
|
|
1611
|
-
*/
|
|
1612
|
-
getInstallments(deal_ids, cursor, limit, sort_by, sort_direction) {
|
|
1050
|
+
getDeals(filter_id, ids, owner_id, person_id, org_id, pipeline_id, stage_id, status, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, include_option_labels, include_labels, limit, cursor) {
|
|
1613
1051
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1614
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
1052
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDeals(filter_id, ids, owner_id, person_id, org_id, pipeline_id, stage_id, status, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, include_option_labels, include_labels, limit, cursor);
|
|
1615
1053
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1616
1054
|
});
|
|
1617
1055
|
},
|
|
@@ -1629,20 +1067,6 @@ export const DealsApiFp = function (configuration) {
|
|
|
1629
1067
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1630
1068
|
});
|
|
1631
1069
|
},
|
|
1632
|
-
/**
|
|
1633
|
-
* 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.
|
|
1634
|
-
* @summary Add an installment to a deal
|
|
1635
|
-
* @param {number} id The ID of the deal
|
|
1636
|
-
* @param {AddInstallmentRequestBody} [AddInstallmentRequestBody]
|
|
1637
|
-
|
|
1638
|
-
* @throws {RequiredError}
|
|
1639
|
-
*/
|
|
1640
|
-
postInstallment(id, AddInstallmentRequestBody) {
|
|
1641
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
1642
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.postInstallment(id, AddInstallmentRequestBody);
|
|
1643
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1644
|
-
});
|
|
1645
|
-
},
|
|
1646
1070
|
/**
|
|
1647
1071
|
* 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.
|
|
1648
1072
|
* @summary Search deals
|
|
@@ -1693,36 +1117,6 @@ export const DealsApiFp = function (configuration) {
|
|
|
1693
1117
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1694
1118
|
});
|
|
1695
1119
|
},
|
|
1696
|
-
/**
|
|
1697
|
-
* Updates the details of the product that has been attached to a deal.
|
|
1698
|
-
* @summary Update the product attached to a deal
|
|
1699
|
-
* @param {number} id The ID of the deal
|
|
1700
|
-
* @param {number} product_attachment_id The ID of the deal-product (the ID of the product attached to the deal)
|
|
1701
|
-
* @param {UpdateDealProductRequest} [UpdateDealProductRequest]
|
|
1702
|
-
|
|
1703
|
-
* @throws {RequiredError}
|
|
1704
|
-
*/
|
|
1705
|
-
updateDealProduct(id, product_attachment_id, UpdateDealProductRequest) {
|
|
1706
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
1707
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateDealProduct(id, product_attachment_id, UpdateDealProductRequest);
|
|
1708
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1709
|
-
});
|
|
1710
|
-
},
|
|
1711
|
-
/**
|
|
1712
|
-
* Edits an installment added to a deal. Only available in Growth and above plans.
|
|
1713
|
-
* @summary Update an installment added to a deal
|
|
1714
|
-
* @param {number} id The ID of the deal
|
|
1715
|
-
* @param {number} installment_id The ID of the installment
|
|
1716
|
-
* @param {UpdateInstallmentRequestBody} [UpdateInstallmentRequestBody]
|
|
1717
|
-
|
|
1718
|
-
* @throws {RequiredError}
|
|
1719
|
-
*/
|
|
1720
|
-
updateInstallment(id, installment_id, UpdateInstallmentRequestBody) {
|
|
1721
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
1722
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateInstallment(id, installment_id, UpdateInstallmentRequestBody);
|
|
1723
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1724
|
-
});
|
|
1725
|
-
},
|
|
1726
1120
|
};
|
|
1727
1121
|
};
|
|
1728
1122
|
/**
|
|
@@ -1752,26 +1146,6 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1752
1146
|
addDealFollower(requestParameters) {
|
|
1753
1147
|
return localVarFp.addDealFollower(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(axios, basePath));
|
|
1754
1148
|
},
|
|
1755
|
-
/**
|
|
1756
|
-
* Adds a product to a deal, creating a new item called a deal-product.
|
|
1757
|
-
* @summary Add a product to a deal
|
|
1758
|
-
* @param {DealsApiAddDealProductRequest} requestParameters Request parameters.
|
|
1759
|
-
|
|
1760
|
-
* @throws {RequiredError}
|
|
1761
|
-
*/
|
|
1762
|
-
addDealProduct(requestParameters) {
|
|
1763
|
-
return localVarFp.addDealProduct(requestParameters.id, requestParameters.AddDealProductRequest).then((request) => request(axios, basePath));
|
|
1764
|
-
},
|
|
1765
|
-
/**
|
|
1766
|
-
* Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
|
|
1767
|
-
* @summary Add multiple products to a deal
|
|
1768
|
-
* @param {DealsApiAddManyDealProductsRequest} requestParameters Request parameters.
|
|
1769
|
-
|
|
1770
|
-
* @throws {RequiredError}
|
|
1771
|
-
*/
|
|
1772
|
-
addManyDealProducts(requestParameters) {
|
|
1773
|
-
return localVarFp.addManyDealProducts(requestParameters.id, requestParameters.CreateManyDealProductRequest).then((request) => request(axios, basePath));
|
|
1774
|
-
},
|
|
1775
1149
|
/**
|
|
1776
1150
|
* 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.
|
|
1777
1151
|
* @summary Convert a deal to a lead
|
|
@@ -1812,36 +1186,6 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1812
1186
|
deleteDealFollower(requestParameters) {
|
|
1813
1187
|
return localVarFp.deleteDealFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(axios, basePath));
|
|
1814
1188
|
},
|
|
1815
|
-
/**
|
|
1816
|
-
* Deletes a product attachment from a deal, using the `product_attachment_id`.
|
|
1817
|
-
* @summary Delete an attached product from a deal
|
|
1818
|
-
* @param {DealsApiDeleteDealProductRequest} requestParameters Request parameters.
|
|
1819
|
-
|
|
1820
|
-
* @throws {RequiredError}
|
|
1821
|
-
*/
|
|
1822
|
-
deleteDealProduct(requestParameters) {
|
|
1823
|
-
return localVarFp.deleteDealProduct(requestParameters.id, requestParameters.product_attachment_id).then((request) => request(axios, basePath));
|
|
1824
|
-
},
|
|
1825
|
-
/**
|
|
1826
|
-
* Removes an installment from a deal. Only available in Growth and above plans.
|
|
1827
|
-
* @summary Delete an installment from a deal
|
|
1828
|
-
* @param {DealsApiDeleteInstallmentRequest} requestParameters Request parameters.
|
|
1829
|
-
|
|
1830
|
-
* @throws {RequiredError}
|
|
1831
|
-
*/
|
|
1832
|
-
deleteInstallment(requestParameters) {
|
|
1833
|
-
return localVarFp.deleteInstallment(requestParameters.id, requestParameters.installment_id).then((request) => request(axios, basePath));
|
|
1834
|
-
},
|
|
1835
|
-
/**
|
|
1836
|
-
* 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.
|
|
1837
|
-
* @summary Delete many products from a deal
|
|
1838
|
-
* @param {DealsApiDeleteManyDealProductsRequest} requestParameters Request parameters.
|
|
1839
|
-
|
|
1840
|
-
* @throws {RequiredError}
|
|
1841
|
-
*/
|
|
1842
|
-
deleteManyDealProducts(requestParameters) {
|
|
1843
|
-
return localVarFp.deleteManyDealProducts(requestParameters.id, requestParameters.ids).then((request) => request(axios, basePath));
|
|
1844
|
-
},
|
|
1845
1189
|
/**
|
|
1846
1190
|
* Lists discounts attached to a deal.
|
|
1847
1191
|
* @summary List discounts added to a deal
|
|
@@ -1870,7 +1214,7 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1870
1214
|
* @throws {RequiredError}
|
|
1871
1215
|
*/
|
|
1872
1216
|
getDeal(requestParameters) {
|
|
1873
|
-
return localVarFp.getDeal(requestParameters.id, requestParameters.include_fields, requestParameters.custom_fields).then((request) => request(axios, basePath));
|
|
1217
|
+
return localVarFp.getDeal(requestParameters.id, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.include_option_labels, requestParameters.include_labels).then((request) => request(axios, basePath));
|
|
1874
1218
|
},
|
|
1875
1219
|
/**
|
|
1876
1220
|
* 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.
|
|
@@ -1902,16 +1246,6 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1902
1246
|
getDealFollowersChangelog(requestParameters) {
|
|
1903
1247
|
return localVarFp.getDealFollowersChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
|
1904
1248
|
},
|
|
1905
|
-
/**
|
|
1906
|
-
* Lists products attached to a deal.
|
|
1907
|
-
* @summary List products attached to a deal
|
|
1908
|
-
* @param {DealsApiGetDealProductsRequest} requestParameters Request parameters.
|
|
1909
|
-
|
|
1910
|
-
* @throws {RequiredError}
|
|
1911
|
-
*/
|
|
1912
|
-
getDealProducts(requestParameters) {
|
|
1913
|
-
return localVarFp.getDealProducts(requestParameters.id, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(axios, basePath));
|
|
1914
|
-
},
|
|
1915
1249
|
/**
|
|
1916
1250
|
* Returns data about all not archived deals.
|
|
1917
1251
|
* @summary Get all deals
|
|
@@ -1920,27 +1254,7 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1920
1254
|
* @throws {RequiredError}
|
|
1921
1255
|
*/
|
|
1922
1256
|
getDeals(requestParameters = {}) {
|
|
1923
|
-
return localVarFp.getDeals(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.person_id, requestParameters.org_id, requestParameters.pipeline_id, requestParameters.stage_id, requestParameters.status, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
|
1924
|
-
},
|
|
1925
|
-
/**
|
|
1926
|
-
* Returns data about products attached to deals
|
|
1927
|
-
* @summary Get deal products of several deals
|
|
1928
|
-
* @param {DealsApiGetDealsProductsRequest} requestParameters Request parameters.
|
|
1929
|
-
|
|
1930
|
-
* @throws {RequiredError}
|
|
1931
|
-
*/
|
|
1932
|
-
getDealsProducts(requestParameters) {
|
|
1933
|
-
return localVarFp.getDealsProducts(requestParameters.deal_ids, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(axios, basePath));
|
|
1934
|
-
},
|
|
1935
|
-
/**
|
|
1936
|
-
* Lists installments attached to a list of deals. Only available in Growth and above plans.
|
|
1937
|
-
* @summary List installments added to a list of deals
|
|
1938
|
-
* @param {DealsApiGetInstallmentsRequest} requestParameters Request parameters.
|
|
1939
|
-
|
|
1940
|
-
* @throws {RequiredError}
|
|
1941
|
-
*/
|
|
1942
|
-
getInstallments(requestParameters) {
|
|
1943
|
-
return localVarFp.getInstallments(requestParameters.deal_ids, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(axios, basePath));
|
|
1257
|
+
return localVarFp.getDeals(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.person_id, requestParameters.org_id, requestParameters.pipeline_id, requestParameters.stage_id, requestParameters.status, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.include_option_labels, requestParameters.include_labels, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
|
1944
1258
|
},
|
|
1945
1259
|
/**
|
|
1946
1260
|
* Adds a discount to a deal, changing the deal value if the deal has one-time products attached.
|
|
@@ -1952,16 +1266,6 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1952
1266
|
postAdditionalDiscount(requestParameters) {
|
|
1953
1267
|
return localVarFp.postAdditionalDiscount(requestParameters.id, requestParameters.AddAdditionalDiscountRequestBody).then((request) => request(axios, basePath));
|
|
1954
1268
|
},
|
|
1955
|
-
/**
|
|
1956
|
-
* 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.
|
|
1957
|
-
* @summary Add an installment to a deal
|
|
1958
|
-
* @param {DealsApiPostInstallmentRequest} requestParameters Request parameters.
|
|
1959
|
-
|
|
1960
|
-
* @throws {RequiredError}
|
|
1961
|
-
*/
|
|
1962
|
-
postInstallment(requestParameters) {
|
|
1963
|
-
return localVarFp.postInstallment(requestParameters.id, requestParameters.AddInstallmentRequestBody).then((request) => request(axios, basePath));
|
|
1964
|
-
},
|
|
1965
1269
|
/**
|
|
1966
1270
|
* 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.
|
|
1967
1271
|
* @summary Search deals
|
|
@@ -1992,26 +1296,6 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1992
1296
|
updateDeal(requestParameters) {
|
|
1993
1297
|
return localVarFp.updateDeal(requestParameters.id, requestParameters.UpdateDealRequest).then((request) => request(axios, basePath));
|
|
1994
1298
|
},
|
|
1995
|
-
/**
|
|
1996
|
-
* Updates the details of the product that has been attached to a deal.
|
|
1997
|
-
* @summary Update the product attached to a deal
|
|
1998
|
-
* @param {DealsApiUpdateDealProductRequest} requestParameters Request parameters.
|
|
1999
|
-
|
|
2000
|
-
* @throws {RequiredError}
|
|
2001
|
-
*/
|
|
2002
|
-
updateDealProduct(requestParameters) {
|
|
2003
|
-
return localVarFp.updateDealProduct(requestParameters.id, requestParameters.product_attachment_id, requestParameters.UpdateDealProductRequest).then((request) => request(axios, basePath));
|
|
2004
|
-
},
|
|
2005
|
-
/**
|
|
2006
|
-
* Edits an installment added to a deal. Only available in Growth and above plans.
|
|
2007
|
-
* @summary Update an installment added to a deal
|
|
2008
|
-
* @param {DealsApiUpdateInstallmentRequest} requestParameters Request parameters.
|
|
2009
|
-
|
|
2010
|
-
* @throws {RequiredError}
|
|
2011
|
-
*/
|
|
2012
|
-
updateInstallment(requestParameters) {
|
|
2013
|
-
return localVarFp.updateInstallment(requestParameters.id, requestParameters.installment_id, requestParameters.UpdateInstallmentRequestBody).then((request) => request(axios, basePath));
|
|
2014
|
-
},
|
|
2015
1299
|
};
|
|
2016
1300
|
};
|
|
2017
1301
|
/**
|
|
@@ -2043,28 +1327,6 @@ export class DealsApi extends BaseAPI {
|
|
|
2043
1327
|
addDealFollower(requestParameters) {
|
|
2044
1328
|
return DealsApiFp(this.configuration).addDealFollower(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(this.axios, this.basePath));
|
|
2045
1329
|
}
|
|
2046
|
-
/**
|
|
2047
|
-
* Adds a product to a deal, creating a new item called a deal-product.
|
|
2048
|
-
* @summary Add a product to a deal
|
|
2049
|
-
* @param {DealsApiAddDealProductRequest} requestParameters Request parameters.
|
|
2050
|
-
|
|
2051
|
-
* @throws {RequiredError}
|
|
2052
|
-
* @memberof DealsApi
|
|
2053
|
-
*/
|
|
2054
|
-
addDealProduct(requestParameters) {
|
|
2055
|
-
return DealsApiFp(this.configuration).addDealProduct(requestParameters.id, requestParameters.AddDealProductRequest).then((request) => request(this.axios, this.basePath));
|
|
2056
|
-
}
|
|
2057
|
-
/**
|
|
2058
|
-
* Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
|
|
2059
|
-
* @summary Add multiple products to a deal
|
|
2060
|
-
* @param {DealsApiAddManyDealProductsRequest} requestParameters Request parameters.
|
|
2061
|
-
|
|
2062
|
-
* @throws {RequiredError}
|
|
2063
|
-
* @memberof DealsApi
|
|
2064
|
-
*/
|
|
2065
|
-
addManyDealProducts(requestParameters) {
|
|
2066
|
-
return DealsApiFp(this.configuration).addManyDealProducts(requestParameters.id, requestParameters.CreateManyDealProductRequest).then((request) => request(this.axios, this.basePath));
|
|
2067
|
-
}
|
|
2068
1330
|
/**
|
|
2069
1331
|
* 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.
|
|
2070
1332
|
* @summary Convert a deal to a lead
|
|
@@ -2109,39 +1371,6 @@ export class DealsApi extends BaseAPI {
|
|
|
2109
1371
|
deleteDealFollower(requestParameters) {
|
|
2110
1372
|
return DealsApiFp(this.configuration).deleteDealFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(this.axios, this.basePath));
|
|
2111
1373
|
}
|
|
2112
|
-
/**
|
|
2113
|
-
* Deletes a product attachment from a deal, using the `product_attachment_id`.
|
|
2114
|
-
* @summary Delete an attached product from a deal
|
|
2115
|
-
* @param {DealsApiDeleteDealProductRequest} requestParameters Request parameters.
|
|
2116
|
-
|
|
2117
|
-
* @throws {RequiredError}
|
|
2118
|
-
* @memberof DealsApi
|
|
2119
|
-
*/
|
|
2120
|
-
deleteDealProduct(requestParameters) {
|
|
2121
|
-
return DealsApiFp(this.configuration).deleteDealProduct(requestParameters.id, requestParameters.product_attachment_id).then((request) => request(this.axios, this.basePath));
|
|
2122
|
-
}
|
|
2123
|
-
/**
|
|
2124
|
-
* Removes an installment from a deal. Only available in Growth and above plans.
|
|
2125
|
-
* @summary Delete an installment from a deal
|
|
2126
|
-
* @param {DealsApiDeleteInstallmentRequest} requestParameters Request parameters.
|
|
2127
|
-
|
|
2128
|
-
* @throws {RequiredError}
|
|
2129
|
-
* @memberof DealsApi
|
|
2130
|
-
*/
|
|
2131
|
-
deleteInstallment(requestParameters) {
|
|
2132
|
-
return DealsApiFp(this.configuration).deleteInstallment(requestParameters.id, requestParameters.installment_id).then((request) => request(this.axios, this.basePath));
|
|
2133
|
-
}
|
|
2134
|
-
/**
|
|
2135
|
-
* 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.
|
|
2136
|
-
* @summary Delete many products from a deal
|
|
2137
|
-
* @param {DealsApiDeleteManyDealProductsRequest} requestParameters Request parameters.
|
|
2138
|
-
|
|
2139
|
-
* @throws {RequiredError}
|
|
2140
|
-
* @memberof DealsApi
|
|
2141
|
-
*/
|
|
2142
|
-
deleteManyDealProducts(requestParameters) {
|
|
2143
|
-
return DealsApiFp(this.configuration).deleteManyDealProducts(requestParameters.id, requestParameters.ids).then((request) => request(this.axios, this.basePath));
|
|
2144
|
-
}
|
|
2145
1374
|
/**
|
|
2146
1375
|
* Lists discounts attached to a deal.
|
|
2147
1376
|
* @summary List discounts added to a deal
|
|
@@ -2173,7 +1402,7 @@ export class DealsApi extends BaseAPI {
|
|
|
2173
1402
|
* @memberof DealsApi
|
|
2174
1403
|
*/
|
|
2175
1404
|
getDeal(requestParameters) {
|
|
2176
|
-
return DealsApiFp(this.configuration).getDeal(requestParameters.id, requestParameters.include_fields, requestParameters.custom_fields).then((request) => request(this.axios, this.basePath));
|
|
1405
|
+
return DealsApiFp(this.configuration).getDeal(requestParameters.id, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.include_option_labels, requestParameters.include_labels).then((request) => request(this.axios, this.basePath));
|
|
2177
1406
|
}
|
|
2178
1407
|
/**
|
|
2179
1408
|
* 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.
|
|
@@ -2208,17 +1437,6 @@ export class DealsApi extends BaseAPI {
|
|
|
2208
1437
|
getDealFollowersChangelog(requestParameters) {
|
|
2209
1438
|
return DealsApiFp(this.configuration).getDealFollowersChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
|
2210
1439
|
}
|
|
2211
|
-
/**
|
|
2212
|
-
* Lists products attached to a deal.
|
|
2213
|
-
* @summary List products attached to a deal
|
|
2214
|
-
* @param {DealsApiGetDealProductsRequest} requestParameters Request parameters.
|
|
2215
|
-
|
|
2216
|
-
* @throws {RequiredError}
|
|
2217
|
-
* @memberof DealsApi
|
|
2218
|
-
*/
|
|
2219
|
-
getDealProducts(requestParameters) {
|
|
2220
|
-
return DealsApiFp(this.configuration).getDealProducts(requestParameters.id, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(this.axios, this.basePath));
|
|
2221
|
-
}
|
|
2222
1440
|
/**
|
|
2223
1441
|
* Returns data about all not archived deals.
|
|
2224
1442
|
* @summary Get all deals
|
|
@@ -2228,29 +1446,7 @@ export class DealsApi extends BaseAPI {
|
|
|
2228
1446
|
* @memberof DealsApi
|
|
2229
1447
|
*/
|
|
2230
1448
|
getDeals(requestParameters = {}) {
|
|
2231
|
-
return DealsApiFp(this.configuration).getDeals(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.person_id, requestParameters.org_id, requestParameters.pipeline_id, requestParameters.stage_id, requestParameters.status, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
|
2232
|
-
}
|
|
2233
|
-
/**
|
|
2234
|
-
* Returns data about products attached to deals
|
|
2235
|
-
* @summary Get deal products of several deals
|
|
2236
|
-
* @param {DealsApiGetDealsProductsRequest} requestParameters Request parameters.
|
|
2237
|
-
|
|
2238
|
-
* @throws {RequiredError}
|
|
2239
|
-
* @memberof DealsApi
|
|
2240
|
-
*/
|
|
2241
|
-
getDealsProducts(requestParameters) {
|
|
2242
|
-
return DealsApiFp(this.configuration).getDealsProducts(requestParameters.deal_ids, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(this.axios, this.basePath));
|
|
2243
|
-
}
|
|
2244
|
-
/**
|
|
2245
|
-
* Lists installments attached to a list of deals. Only available in Growth and above plans.
|
|
2246
|
-
* @summary List installments added to a list of deals
|
|
2247
|
-
* @param {DealsApiGetInstallmentsRequest} requestParameters Request parameters.
|
|
2248
|
-
|
|
2249
|
-
* @throws {RequiredError}
|
|
2250
|
-
* @memberof DealsApi
|
|
2251
|
-
*/
|
|
2252
|
-
getInstallments(requestParameters) {
|
|
2253
|
-
return DealsApiFp(this.configuration).getInstallments(requestParameters.deal_ids, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(this.axios, this.basePath));
|
|
1449
|
+
return DealsApiFp(this.configuration).getDeals(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.person_id, requestParameters.org_id, requestParameters.pipeline_id, requestParameters.stage_id, requestParameters.status, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.include_option_labels, requestParameters.include_labels, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
|
2254
1450
|
}
|
|
2255
1451
|
/**
|
|
2256
1452
|
* Adds a discount to a deal, changing the deal value if the deal has one-time products attached.
|
|
@@ -2263,17 +1459,6 @@ export class DealsApi extends BaseAPI {
|
|
|
2263
1459
|
postAdditionalDiscount(requestParameters) {
|
|
2264
1460
|
return DealsApiFp(this.configuration).postAdditionalDiscount(requestParameters.id, requestParameters.AddAdditionalDiscountRequestBody).then((request) => request(this.axios, this.basePath));
|
|
2265
1461
|
}
|
|
2266
|
-
/**
|
|
2267
|
-
* 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.
|
|
2268
|
-
* @summary Add an installment to a deal
|
|
2269
|
-
* @param {DealsApiPostInstallmentRequest} requestParameters Request parameters.
|
|
2270
|
-
|
|
2271
|
-
* @throws {RequiredError}
|
|
2272
|
-
* @memberof DealsApi
|
|
2273
|
-
*/
|
|
2274
|
-
postInstallment(requestParameters) {
|
|
2275
|
-
return DealsApiFp(this.configuration).postInstallment(requestParameters.id, requestParameters.AddInstallmentRequestBody).then((request) => request(this.axios, this.basePath));
|
|
2276
|
-
}
|
|
2277
1462
|
/**
|
|
2278
1463
|
* 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.
|
|
2279
1464
|
* @summary Search deals
|
|
@@ -2307,26 +1492,4 @@ export class DealsApi extends BaseAPI {
|
|
|
2307
1492
|
updateDeal(requestParameters) {
|
|
2308
1493
|
return DealsApiFp(this.configuration).updateDeal(requestParameters.id, requestParameters.UpdateDealRequest).then((request) => request(this.axios, this.basePath));
|
|
2309
1494
|
}
|
|
2310
|
-
/**
|
|
2311
|
-
* Updates the details of the product that has been attached to a deal.
|
|
2312
|
-
* @summary Update the product attached to a deal
|
|
2313
|
-
* @param {DealsApiUpdateDealProductRequest} requestParameters Request parameters.
|
|
2314
|
-
|
|
2315
|
-
* @throws {RequiredError}
|
|
2316
|
-
* @memberof DealsApi
|
|
2317
|
-
*/
|
|
2318
|
-
updateDealProduct(requestParameters) {
|
|
2319
|
-
return DealsApiFp(this.configuration).updateDealProduct(requestParameters.id, requestParameters.product_attachment_id, requestParameters.UpdateDealProductRequest).then((request) => request(this.axios, this.basePath));
|
|
2320
|
-
}
|
|
2321
|
-
/**
|
|
2322
|
-
* Edits an installment added to a deal. Only available in Growth and above plans.
|
|
2323
|
-
* @summary Update an installment added to a deal
|
|
2324
|
-
* @param {DealsApiUpdateInstallmentRequest} requestParameters Request parameters.
|
|
2325
|
-
|
|
2326
|
-
* @throws {RequiredError}
|
|
2327
|
-
* @memberof DealsApi
|
|
2328
|
-
*/
|
|
2329
|
-
updateInstallment(requestParameters) {
|
|
2330
|
-
return DealsApiFp(this.configuration).updateInstallment(requestParameters.id, requestParameters.installment_id, requestParameters.UpdateInstallmentRequestBody).then((request) => request(this.axios, this.basePath));
|
|
2331
|
-
}
|
|
2332
1495
|
}
|