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
|
@@ -0,0 +1,1314 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Pipedrive API v2
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from '../configuration';
|
|
13
|
+
import type { AxiosInstance } from 'axios';
|
|
14
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { AddDealFieldOptions200Response } from '../models';
|
|
16
|
+
import { AddDealFieldOptionsRequestInner } from '../models';
|
|
17
|
+
import { AddProjectBoardRequest } from '../models';
|
|
18
|
+
import { AddProjectField200Response } from '../models';
|
|
19
|
+
import { AddProjectFieldRequest } from '../models';
|
|
20
|
+
import { AddProjectPhaseRequest } from '../models';
|
|
21
|
+
import { AddTaskRequest } from '../models';
|
|
22
|
+
import { AddTaskResponse } from '../models';
|
|
23
|
+
import { DeleteDealFieldOptionsRequestInner } from '../models';
|
|
24
|
+
import { DeleteProjectBoardResponse } from '../models';
|
|
25
|
+
import { DeleteProjectField200Response } from '../models';
|
|
26
|
+
import { DeleteProjectPhaseResponse } from '../models';
|
|
27
|
+
import { DeleteTaskResponse } from '../models';
|
|
28
|
+
import { GetProjectBoardsResponse } from '../models';
|
|
29
|
+
import { GetProjectFields200Response } from '../models';
|
|
30
|
+
import { GetProjectPhasesResponse } from '../models';
|
|
31
|
+
import { GetProjectSearchResponse } from '../models';
|
|
32
|
+
import { GetTaskResponse } from '../models';
|
|
33
|
+
import { GetTasksResponse } from '../models';
|
|
34
|
+
import { UpdateDealFieldOptionsRequestInner } from '../models';
|
|
35
|
+
import { UpdateProjectBoardRequest } from '../models';
|
|
36
|
+
import { UpdateProjectFieldRequest } from '../models';
|
|
37
|
+
import { UpdateProjectPhaseRequest } from '../models';
|
|
38
|
+
import { UpdateTaskRequest } from '../models';
|
|
39
|
+
import { UpdateTaskResponse } from '../models';
|
|
40
|
+
import { UpsertProjectBoardResponse } from '../models';
|
|
41
|
+
import { UpsertProjectPhaseResponse } from '../models';
|
|
42
|
+
/**
|
|
43
|
+
* BetaApi - axios parameter creator
|
|
44
|
+
* @export
|
|
45
|
+
*/
|
|
46
|
+
export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
47
|
+
/**
|
|
48
|
+
* Adds a new project board.
|
|
49
|
+
* @summary Add a project board
|
|
50
|
+
* @param {AddProjectBoardRequest} AddProjectBoardRequest
|
|
51
|
+
|
|
52
|
+
* @throws {RequiredError}
|
|
53
|
+
*/
|
|
54
|
+
addProjectBoard: (AddProjectBoardRequest: AddProjectBoardRequest) => Promise<RequestArgs>;
|
|
55
|
+
/**
|
|
56
|
+
* Creates a new project custom field.
|
|
57
|
+
* @summary Create one project field
|
|
58
|
+
* @param {AddProjectFieldRequest} AddProjectFieldRequest
|
|
59
|
+
|
|
60
|
+
* @throws {RequiredError}
|
|
61
|
+
*/
|
|
62
|
+
addProjectField: (AddProjectFieldRequest: AddProjectFieldRequest) => Promise<RequestArgs>;
|
|
63
|
+
/**
|
|
64
|
+
* Adds new options to a project custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
|
|
65
|
+
* @summary Add project field options in bulk
|
|
66
|
+
* @param {string} field_code The unique code identifying the field
|
|
67
|
+
* @param {Array<AddDealFieldOptionsRequestInner>} AddDealFieldOptionsRequestInner
|
|
68
|
+
|
|
69
|
+
* @throws {RequiredError}
|
|
70
|
+
*/
|
|
71
|
+
addProjectFieldOptions: (field_code: string, AddDealFieldOptionsRequestInner: AddDealFieldOptionsRequestInner[]) => Promise<RequestArgs>;
|
|
72
|
+
/**
|
|
73
|
+
* Adds a new project phase to a board.
|
|
74
|
+
* @summary Add a project phase
|
|
75
|
+
* @param {AddProjectPhaseRequest} AddProjectPhaseRequest
|
|
76
|
+
|
|
77
|
+
* @throws {RequiredError}
|
|
78
|
+
*/
|
|
79
|
+
addProjectPhase: (AddProjectPhaseRequest: AddProjectPhaseRequest) => Promise<RequestArgs>;
|
|
80
|
+
/**
|
|
81
|
+
* Adds a new task.
|
|
82
|
+
* @summary Add a task
|
|
83
|
+
* @param {AddTaskRequest} AddTaskRequest
|
|
84
|
+
|
|
85
|
+
* @throws {RequiredError}
|
|
86
|
+
*/
|
|
87
|
+
addTask: (AddTaskRequest: AddTaskRequest) => Promise<RequestArgs>;
|
|
88
|
+
/**
|
|
89
|
+
* Marks a project board as deleted.
|
|
90
|
+
* @summary Delete a project board
|
|
91
|
+
* @param {number} id The ID of the project board
|
|
92
|
+
|
|
93
|
+
* @throws {RequiredError}
|
|
94
|
+
*/
|
|
95
|
+
deleteProjectBoard: (id: number) => Promise<RequestArgs>;
|
|
96
|
+
/**
|
|
97
|
+
* Marks a custom field as deleted.
|
|
98
|
+
* @summary Delete one project field
|
|
99
|
+
* @param {string} field_code The unique code identifying the field
|
|
100
|
+
|
|
101
|
+
* @throws {RequiredError}
|
|
102
|
+
*/
|
|
103
|
+
deleteProjectField: (field_code: string) => Promise<RequestArgs>;
|
|
104
|
+
/**
|
|
105
|
+
* Removes existing options from a project custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
|
|
106
|
+
* @summary Delete project field options in bulk
|
|
107
|
+
* @param {string} field_code The unique code identifying the field
|
|
108
|
+
* @param {Array<DeleteDealFieldOptionsRequestInner>} DeleteDealFieldOptionsRequestInner
|
|
109
|
+
|
|
110
|
+
* @throws {RequiredError}
|
|
111
|
+
*/
|
|
112
|
+
deleteProjectFieldOptions: (field_code: string, DeleteDealFieldOptionsRequestInner: DeleteDealFieldOptionsRequestInner[]) => Promise<RequestArgs>;
|
|
113
|
+
/**
|
|
114
|
+
* Marks a project phase as deleted.
|
|
115
|
+
* @summary Delete a project phase
|
|
116
|
+
* @param {number} id The ID of the project phase
|
|
117
|
+
|
|
118
|
+
* @throws {RequiredError}
|
|
119
|
+
*/
|
|
120
|
+
deleteProjectPhase: (id: number) => Promise<RequestArgs>;
|
|
121
|
+
/**
|
|
122
|
+
* Marks a task as deleted. If the task has subtasks, those will also be deleted.
|
|
123
|
+
* @summary Delete a task
|
|
124
|
+
* @param {number} id The ID of the task
|
|
125
|
+
|
|
126
|
+
* @throws {RequiredError}
|
|
127
|
+
*/
|
|
128
|
+
deleteTask: (id: number) => Promise<RequestArgs>;
|
|
129
|
+
/**
|
|
130
|
+
* Returns metadata about a specific project field.
|
|
131
|
+
* @summary Get one project field
|
|
132
|
+
* @param {string} field_code The unique code identifying the field
|
|
133
|
+
|
|
134
|
+
* @throws {RequiredError}
|
|
135
|
+
*/
|
|
136
|
+
getProjectField: (field_code: string) => Promise<RequestArgs>;
|
|
137
|
+
/**
|
|
138
|
+
* Returns metadata about all project fields in the company.
|
|
139
|
+
* @summary Get all project fields
|
|
140
|
+
* @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.
|
|
141
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
142
|
+
|
|
143
|
+
* @throws {RequiredError}
|
|
144
|
+
*/
|
|
145
|
+
getProjectFields: (limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
146
|
+
/**
|
|
147
|
+
* Returns the details of a specific project board.
|
|
148
|
+
* @summary Get details of a project board
|
|
149
|
+
* @param {number} id The ID of the project board
|
|
150
|
+
|
|
151
|
+
* @throws {RequiredError}
|
|
152
|
+
*/
|
|
153
|
+
getProjectsBoard: (id: number) => Promise<RequestArgs>;
|
|
154
|
+
/**
|
|
155
|
+
* Returns all active project boards.
|
|
156
|
+
* @summary Get all project boards
|
|
157
|
+
|
|
158
|
+
* @throws {RequiredError}
|
|
159
|
+
*/
|
|
160
|
+
getProjectsBoards: () => Promise<RequestArgs>;
|
|
161
|
+
/**
|
|
162
|
+
* Returns the details of a specific project phase.
|
|
163
|
+
* @summary Get details of a project phase
|
|
164
|
+
* @param {number} id The ID of the project phase
|
|
165
|
+
|
|
166
|
+
* @throws {RequiredError}
|
|
167
|
+
*/
|
|
168
|
+
getProjectsPhase: (id: number) => Promise<RequestArgs>;
|
|
169
|
+
/**
|
|
170
|
+
* Returns all active project phases under a specific board.
|
|
171
|
+
* @summary Get project phases
|
|
172
|
+
* @param {number} board_id The ID of the board for which phases are requested
|
|
173
|
+
|
|
174
|
+
* @throws {RequiredError}
|
|
175
|
+
*/
|
|
176
|
+
getProjectsPhases: (board_id: number) => Promise<RequestArgs>;
|
|
177
|
+
/**
|
|
178
|
+
* Returns the details of a specific task.
|
|
179
|
+
* @summary Get details of a task
|
|
180
|
+
* @param {number} id The ID of the task
|
|
181
|
+
|
|
182
|
+
* @throws {RequiredError}
|
|
183
|
+
*/
|
|
184
|
+
getTask: (id: number) => Promise<RequestArgs>;
|
|
185
|
+
/**
|
|
186
|
+
* Returns all tasks.
|
|
187
|
+
* @summary Get all tasks
|
|
188
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
189
|
+
* @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.
|
|
190
|
+
* @param {boolean} [is_done] Whether the task is done or not. If omitted, both done and not done tasks are returned.
|
|
191
|
+
* @param {boolean} [is_milestone] Whether the task is a milestone or not. If omitted, both milestone and non-milestone tasks are returned.
|
|
192
|
+
* @param {number} [assignee_id] If supplied, only tasks assigned to this user are returned
|
|
193
|
+
* @param {number} [project_id] If supplied, only tasks belonging to this project are returned
|
|
194
|
+
* @param {string} [parent_task_id] If `null` is supplied, only root-level tasks (without a parent) are returned. If an integer is supplied, only subtasks of that specific task are returned. By default all tasks are returned.
|
|
195
|
+
|
|
196
|
+
* @throws {RequiredError}
|
|
197
|
+
*/
|
|
198
|
+
getTasks: (cursor?: string, limit?: number, is_done?: boolean, is_milestone?: boolean, assignee_id?: number, project_id?: number, parent_task_id?: string) => Promise<RequestArgs>;
|
|
199
|
+
/**
|
|
200
|
+
* Searches all projects by title, description, 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 projects can be filtered by person ID or organization ID.
|
|
201
|
+
* @summary Search projects
|
|
202
|
+
* @param {string} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
|
|
203
|
+
* @param {'custom_fields' | 'notes' | 'title' | 'description'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
204
|
+
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
205
|
+
* @param {number} [person_id] Will filter projects by the provided person ID
|
|
206
|
+
* @param {number} [organization_id] Will filter projects by the provided organization ID
|
|
207
|
+
* @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.
|
|
208
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
209
|
+
|
|
210
|
+
* @throws {RequiredError}
|
|
211
|
+
*/
|
|
212
|
+
searchProjects: (term: string, fields?: 'custom_fields' | 'notes' | 'title' | 'description', exact_match?: boolean, person_id?: number, organization_id?: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
213
|
+
/**
|
|
214
|
+
* Updates the properties of a project board.
|
|
215
|
+
* @summary Update a project board
|
|
216
|
+
* @param {number} id The ID of the project board
|
|
217
|
+
* @param {UpdateProjectBoardRequest} [UpdateProjectBoardRequest]
|
|
218
|
+
|
|
219
|
+
* @throws {RequiredError}
|
|
220
|
+
*/
|
|
221
|
+
updateProjectBoard: (id: number, UpdateProjectBoardRequest?: UpdateProjectBoardRequest) => Promise<RequestArgs>;
|
|
222
|
+
/**
|
|
223
|
+
* Updates a project custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
|
|
224
|
+
* @summary Update one project field
|
|
225
|
+
* @param {string} field_code The unique code identifying the field
|
|
226
|
+
* @param {UpdateProjectFieldRequest} UpdateProjectFieldRequest
|
|
227
|
+
|
|
228
|
+
* @throws {RequiredError}
|
|
229
|
+
*/
|
|
230
|
+
updateProjectField: (field_code: string, UpdateProjectFieldRequest: UpdateProjectFieldRequest) => Promise<RequestArgs>;
|
|
231
|
+
/**
|
|
232
|
+
* Updates existing options for a project custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
|
|
233
|
+
* @summary Update project field options in bulk
|
|
234
|
+
* @param {string} field_code The unique code identifying the field
|
|
235
|
+
* @param {Array<UpdateDealFieldOptionsRequestInner>} UpdateDealFieldOptionsRequestInner
|
|
236
|
+
|
|
237
|
+
* @throws {RequiredError}
|
|
238
|
+
*/
|
|
239
|
+
updateProjectFieldOptions: (field_code: string, UpdateDealFieldOptionsRequestInner: UpdateDealFieldOptionsRequestInner[]) => Promise<RequestArgs>;
|
|
240
|
+
/**
|
|
241
|
+
* Updates the properties of a project phase.
|
|
242
|
+
* @summary Update a project phase
|
|
243
|
+
* @param {number} id The ID of the project phase
|
|
244
|
+
* @param {UpdateProjectPhaseRequest} [UpdateProjectPhaseRequest]
|
|
245
|
+
|
|
246
|
+
* @throws {RequiredError}
|
|
247
|
+
*/
|
|
248
|
+
updateProjectPhase: (id: number, UpdateProjectPhaseRequest?: UpdateProjectPhaseRequest) => Promise<RequestArgs>;
|
|
249
|
+
/**
|
|
250
|
+
* Updates a task.
|
|
251
|
+
* @summary Update a task
|
|
252
|
+
* @param {number} id The ID of the task
|
|
253
|
+
* @param {UpdateTaskRequest} [UpdateTaskRequest]
|
|
254
|
+
|
|
255
|
+
* @throws {RequiredError}
|
|
256
|
+
*/
|
|
257
|
+
updateTask: (id: number, UpdateTaskRequest?: UpdateTaskRequest) => Promise<RequestArgs>;
|
|
258
|
+
};
|
|
259
|
+
/**
|
|
260
|
+
* BetaApi - functional programming interface
|
|
261
|
+
* @export
|
|
262
|
+
*/
|
|
263
|
+
export declare const BetaApiFp: (configuration?: Configuration) => {
|
|
264
|
+
/**
|
|
265
|
+
* Adds a new project board.
|
|
266
|
+
* @summary Add a project board
|
|
267
|
+
* @param {AddProjectBoardRequest} AddProjectBoardRequest
|
|
268
|
+
|
|
269
|
+
* @throws {RequiredError}
|
|
270
|
+
*/
|
|
271
|
+
addProjectBoard(AddProjectBoardRequest: AddProjectBoardRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertProjectBoardResponse>>;
|
|
272
|
+
/**
|
|
273
|
+
* Creates a new project custom field.
|
|
274
|
+
* @summary Create one project field
|
|
275
|
+
* @param {AddProjectFieldRequest} AddProjectFieldRequest
|
|
276
|
+
|
|
277
|
+
* @throws {RequiredError}
|
|
278
|
+
*/
|
|
279
|
+
addProjectField(AddProjectFieldRequest: AddProjectFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddProjectField200Response>>;
|
|
280
|
+
/**
|
|
281
|
+
* Adds new options to a project custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
|
|
282
|
+
* @summary Add project field options in bulk
|
|
283
|
+
* @param {string} field_code The unique code identifying the field
|
|
284
|
+
* @param {Array<AddDealFieldOptionsRequestInner>} AddDealFieldOptionsRequestInner
|
|
285
|
+
|
|
286
|
+
* @throws {RequiredError}
|
|
287
|
+
*/
|
|
288
|
+
addProjectFieldOptions(field_code: string, AddDealFieldOptionsRequestInner: AddDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
|
|
289
|
+
/**
|
|
290
|
+
* Adds a new project phase to a board.
|
|
291
|
+
* @summary Add a project phase
|
|
292
|
+
* @param {AddProjectPhaseRequest} AddProjectPhaseRequest
|
|
293
|
+
|
|
294
|
+
* @throws {RequiredError}
|
|
295
|
+
*/
|
|
296
|
+
addProjectPhase(AddProjectPhaseRequest: AddProjectPhaseRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertProjectPhaseResponse>>;
|
|
297
|
+
/**
|
|
298
|
+
* Adds a new task.
|
|
299
|
+
* @summary Add a task
|
|
300
|
+
* @param {AddTaskRequest} AddTaskRequest
|
|
301
|
+
|
|
302
|
+
* @throws {RequiredError}
|
|
303
|
+
*/
|
|
304
|
+
addTask(AddTaskRequest: AddTaskRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddTaskResponse>>;
|
|
305
|
+
/**
|
|
306
|
+
* Marks a project board as deleted.
|
|
307
|
+
* @summary Delete a project board
|
|
308
|
+
* @param {number} id The ID of the project board
|
|
309
|
+
|
|
310
|
+
* @throws {RequiredError}
|
|
311
|
+
*/
|
|
312
|
+
deleteProjectBoard(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteProjectBoardResponse>>;
|
|
313
|
+
/**
|
|
314
|
+
* Marks a custom field as deleted.
|
|
315
|
+
* @summary Delete one project field
|
|
316
|
+
* @param {string} field_code The unique code identifying the field
|
|
317
|
+
|
|
318
|
+
* @throws {RequiredError}
|
|
319
|
+
*/
|
|
320
|
+
deleteProjectField(field_code: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteProjectField200Response>>;
|
|
321
|
+
/**
|
|
322
|
+
* Removes existing options from a project custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
|
|
323
|
+
* @summary Delete project field options in bulk
|
|
324
|
+
* @param {string} field_code The unique code identifying the field
|
|
325
|
+
* @param {Array<DeleteDealFieldOptionsRequestInner>} DeleteDealFieldOptionsRequestInner
|
|
326
|
+
|
|
327
|
+
* @throws {RequiredError}
|
|
328
|
+
*/
|
|
329
|
+
deleteProjectFieldOptions(field_code: string, DeleteDealFieldOptionsRequestInner: DeleteDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
|
|
330
|
+
/**
|
|
331
|
+
* Marks a project phase as deleted.
|
|
332
|
+
* @summary Delete a project phase
|
|
333
|
+
* @param {number} id The ID of the project phase
|
|
334
|
+
|
|
335
|
+
* @throws {RequiredError}
|
|
336
|
+
*/
|
|
337
|
+
deleteProjectPhase(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteProjectPhaseResponse>>;
|
|
338
|
+
/**
|
|
339
|
+
* Marks a task as deleted. If the task has subtasks, those will also be deleted.
|
|
340
|
+
* @summary Delete a task
|
|
341
|
+
* @param {number} id The ID of the task
|
|
342
|
+
|
|
343
|
+
* @throws {RequiredError}
|
|
344
|
+
*/
|
|
345
|
+
deleteTask(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteTaskResponse>>;
|
|
346
|
+
/**
|
|
347
|
+
* Returns metadata about a specific project field.
|
|
348
|
+
* @summary Get one project field
|
|
349
|
+
* @param {string} field_code The unique code identifying the field
|
|
350
|
+
|
|
351
|
+
* @throws {RequiredError}
|
|
352
|
+
*/
|
|
353
|
+
getProjectField(field_code: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddProjectField200Response>>;
|
|
354
|
+
/**
|
|
355
|
+
* Returns metadata about all project fields in the company.
|
|
356
|
+
* @summary Get all project fields
|
|
357
|
+
* @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.
|
|
358
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
359
|
+
|
|
360
|
+
* @throws {RequiredError}
|
|
361
|
+
*/
|
|
362
|
+
getProjectFields(limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProjectFields200Response>>;
|
|
363
|
+
/**
|
|
364
|
+
* Returns the details of a specific project board.
|
|
365
|
+
* @summary Get details of a project board
|
|
366
|
+
* @param {number} id The ID of the project board
|
|
367
|
+
|
|
368
|
+
* @throws {RequiredError}
|
|
369
|
+
*/
|
|
370
|
+
getProjectsBoard(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertProjectBoardResponse>>;
|
|
371
|
+
/**
|
|
372
|
+
* Returns all active project boards.
|
|
373
|
+
* @summary Get all project boards
|
|
374
|
+
|
|
375
|
+
* @throws {RequiredError}
|
|
376
|
+
*/
|
|
377
|
+
getProjectsBoards(): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProjectBoardsResponse>>;
|
|
378
|
+
/**
|
|
379
|
+
* Returns the details of a specific project phase.
|
|
380
|
+
* @summary Get details of a project phase
|
|
381
|
+
* @param {number} id The ID of the project phase
|
|
382
|
+
|
|
383
|
+
* @throws {RequiredError}
|
|
384
|
+
*/
|
|
385
|
+
getProjectsPhase(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertProjectPhaseResponse>>;
|
|
386
|
+
/**
|
|
387
|
+
* Returns all active project phases under a specific board.
|
|
388
|
+
* @summary Get project phases
|
|
389
|
+
* @param {number} board_id The ID of the board for which phases are requested
|
|
390
|
+
|
|
391
|
+
* @throws {RequiredError}
|
|
392
|
+
*/
|
|
393
|
+
getProjectsPhases(board_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProjectPhasesResponse>>;
|
|
394
|
+
/**
|
|
395
|
+
* Returns the details of a specific task.
|
|
396
|
+
* @summary Get details of a task
|
|
397
|
+
* @param {number} id The ID of the task
|
|
398
|
+
|
|
399
|
+
* @throws {RequiredError}
|
|
400
|
+
*/
|
|
401
|
+
getTask(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetTaskResponse>>;
|
|
402
|
+
/**
|
|
403
|
+
* Returns all tasks.
|
|
404
|
+
* @summary Get all tasks
|
|
405
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
406
|
+
* @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.
|
|
407
|
+
* @param {boolean} [is_done] Whether the task is done or not. If omitted, both done and not done tasks are returned.
|
|
408
|
+
* @param {boolean} [is_milestone] Whether the task is a milestone or not. If omitted, both milestone and non-milestone tasks are returned.
|
|
409
|
+
* @param {number} [assignee_id] If supplied, only tasks assigned to this user are returned
|
|
410
|
+
* @param {number} [project_id] If supplied, only tasks belonging to this project are returned
|
|
411
|
+
* @param {string} [parent_task_id] If `null` is supplied, only root-level tasks (without a parent) are returned. If an integer is supplied, only subtasks of that specific task are returned. By default all tasks are returned.
|
|
412
|
+
|
|
413
|
+
* @throws {RequiredError}
|
|
414
|
+
*/
|
|
415
|
+
getTasks(cursor?: string, limit?: number, is_done?: boolean, is_milestone?: boolean, assignee_id?: number, project_id?: number, parent_task_id?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetTasksResponse>>;
|
|
416
|
+
/**
|
|
417
|
+
* Searches all projects by title, description, 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 projects can be filtered by person ID or organization ID.
|
|
418
|
+
* @summary Search projects
|
|
419
|
+
* @param {string} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
|
|
420
|
+
* @param {'custom_fields' | 'notes' | 'title' | 'description'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
421
|
+
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
422
|
+
* @param {number} [person_id] Will filter projects by the provided person ID
|
|
423
|
+
* @param {number} [organization_id] Will filter projects by the provided organization ID
|
|
424
|
+
* @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.
|
|
425
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
426
|
+
|
|
427
|
+
* @throws {RequiredError}
|
|
428
|
+
*/
|
|
429
|
+
searchProjects(term: string, fields?: 'custom_fields' | 'notes' | 'title' | 'description', exact_match?: boolean, person_id?: number, organization_id?: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProjectSearchResponse>>;
|
|
430
|
+
/**
|
|
431
|
+
* Updates the properties of a project board.
|
|
432
|
+
* @summary Update a project board
|
|
433
|
+
* @param {number} id The ID of the project board
|
|
434
|
+
* @param {UpdateProjectBoardRequest} [UpdateProjectBoardRequest]
|
|
435
|
+
|
|
436
|
+
* @throws {RequiredError}
|
|
437
|
+
*/
|
|
438
|
+
updateProjectBoard(id: number, UpdateProjectBoardRequest?: UpdateProjectBoardRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertProjectBoardResponse>>;
|
|
439
|
+
/**
|
|
440
|
+
* Updates a project custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
|
|
441
|
+
* @summary Update one project field
|
|
442
|
+
* @param {string} field_code The unique code identifying the field
|
|
443
|
+
* @param {UpdateProjectFieldRequest} UpdateProjectFieldRequest
|
|
444
|
+
|
|
445
|
+
* @throws {RequiredError}
|
|
446
|
+
*/
|
|
447
|
+
updateProjectField(field_code: string, UpdateProjectFieldRequest: UpdateProjectFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddProjectField200Response>>;
|
|
448
|
+
/**
|
|
449
|
+
* Updates existing options for a project custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
|
|
450
|
+
* @summary Update project field options in bulk
|
|
451
|
+
* @param {string} field_code The unique code identifying the field
|
|
452
|
+
* @param {Array<UpdateDealFieldOptionsRequestInner>} UpdateDealFieldOptionsRequestInner
|
|
453
|
+
|
|
454
|
+
* @throws {RequiredError}
|
|
455
|
+
*/
|
|
456
|
+
updateProjectFieldOptions(field_code: string, UpdateDealFieldOptionsRequestInner: UpdateDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
|
|
457
|
+
/**
|
|
458
|
+
* Updates the properties of a project phase.
|
|
459
|
+
* @summary Update a project phase
|
|
460
|
+
* @param {number} id The ID of the project phase
|
|
461
|
+
* @param {UpdateProjectPhaseRequest} [UpdateProjectPhaseRequest]
|
|
462
|
+
|
|
463
|
+
* @throws {RequiredError}
|
|
464
|
+
*/
|
|
465
|
+
updateProjectPhase(id: number, UpdateProjectPhaseRequest?: UpdateProjectPhaseRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertProjectPhaseResponse>>;
|
|
466
|
+
/**
|
|
467
|
+
* Updates a task.
|
|
468
|
+
* @summary Update a task
|
|
469
|
+
* @param {number} id The ID of the task
|
|
470
|
+
* @param {UpdateTaskRequest} [UpdateTaskRequest]
|
|
471
|
+
|
|
472
|
+
* @throws {RequiredError}
|
|
473
|
+
*/
|
|
474
|
+
updateTask(id: number, UpdateTaskRequest?: UpdateTaskRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpdateTaskResponse>>;
|
|
475
|
+
};
|
|
476
|
+
/**
|
|
477
|
+
* BetaApi - factory interface
|
|
478
|
+
* @export
|
|
479
|
+
*/
|
|
480
|
+
export declare const BetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
481
|
+
/**
|
|
482
|
+
* Adds a new project board.
|
|
483
|
+
* @summary Add a project board
|
|
484
|
+
* @param {BetaApiAddProjectBoardRequest} requestParameters Request parameters.
|
|
485
|
+
|
|
486
|
+
* @throws {RequiredError}
|
|
487
|
+
*/
|
|
488
|
+
addProjectBoard(requestParameters: BetaApiAddProjectBoardRequest): Promise<UpsertProjectBoardResponse>;
|
|
489
|
+
/**
|
|
490
|
+
* Creates a new project custom field.
|
|
491
|
+
* @summary Create one project field
|
|
492
|
+
* @param {BetaApiAddProjectFieldRequest} requestParameters Request parameters.
|
|
493
|
+
|
|
494
|
+
* @throws {RequiredError}
|
|
495
|
+
*/
|
|
496
|
+
addProjectField(requestParameters: BetaApiAddProjectFieldRequest): Promise<AddProjectField200Response>;
|
|
497
|
+
/**
|
|
498
|
+
* Adds new options to a project custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
|
|
499
|
+
* @summary Add project field options in bulk
|
|
500
|
+
* @param {BetaApiAddProjectFieldOptionsRequest} requestParameters Request parameters.
|
|
501
|
+
|
|
502
|
+
* @throws {RequiredError}
|
|
503
|
+
*/
|
|
504
|
+
addProjectFieldOptions(requestParameters: BetaApiAddProjectFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
|
|
505
|
+
/**
|
|
506
|
+
* Adds a new project phase to a board.
|
|
507
|
+
* @summary Add a project phase
|
|
508
|
+
* @param {BetaApiAddProjectPhaseRequest} requestParameters Request parameters.
|
|
509
|
+
|
|
510
|
+
* @throws {RequiredError}
|
|
511
|
+
*/
|
|
512
|
+
addProjectPhase(requestParameters: BetaApiAddProjectPhaseRequest): Promise<UpsertProjectPhaseResponse>;
|
|
513
|
+
/**
|
|
514
|
+
* Adds a new task.
|
|
515
|
+
* @summary Add a task
|
|
516
|
+
* @param {BetaApiAddTaskRequest} requestParameters Request parameters.
|
|
517
|
+
|
|
518
|
+
* @throws {RequiredError}
|
|
519
|
+
*/
|
|
520
|
+
addTask(requestParameters: BetaApiAddTaskRequest): Promise<AddTaskResponse>;
|
|
521
|
+
/**
|
|
522
|
+
* Marks a project board as deleted.
|
|
523
|
+
* @summary Delete a project board
|
|
524
|
+
* @param {BetaApiDeleteProjectBoardRequest} requestParameters Request parameters.
|
|
525
|
+
|
|
526
|
+
* @throws {RequiredError}
|
|
527
|
+
*/
|
|
528
|
+
deleteProjectBoard(requestParameters: BetaApiDeleteProjectBoardRequest): Promise<DeleteProjectBoardResponse>;
|
|
529
|
+
/**
|
|
530
|
+
* Marks a custom field as deleted.
|
|
531
|
+
* @summary Delete one project field
|
|
532
|
+
* @param {BetaApiDeleteProjectFieldRequest} requestParameters Request parameters.
|
|
533
|
+
|
|
534
|
+
* @throws {RequiredError}
|
|
535
|
+
*/
|
|
536
|
+
deleteProjectField(requestParameters: BetaApiDeleteProjectFieldRequest): Promise<DeleteProjectField200Response>;
|
|
537
|
+
/**
|
|
538
|
+
* Removes existing options from a project custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
|
|
539
|
+
* @summary Delete project field options in bulk
|
|
540
|
+
* @param {BetaApiDeleteProjectFieldOptionsRequest} requestParameters Request parameters.
|
|
541
|
+
|
|
542
|
+
* @throws {RequiredError}
|
|
543
|
+
*/
|
|
544
|
+
deleteProjectFieldOptions(requestParameters: BetaApiDeleteProjectFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
|
|
545
|
+
/**
|
|
546
|
+
* Marks a project phase as deleted.
|
|
547
|
+
* @summary Delete a project phase
|
|
548
|
+
* @param {BetaApiDeleteProjectPhaseRequest} requestParameters Request parameters.
|
|
549
|
+
|
|
550
|
+
* @throws {RequiredError}
|
|
551
|
+
*/
|
|
552
|
+
deleteProjectPhase(requestParameters: BetaApiDeleteProjectPhaseRequest): Promise<DeleteProjectPhaseResponse>;
|
|
553
|
+
/**
|
|
554
|
+
* Marks a task as deleted. If the task has subtasks, those will also be deleted.
|
|
555
|
+
* @summary Delete a task
|
|
556
|
+
* @param {BetaApiDeleteTaskRequest} requestParameters Request parameters.
|
|
557
|
+
|
|
558
|
+
* @throws {RequiredError}
|
|
559
|
+
*/
|
|
560
|
+
deleteTask(requestParameters: BetaApiDeleteTaskRequest): Promise<DeleteTaskResponse>;
|
|
561
|
+
/**
|
|
562
|
+
* Returns metadata about a specific project field.
|
|
563
|
+
* @summary Get one project field
|
|
564
|
+
* @param {BetaApiGetProjectFieldRequest} requestParameters Request parameters.
|
|
565
|
+
|
|
566
|
+
* @throws {RequiredError}
|
|
567
|
+
*/
|
|
568
|
+
getProjectField(requestParameters: BetaApiGetProjectFieldRequest): Promise<AddProjectField200Response>;
|
|
569
|
+
/**
|
|
570
|
+
* Returns metadata about all project fields in the company.
|
|
571
|
+
* @summary Get all project fields
|
|
572
|
+
* @param {BetaApiGetProjectFieldsRequest} requestParameters Request parameters.
|
|
573
|
+
|
|
574
|
+
* @throws {RequiredError}
|
|
575
|
+
*/
|
|
576
|
+
getProjectFields(requestParameters?: BetaApiGetProjectFieldsRequest): Promise<GetProjectFields200Response>;
|
|
577
|
+
/**
|
|
578
|
+
* Returns the details of a specific project board.
|
|
579
|
+
* @summary Get details of a project board
|
|
580
|
+
* @param {BetaApiGetProjectsBoardRequest} requestParameters Request parameters.
|
|
581
|
+
|
|
582
|
+
* @throws {RequiredError}
|
|
583
|
+
*/
|
|
584
|
+
getProjectsBoard(requestParameters: BetaApiGetProjectsBoardRequest): Promise<UpsertProjectBoardResponse>;
|
|
585
|
+
/**
|
|
586
|
+
* Returns all active project boards.
|
|
587
|
+
* @summary Get all project boards
|
|
588
|
+
|
|
589
|
+
* @throws {RequiredError}
|
|
590
|
+
*/
|
|
591
|
+
getProjectsBoards(): Promise<GetProjectBoardsResponse>;
|
|
592
|
+
/**
|
|
593
|
+
* Returns the details of a specific project phase.
|
|
594
|
+
* @summary Get details of a project phase
|
|
595
|
+
* @param {BetaApiGetProjectsPhaseRequest} requestParameters Request parameters.
|
|
596
|
+
|
|
597
|
+
* @throws {RequiredError}
|
|
598
|
+
*/
|
|
599
|
+
getProjectsPhase(requestParameters: BetaApiGetProjectsPhaseRequest): Promise<UpsertProjectPhaseResponse>;
|
|
600
|
+
/**
|
|
601
|
+
* Returns all active project phases under a specific board.
|
|
602
|
+
* @summary Get project phases
|
|
603
|
+
* @param {BetaApiGetProjectsPhasesRequest} requestParameters Request parameters.
|
|
604
|
+
|
|
605
|
+
* @throws {RequiredError}
|
|
606
|
+
*/
|
|
607
|
+
getProjectsPhases(requestParameters: BetaApiGetProjectsPhasesRequest): Promise<GetProjectPhasesResponse>;
|
|
608
|
+
/**
|
|
609
|
+
* Returns the details of a specific task.
|
|
610
|
+
* @summary Get details of a task
|
|
611
|
+
* @param {BetaApiGetTaskRequest} requestParameters Request parameters.
|
|
612
|
+
|
|
613
|
+
* @throws {RequiredError}
|
|
614
|
+
*/
|
|
615
|
+
getTask(requestParameters: BetaApiGetTaskRequest): Promise<GetTaskResponse>;
|
|
616
|
+
/**
|
|
617
|
+
* Returns all tasks.
|
|
618
|
+
* @summary Get all tasks
|
|
619
|
+
* @param {BetaApiGetTasksRequest} requestParameters Request parameters.
|
|
620
|
+
|
|
621
|
+
* @throws {RequiredError}
|
|
622
|
+
*/
|
|
623
|
+
getTasks(requestParameters?: BetaApiGetTasksRequest): Promise<GetTasksResponse>;
|
|
624
|
+
/**
|
|
625
|
+
* Searches all projects by title, description, 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 projects can be filtered by person ID or organization ID.
|
|
626
|
+
* @summary Search projects
|
|
627
|
+
* @param {BetaApiSearchProjectsRequest} requestParameters Request parameters.
|
|
628
|
+
|
|
629
|
+
* @throws {RequiredError}
|
|
630
|
+
*/
|
|
631
|
+
searchProjects(requestParameters: BetaApiSearchProjectsRequest): Promise<GetProjectSearchResponse>;
|
|
632
|
+
/**
|
|
633
|
+
* Updates the properties of a project board.
|
|
634
|
+
* @summary Update a project board
|
|
635
|
+
* @param {BetaApiUpdateProjectBoardRequest} requestParameters Request parameters.
|
|
636
|
+
|
|
637
|
+
* @throws {RequiredError}
|
|
638
|
+
*/
|
|
639
|
+
updateProjectBoard(requestParameters: BetaApiUpdateProjectBoardRequest): Promise<UpsertProjectBoardResponse>;
|
|
640
|
+
/**
|
|
641
|
+
* Updates a project custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
|
|
642
|
+
* @summary Update one project field
|
|
643
|
+
* @param {BetaApiUpdateProjectFieldRequest} requestParameters Request parameters.
|
|
644
|
+
|
|
645
|
+
* @throws {RequiredError}
|
|
646
|
+
*/
|
|
647
|
+
updateProjectField(requestParameters: BetaApiUpdateProjectFieldRequest): Promise<AddProjectField200Response>;
|
|
648
|
+
/**
|
|
649
|
+
* Updates existing options for a project custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
|
|
650
|
+
* @summary Update project field options in bulk
|
|
651
|
+
* @param {BetaApiUpdateProjectFieldOptionsRequest} requestParameters Request parameters.
|
|
652
|
+
|
|
653
|
+
* @throws {RequiredError}
|
|
654
|
+
*/
|
|
655
|
+
updateProjectFieldOptions(requestParameters: BetaApiUpdateProjectFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
|
|
656
|
+
/**
|
|
657
|
+
* Updates the properties of a project phase.
|
|
658
|
+
* @summary Update a project phase
|
|
659
|
+
* @param {BetaApiUpdateProjectPhaseRequest} requestParameters Request parameters.
|
|
660
|
+
|
|
661
|
+
* @throws {RequiredError}
|
|
662
|
+
*/
|
|
663
|
+
updateProjectPhase(requestParameters: BetaApiUpdateProjectPhaseRequest): Promise<UpsertProjectPhaseResponse>;
|
|
664
|
+
/**
|
|
665
|
+
* Updates a task.
|
|
666
|
+
* @summary Update a task
|
|
667
|
+
* @param {BetaApiUpdateTaskRequest} requestParameters Request parameters.
|
|
668
|
+
|
|
669
|
+
* @throws {RequiredError}
|
|
670
|
+
*/
|
|
671
|
+
updateTask(requestParameters: BetaApiUpdateTaskRequest): Promise<UpdateTaskResponse>;
|
|
672
|
+
};
|
|
673
|
+
/**
|
|
674
|
+
* Request parameters for addProjectBoard operation in BetaApi.
|
|
675
|
+
* @export
|
|
676
|
+
* @interface BetaApiAddProjectBoardRequest
|
|
677
|
+
*/
|
|
678
|
+
export interface BetaApiAddProjectBoardRequest {
|
|
679
|
+
/**
|
|
680
|
+
*
|
|
681
|
+
* @type {AddProjectBoardRequest}
|
|
682
|
+
* @memberof BetaApiAddProjectBoard
|
|
683
|
+
*/
|
|
684
|
+
readonly AddProjectBoardRequest: AddProjectBoardRequest;
|
|
685
|
+
}
|
|
686
|
+
/**
|
|
687
|
+
* Request parameters for addProjectField operation in BetaApi.
|
|
688
|
+
* @export
|
|
689
|
+
* @interface BetaApiAddProjectFieldRequest
|
|
690
|
+
*/
|
|
691
|
+
export interface BetaApiAddProjectFieldRequest {
|
|
692
|
+
/**
|
|
693
|
+
*
|
|
694
|
+
* @type {AddProjectFieldRequest}
|
|
695
|
+
* @memberof BetaApiAddProjectField
|
|
696
|
+
*/
|
|
697
|
+
readonly AddProjectFieldRequest: AddProjectFieldRequest;
|
|
698
|
+
}
|
|
699
|
+
/**
|
|
700
|
+
* Request parameters for addProjectFieldOptions operation in BetaApi.
|
|
701
|
+
* @export
|
|
702
|
+
* @interface BetaApiAddProjectFieldOptionsRequest
|
|
703
|
+
*/
|
|
704
|
+
export interface BetaApiAddProjectFieldOptionsRequest {
|
|
705
|
+
/**
|
|
706
|
+
* The unique code identifying the field
|
|
707
|
+
* @type {string}
|
|
708
|
+
* @memberof BetaApiAddProjectFieldOptions
|
|
709
|
+
*/
|
|
710
|
+
readonly field_code: string;
|
|
711
|
+
/**
|
|
712
|
+
*
|
|
713
|
+
* @type {Array<AddDealFieldOptionsRequestInner>}
|
|
714
|
+
* @memberof BetaApiAddProjectFieldOptions
|
|
715
|
+
*/
|
|
716
|
+
readonly AddDealFieldOptionsRequestInner: Array<AddDealFieldOptionsRequestInner>;
|
|
717
|
+
}
|
|
718
|
+
/**
|
|
719
|
+
* Request parameters for addProjectPhase operation in BetaApi.
|
|
720
|
+
* @export
|
|
721
|
+
* @interface BetaApiAddProjectPhaseRequest
|
|
722
|
+
*/
|
|
723
|
+
export interface BetaApiAddProjectPhaseRequest {
|
|
724
|
+
/**
|
|
725
|
+
*
|
|
726
|
+
* @type {AddProjectPhaseRequest}
|
|
727
|
+
* @memberof BetaApiAddProjectPhase
|
|
728
|
+
*/
|
|
729
|
+
readonly AddProjectPhaseRequest: AddProjectPhaseRequest;
|
|
730
|
+
}
|
|
731
|
+
/**
|
|
732
|
+
* Request parameters for addTask operation in BetaApi.
|
|
733
|
+
* @export
|
|
734
|
+
* @interface BetaApiAddTaskRequest
|
|
735
|
+
*/
|
|
736
|
+
export interface BetaApiAddTaskRequest {
|
|
737
|
+
/**
|
|
738
|
+
*
|
|
739
|
+
* @type {AddTaskRequest}
|
|
740
|
+
* @memberof BetaApiAddTask
|
|
741
|
+
*/
|
|
742
|
+
readonly AddTaskRequest: AddTaskRequest;
|
|
743
|
+
}
|
|
744
|
+
/**
|
|
745
|
+
* Request parameters for deleteProjectBoard operation in BetaApi.
|
|
746
|
+
* @export
|
|
747
|
+
* @interface BetaApiDeleteProjectBoardRequest
|
|
748
|
+
*/
|
|
749
|
+
export interface BetaApiDeleteProjectBoardRequest {
|
|
750
|
+
/**
|
|
751
|
+
* The ID of the project board
|
|
752
|
+
* @type {number}
|
|
753
|
+
* @memberof BetaApiDeleteProjectBoard
|
|
754
|
+
*/
|
|
755
|
+
readonly id: number;
|
|
756
|
+
}
|
|
757
|
+
/**
|
|
758
|
+
* Request parameters for deleteProjectField operation in BetaApi.
|
|
759
|
+
* @export
|
|
760
|
+
* @interface BetaApiDeleteProjectFieldRequest
|
|
761
|
+
*/
|
|
762
|
+
export interface BetaApiDeleteProjectFieldRequest {
|
|
763
|
+
/**
|
|
764
|
+
* The unique code identifying the field
|
|
765
|
+
* @type {string}
|
|
766
|
+
* @memberof BetaApiDeleteProjectField
|
|
767
|
+
*/
|
|
768
|
+
readonly field_code: string;
|
|
769
|
+
}
|
|
770
|
+
/**
|
|
771
|
+
* Request parameters for deleteProjectFieldOptions operation in BetaApi.
|
|
772
|
+
* @export
|
|
773
|
+
* @interface BetaApiDeleteProjectFieldOptionsRequest
|
|
774
|
+
*/
|
|
775
|
+
export interface BetaApiDeleteProjectFieldOptionsRequest {
|
|
776
|
+
/**
|
|
777
|
+
* The unique code identifying the field
|
|
778
|
+
* @type {string}
|
|
779
|
+
* @memberof BetaApiDeleteProjectFieldOptions
|
|
780
|
+
*/
|
|
781
|
+
readonly field_code: string;
|
|
782
|
+
/**
|
|
783
|
+
*
|
|
784
|
+
* @type {Array<DeleteDealFieldOptionsRequestInner>}
|
|
785
|
+
* @memberof BetaApiDeleteProjectFieldOptions
|
|
786
|
+
*/
|
|
787
|
+
readonly DeleteDealFieldOptionsRequestInner: Array<DeleteDealFieldOptionsRequestInner>;
|
|
788
|
+
}
|
|
789
|
+
/**
|
|
790
|
+
* Request parameters for deleteProjectPhase operation in BetaApi.
|
|
791
|
+
* @export
|
|
792
|
+
* @interface BetaApiDeleteProjectPhaseRequest
|
|
793
|
+
*/
|
|
794
|
+
export interface BetaApiDeleteProjectPhaseRequest {
|
|
795
|
+
/**
|
|
796
|
+
* The ID of the project phase
|
|
797
|
+
* @type {number}
|
|
798
|
+
* @memberof BetaApiDeleteProjectPhase
|
|
799
|
+
*/
|
|
800
|
+
readonly id: number;
|
|
801
|
+
}
|
|
802
|
+
/**
|
|
803
|
+
* Request parameters for deleteTask operation in BetaApi.
|
|
804
|
+
* @export
|
|
805
|
+
* @interface BetaApiDeleteTaskRequest
|
|
806
|
+
*/
|
|
807
|
+
export interface BetaApiDeleteTaskRequest {
|
|
808
|
+
/**
|
|
809
|
+
* The ID of the task
|
|
810
|
+
* @type {number}
|
|
811
|
+
* @memberof BetaApiDeleteTask
|
|
812
|
+
*/
|
|
813
|
+
readonly id: number;
|
|
814
|
+
}
|
|
815
|
+
/**
|
|
816
|
+
* Request parameters for getProjectField operation in BetaApi.
|
|
817
|
+
* @export
|
|
818
|
+
* @interface BetaApiGetProjectFieldRequest
|
|
819
|
+
*/
|
|
820
|
+
export interface BetaApiGetProjectFieldRequest {
|
|
821
|
+
/**
|
|
822
|
+
* The unique code identifying the field
|
|
823
|
+
* @type {string}
|
|
824
|
+
* @memberof BetaApiGetProjectField
|
|
825
|
+
*/
|
|
826
|
+
readonly field_code: string;
|
|
827
|
+
}
|
|
828
|
+
/**
|
|
829
|
+
* Request parameters for getProjectFields operation in BetaApi.
|
|
830
|
+
* @export
|
|
831
|
+
* @interface BetaApiGetProjectFieldsRequest
|
|
832
|
+
*/
|
|
833
|
+
export interface BetaApiGetProjectFieldsRequest {
|
|
834
|
+
/**
|
|
835
|
+
* 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.
|
|
836
|
+
* @type {number}
|
|
837
|
+
* @memberof BetaApiGetProjectFields
|
|
838
|
+
*/
|
|
839
|
+
readonly limit?: number;
|
|
840
|
+
/**
|
|
841
|
+
* For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
842
|
+
* @type {string}
|
|
843
|
+
* @memberof BetaApiGetProjectFields
|
|
844
|
+
*/
|
|
845
|
+
readonly cursor?: string;
|
|
846
|
+
}
|
|
847
|
+
/**
|
|
848
|
+
* Request parameters for getProjectsBoard operation in BetaApi.
|
|
849
|
+
* @export
|
|
850
|
+
* @interface BetaApiGetProjectsBoardRequest
|
|
851
|
+
*/
|
|
852
|
+
export interface BetaApiGetProjectsBoardRequest {
|
|
853
|
+
/**
|
|
854
|
+
* The ID of the project board
|
|
855
|
+
* @type {number}
|
|
856
|
+
* @memberof BetaApiGetProjectsBoard
|
|
857
|
+
*/
|
|
858
|
+
readonly id: number;
|
|
859
|
+
}
|
|
860
|
+
/**
|
|
861
|
+
* Request parameters for getProjectsPhase operation in BetaApi.
|
|
862
|
+
* @export
|
|
863
|
+
* @interface BetaApiGetProjectsPhaseRequest
|
|
864
|
+
*/
|
|
865
|
+
export interface BetaApiGetProjectsPhaseRequest {
|
|
866
|
+
/**
|
|
867
|
+
* The ID of the project phase
|
|
868
|
+
* @type {number}
|
|
869
|
+
* @memberof BetaApiGetProjectsPhase
|
|
870
|
+
*/
|
|
871
|
+
readonly id: number;
|
|
872
|
+
}
|
|
873
|
+
/**
|
|
874
|
+
* Request parameters for getProjectsPhases operation in BetaApi.
|
|
875
|
+
* @export
|
|
876
|
+
* @interface BetaApiGetProjectsPhasesRequest
|
|
877
|
+
*/
|
|
878
|
+
export interface BetaApiGetProjectsPhasesRequest {
|
|
879
|
+
/**
|
|
880
|
+
* The ID of the board for which phases are requested
|
|
881
|
+
* @type {number}
|
|
882
|
+
* @memberof BetaApiGetProjectsPhases
|
|
883
|
+
*/
|
|
884
|
+
readonly board_id: number;
|
|
885
|
+
}
|
|
886
|
+
/**
|
|
887
|
+
* Request parameters for getTask operation in BetaApi.
|
|
888
|
+
* @export
|
|
889
|
+
* @interface BetaApiGetTaskRequest
|
|
890
|
+
*/
|
|
891
|
+
export interface BetaApiGetTaskRequest {
|
|
892
|
+
/**
|
|
893
|
+
* The ID of the task
|
|
894
|
+
* @type {number}
|
|
895
|
+
* @memberof BetaApiGetTask
|
|
896
|
+
*/
|
|
897
|
+
readonly id: number;
|
|
898
|
+
}
|
|
899
|
+
/**
|
|
900
|
+
* Request parameters for getTasks operation in BetaApi.
|
|
901
|
+
* @export
|
|
902
|
+
* @interface BetaApiGetTasksRequest
|
|
903
|
+
*/
|
|
904
|
+
export interface BetaApiGetTasksRequest {
|
|
905
|
+
/**
|
|
906
|
+
* For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
907
|
+
* @type {string}
|
|
908
|
+
* @memberof BetaApiGetTasks
|
|
909
|
+
*/
|
|
910
|
+
readonly cursor?: string;
|
|
911
|
+
/**
|
|
912
|
+
* 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.
|
|
913
|
+
* @type {number}
|
|
914
|
+
* @memberof BetaApiGetTasks
|
|
915
|
+
*/
|
|
916
|
+
readonly limit?: number;
|
|
917
|
+
/**
|
|
918
|
+
* Whether the task is done or not. If omitted, both done and not done tasks are returned.
|
|
919
|
+
* @type {boolean}
|
|
920
|
+
* @memberof BetaApiGetTasks
|
|
921
|
+
*/
|
|
922
|
+
readonly is_done?: boolean;
|
|
923
|
+
/**
|
|
924
|
+
* Whether the task is a milestone or not. If omitted, both milestone and non-milestone tasks are returned.
|
|
925
|
+
* @type {boolean}
|
|
926
|
+
* @memberof BetaApiGetTasks
|
|
927
|
+
*/
|
|
928
|
+
readonly is_milestone?: boolean;
|
|
929
|
+
/**
|
|
930
|
+
* If supplied, only tasks assigned to this user are returned
|
|
931
|
+
* @type {number}
|
|
932
|
+
* @memberof BetaApiGetTasks
|
|
933
|
+
*/
|
|
934
|
+
readonly assignee_id?: number;
|
|
935
|
+
/**
|
|
936
|
+
* If supplied, only tasks belonging to this project are returned
|
|
937
|
+
* @type {number}
|
|
938
|
+
* @memberof BetaApiGetTasks
|
|
939
|
+
*/
|
|
940
|
+
readonly project_id?: number;
|
|
941
|
+
/**
|
|
942
|
+
* If `null` is supplied, only root-level tasks (without a parent) are returned. If an integer is supplied, only subtasks of that specific task are returned. By default all tasks are returned.
|
|
943
|
+
* @type {string}
|
|
944
|
+
* @memberof BetaApiGetTasks
|
|
945
|
+
*/
|
|
946
|
+
readonly parent_task_id?: string;
|
|
947
|
+
}
|
|
948
|
+
/**
|
|
949
|
+
* Request parameters for searchProjects operation in BetaApi.
|
|
950
|
+
* @export
|
|
951
|
+
* @interface BetaApiSearchProjectsRequest
|
|
952
|
+
*/
|
|
953
|
+
export interface BetaApiSearchProjectsRequest {
|
|
954
|
+
/**
|
|
955
|
+
* The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
|
|
956
|
+
* @type {string}
|
|
957
|
+
* @memberof BetaApiSearchProjects
|
|
958
|
+
*/
|
|
959
|
+
readonly term: string;
|
|
960
|
+
/**
|
|
961
|
+
* A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
962
|
+
* @type {'custom_fields' | 'notes' | 'title' | 'description'}
|
|
963
|
+
* @memberof BetaApiSearchProjects
|
|
964
|
+
*/
|
|
965
|
+
readonly fields?: 'custom_fields' | 'notes' | 'title' | 'description';
|
|
966
|
+
/**
|
|
967
|
+
* When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
968
|
+
* @type {boolean}
|
|
969
|
+
* @memberof BetaApiSearchProjects
|
|
970
|
+
*/
|
|
971
|
+
readonly exact_match?: boolean;
|
|
972
|
+
/**
|
|
973
|
+
* Will filter projects by the provided person ID
|
|
974
|
+
* @type {number}
|
|
975
|
+
* @memberof BetaApiSearchProjects
|
|
976
|
+
*/
|
|
977
|
+
readonly person_id?: number;
|
|
978
|
+
/**
|
|
979
|
+
* Will filter projects by the provided organization ID
|
|
980
|
+
* @type {number}
|
|
981
|
+
* @memberof BetaApiSearchProjects
|
|
982
|
+
*/
|
|
983
|
+
readonly organization_id?: number;
|
|
984
|
+
/**
|
|
985
|
+
* 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.
|
|
986
|
+
* @type {number}
|
|
987
|
+
* @memberof BetaApiSearchProjects
|
|
988
|
+
*/
|
|
989
|
+
readonly limit?: number;
|
|
990
|
+
/**
|
|
991
|
+
* For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
992
|
+
* @type {string}
|
|
993
|
+
* @memberof BetaApiSearchProjects
|
|
994
|
+
*/
|
|
995
|
+
readonly cursor?: string;
|
|
996
|
+
}
|
|
997
|
+
/**
|
|
998
|
+
* Request parameters for updateProjectBoard operation in BetaApi.
|
|
999
|
+
* @export
|
|
1000
|
+
* @interface BetaApiUpdateProjectBoardRequest
|
|
1001
|
+
*/
|
|
1002
|
+
export interface BetaApiUpdateProjectBoardRequest {
|
|
1003
|
+
/**
|
|
1004
|
+
* The ID of the project board
|
|
1005
|
+
* @type {number}
|
|
1006
|
+
* @memberof BetaApiUpdateProjectBoard
|
|
1007
|
+
*/
|
|
1008
|
+
readonly id: number;
|
|
1009
|
+
/**
|
|
1010
|
+
*
|
|
1011
|
+
* @type {UpdateProjectBoardRequest}
|
|
1012
|
+
* @memberof BetaApiUpdateProjectBoard
|
|
1013
|
+
*/
|
|
1014
|
+
readonly UpdateProjectBoardRequest?: UpdateProjectBoardRequest;
|
|
1015
|
+
}
|
|
1016
|
+
/**
|
|
1017
|
+
* Request parameters for updateProjectField operation in BetaApi.
|
|
1018
|
+
* @export
|
|
1019
|
+
* @interface BetaApiUpdateProjectFieldRequest
|
|
1020
|
+
*/
|
|
1021
|
+
export interface BetaApiUpdateProjectFieldRequest {
|
|
1022
|
+
/**
|
|
1023
|
+
* The unique code identifying the field
|
|
1024
|
+
* @type {string}
|
|
1025
|
+
* @memberof BetaApiUpdateProjectField
|
|
1026
|
+
*/
|
|
1027
|
+
readonly field_code: string;
|
|
1028
|
+
/**
|
|
1029
|
+
*
|
|
1030
|
+
* @type {UpdateProjectFieldRequest}
|
|
1031
|
+
* @memberof BetaApiUpdateProjectField
|
|
1032
|
+
*/
|
|
1033
|
+
readonly UpdateProjectFieldRequest: UpdateProjectFieldRequest;
|
|
1034
|
+
}
|
|
1035
|
+
/**
|
|
1036
|
+
* Request parameters for updateProjectFieldOptions operation in BetaApi.
|
|
1037
|
+
* @export
|
|
1038
|
+
* @interface BetaApiUpdateProjectFieldOptionsRequest
|
|
1039
|
+
*/
|
|
1040
|
+
export interface BetaApiUpdateProjectFieldOptionsRequest {
|
|
1041
|
+
/**
|
|
1042
|
+
* The unique code identifying the field
|
|
1043
|
+
* @type {string}
|
|
1044
|
+
* @memberof BetaApiUpdateProjectFieldOptions
|
|
1045
|
+
*/
|
|
1046
|
+
readonly field_code: string;
|
|
1047
|
+
/**
|
|
1048
|
+
*
|
|
1049
|
+
* @type {Array<UpdateDealFieldOptionsRequestInner>}
|
|
1050
|
+
* @memberof BetaApiUpdateProjectFieldOptions
|
|
1051
|
+
*/
|
|
1052
|
+
readonly UpdateDealFieldOptionsRequestInner: Array<UpdateDealFieldOptionsRequestInner>;
|
|
1053
|
+
}
|
|
1054
|
+
/**
|
|
1055
|
+
* Request parameters for updateProjectPhase operation in BetaApi.
|
|
1056
|
+
* @export
|
|
1057
|
+
* @interface BetaApiUpdateProjectPhaseRequest
|
|
1058
|
+
*/
|
|
1059
|
+
export interface BetaApiUpdateProjectPhaseRequest {
|
|
1060
|
+
/**
|
|
1061
|
+
* The ID of the project phase
|
|
1062
|
+
* @type {number}
|
|
1063
|
+
* @memberof BetaApiUpdateProjectPhase
|
|
1064
|
+
*/
|
|
1065
|
+
readonly id: number;
|
|
1066
|
+
/**
|
|
1067
|
+
*
|
|
1068
|
+
* @type {UpdateProjectPhaseRequest}
|
|
1069
|
+
* @memberof BetaApiUpdateProjectPhase
|
|
1070
|
+
*/
|
|
1071
|
+
readonly UpdateProjectPhaseRequest?: UpdateProjectPhaseRequest;
|
|
1072
|
+
}
|
|
1073
|
+
/**
|
|
1074
|
+
* Request parameters for updateTask operation in BetaApi.
|
|
1075
|
+
* @export
|
|
1076
|
+
* @interface BetaApiUpdateTaskRequest
|
|
1077
|
+
*/
|
|
1078
|
+
export interface BetaApiUpdateTaskRequest {
|
|
1079
|
+
/**
|
|
1080
|
+
* The ID of the task
|
|
1081
|
+
* @type {number}
|
|
1082
|
+
* @memberof BetaApiUpdateTask
|
|
1083
|
+
*/
|
|
1084
|
+
readonly id: number;
|
|
1085
|
+
/**
|
|
1086
|
+
*
|
|
1087
|
+
* @type {UpdateTaskRequest}
|
|
1088
|
+
* @memberof BetaApiUpdateTask
|
|
1089
|
+
*/
|
|
1090
|
+
readonly UpdateTaskRequest?: UpdateTaskRequest;
|
|
1091
|
+
}
|
|
1092
|
+
/**
|
|
1093
|
+
* BetaApi - object-oriented interface
|
|
1094
|
+
* @export
|
|
1095
|
+
* @class BetaApi
|
|
1096
|
+
* @extends {BaseAPI}
|
|
1097
|
+
*/
|
|
1098
|
+
export declare class BetaApi extends BaseAPI {
|
|
1099
|
+
/**
|
|
1100
|
+
* Adds a new project board.
|
|
1101
|
+
* @summary Add a project board
|
|
1102
|
+
* @param {BetaApiAddProjectBoardRequest} requestParameters Request parameters.
|
|
1103
|
+
|
|
1104
|
+
* @throws {RequiredError}
|
|
1105
|
+
* @memberof BetaApi
|
|
1106
|
+
*/
|
|
1107
|
+
addProjectBoard(requestParameters: BetaApiAddProjectBoardRequest): Promise<UpsertProjectBoardResponse>;
|
|
1108
|
+
/**
|
|
1109
|
+
* Creates a new project custom field.
|
|
1110
|
+
* @summary Create one project field
|
|
1111
|
+
* @param {BetaApiAddProjectFieldRequest} requestParameters Request parameters.
|
|
1112
|
+
|
|
1113
|
+
* @throws {RequiredError}
|
|
1114
|
+
* @memberof BetaApi
|
|
1115
|
+
*/
|
|
1116
|
+
addProjectField(requestParameters: BetaApiAddProjectFieldRequest): Promise<AddProjectField200Response>;
|
|
1117
|
+
/**
|
|
1118
|
+
* Adds new options to a project custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
|
|
1119
|
+
* @summary Add project field options in bulk
|
|
1120
|
+
* @param {BetaApiAddProjectFieldOptionsRequest} requestParameters Request parameters.
|
|
1121
|
+
|
|
1122
|
+
* @throws {RequiredError}
|
|
1123
|
+
* @memberof BetaApi
|
|
1124
|
+
*/
|
|
1125
|
+
addProjectFieldOptions(requestParameters: BetaApiAddProjectFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
|
|
1126
|
+
/**
|
|
1127
|
+
* Adds a new project phase to a board.
|
|
1128
|
+
* @summary Add a project phase
|
|
1129
|
+
* @param {BetaApiAddProjectPhaseRequest} requestParameters Request parameters.
|
|
1130
|
+
|
|
1131
|
+
* @throws {RequiredError}
|
|
1132
|
+
* @memberof BetaApi
|
|
1133
|
+
*/
|
|
1134
|
+
addProjectPhase(requestParameters: BetaApiAddProjectPhaseRequest): Promise<UpsertProjectPhaseResponse>;
|
|
1135
|
+
/**
|
|
1136
|
+
* Adds a new task.
|
|
1137
|
+
* @summary Add a task
|
|
1138
|
+
* @param {BetaApiAddTaskRequest} requestParameters Request parameters.
|
|
1139
|
+
|
|
1140
|
+
* @throws {RequiredError}
|
|
1141
|
+
* @memberof BetaApi
|
|
1142
|
+
*/
|
|
1143
|
+
addTask(requestParameters: BetaApiAddTaskRequest): Promise<AddTaskResponse>;
|
|
1144
|
+
/**
|
|
1145
|
+
* Marks a project board as deleted.
|
|
1146
|
+
* @summary Delete a project board
|
|
1147
|
+
* @param {BetaApiDeleteProjectBoardRequest} requestParameters Request parameters.
|
|
1148
|
+
|
|
1149
|
+
* @throws {RequiredError}
|
|
1150
|
+
* @memberof BetaApi
|
|
1151
|
+
*/
|
|
1152
|
+
deleteProjectBoard(requestParameters: BetaApiDeleteProjectBoardRequest): Promise<DeleteProjectBoardResponse>;
|
|
1153
|
+
/**
|
|
1154
|
+
* Marks a custom field as deleted.
|
|
1155
|
+
* @summary Delete one project field
|
|
1156
|
+
* @param {BetaApiDeleteProjectFieldRequest} requestParameters Request parameters.
|
|
1157
|
+
|
|
1158
|
+
* @throws {RequiredError}
|
|
1159
|
+
* @memberof BetaApi
|
|
1160
|
+
*/
|
|
1161
|
+
deleteProjectField(requestParameters: BetaApiDeleteProjectFieldRequest): Promise<DeleteProjectField200Response>;
|
|
1162
|
+
/**
|
|
1163
|
+
* Removes existing options from a project custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
|
|
1164
|
+
* @summary Delete project field options in bulk
|
|
1165
|
+
* @param {BetaApiDeleteProjectFieldOptionsRequest} requestParameters Request parameters.
|
|
1166
|
+
|
|
1167
|
+
* @throws {RequiredError}
|
|
1168
|
+
* @memberof BetaApi
|
|
1169
|
+
*/
|
|
1170
|
+
deleteProjectFieldOptions(requestParameters: BetaApiDeleteProjectFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
|
|
1171
|
+
/**
|
|
1172
|
+
* Marks a project phase as deleted.
|
|
1173
|
+
* @summary Delete a project phase
|
|
1174
|
+
* @param {BetaApiDeleteProjectPhaseRequest} requestParameters Request parameters.
|
|
1175
|
+
|
|
1176
|
+
* @throws {RequiredError}
|
|
1177
|
+
* @memberof BetaApi
|
|
1178
|
+
*/
|
|
1179
|
+
deleteProjectPhase(requestParameters: BetaApiDeleteProjectPhaseRequest): Promise<DeleteProjectPhaseResponse>;
|
|
1180
|
+
/**
|
|
1181
|
+
* Marks a task as deleted. If the task has subtasks, those will also be deleted.
|
|
1182
|
+
* @summary Delete a task
|
|
1183
|
+
* @param {BetaApiDeleteTaskRequest} requestParameters Request parameters.
|
|
1184
|
+
|
|
1185
|
+
* @throws {RequiredError}
|
|
1186
|
+
* @memberof BetaApi
|
|
1187
|
+
*/
|
|
1188
|
+
deleteTask(requestParameters: BetaApiDeleteTaskRequest): Promise<DeleteTaskResponse>;
|
|
1189
|
+
/**
|
|
1190
|
+
* Returns metadata about a specific project field.
|
|
1191
|
+
* @summary Get one project field
|
|
1192
|
+
* @param {BetaApiGetProjectFieldRequest} requestParameters Request parameters.
|
|
1193
|
+
|
|
1194
|
+
* @throws {RequiredError}
|
|
1195
|
+
* @memberof BetaApi
|
|
1196
|
+
*/
|
|
1197
|
+
getProjectField(requestParameters: BetaApiGetProjectFieldRequest): Promise<AddProjectField200Response>;
|
|
1198
|
+
/**
|
|
1199
|
+
* Returns metadata about all project fields in the company.
|
|
1200
|
+
* @summary Get all project fields
|
|
1201
|
+
* @param {BetaApiGetProjectFieldsRequest} requestParameters Request parameters.
|
|
1202
|
+
|
|
1203
|
+
* @throws {RequiredError}
|
|
1204
|
+
* @memberof BetaApi
|
|
1205
|
+
*/
|
|
1206
|
+
getProjectFields(requestParameters?: BetaApiGetProjectFieldsRequest): Promise<GetProjectFields200Response>;
|
|
1207
|
+
/**
|
|
1208
|
+
* Returns the details of a specific project board.
|
|
1209
|
+
* @summary Get details of a project board
|
|
1210
|
+
* @param {BetaApiGetProjectsBoardRequest} requestParameters Request parameters.
|
|
1211
|
+
|
|
1212
|
+
* @throws {RequiredError}
|
|
1213
|
+
* @memberof BetaApi
|
|
1214
|
+
*/
|
|
1215
|
+
getProjectsBoard(requestParameters: BetaApiGetProjectsBoardRequest): Promise<UpsertProjectBoardResponse>;
|
|
1216
|
+
/**
|
|
1217
|
+
* Returns all active project boards.
|
|
1218
|
+
* @summary Get all project boards
|
|
1219
|
+
|
|
1220
|
+
* @throws {RequiredError}
|
|
1221
|
+
* @memberof BetaApi
|
|
1222
|
+
*/
|
|
1223
|
+
getProjectsBoards(): Promise<GetProjectBoardsResponse>;
|
|
1224
|
+
/**
|
|
1225
|
+
* Returns the details of a specific project phase.
|
|
1226
|
+
* @summary Get details of a project phase
|
|
1227
|
+
* @param {BetaApiGetProjectsPhaseRequest} requestParameters Request parameters.
|
|
1228
|
+
|
|
1229
|
+
* @throws {RequiredError}
|
|
1230
|
+
* @memberof BetaApi
|
|
1231
|
+
*/
|
|
1232
|
+
getProjectsPhase(requestParameters: BetaApiGetProjectsPhaseRequest): Promise<UpsertProjectPhaseResponse>;
|
|
1233
|
+
/**
|
|
1234
|
+
* Returns all active project phases under a specific board.
|
|
1235
|
+
* @summary Get project phases
|
|
1236
|
+
* @param {BetaApiGetProjectsPhasesRequest} requestParameters Request parameters.
|
|
1237
|
+
|
|
1238
|
+
* @throws {RequiredError}
|
|
1239
|
+
* @memberof BetaApi
|
|
1240
|
+
*/
|
|
1241
|
+
getProjectsPhases(requestParameters: BetaApiGetProjectsPhasesRequest): Promise<GetProjectPhasesResponse>;
|
|
1242
|
+
/**
|
|
1243
|
+
* Returns the details of a specific task.
|
|
1244
|
+
* @summary Get details of a task
|
|
1245
|
+
* @param {BetaApiGetTaskRequest} requestParameters Request parameters.
|
|
1246
|
+
|
|
1247
|
+
* @throws {RequiredError}
|
|
1248
|
+
* @memberof BetaApi
|
|
1249
|
+
*/
|
|
1250
|
+
getTask(requestParameters: BetaApiGetTaskRequest): Promise<GetTaskResponse>;
|
|
1251
|
+
/**
|
|
1252
|
+
* Returns all tasks.
|
|
1253
|
+
* @summary Get all tasks
|
|
1254
|
+
* @param {BetaApiGetTasksRequest} requestParameters Request parameters.
|
|
1255
|
+
|
|
1256
|
+
* @throws {RequiredError}
|
|
1257
|
+
* @memberof BetaApi
|
|
1258
|
+
*/
|
|
1259
|
+
getTasks(requestParameters?: BetaApiGetTasksRequest): Promise<GetTasksResponse>;
|
|
1260
|
+
/**
|
|
1261
|
+
* Searches all projects by title, description, 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 projects can be filtered by person ID or organization ID.
|
|
1262
|
+
* @summary Search projects
|
|
1263
|
+
* @param {BetaApiSearchProjectsRequest} requestParameters Request parameters.
|
|
1264
|
+
|
|
1265
|
+
* @throws {RequiredError}
|
|
1266
|
+
* @memberof BetaApi
|
|
1267
|
+
*/
|
|
1268
|
+
searchProjects(requestParameters: BetaApiSearchProjectsRequest): Promise<GetProjectSearchResponse>;
|
|
1269
|
+
/**
|
|
1270
|
+
* Updates the properties of a project board.
|
|
1271
|
+
* @summary Update a project board
|
|
1272
|
+
* @param {BetaApiUpdateProjectBoardRequest} requestParameters Request parameters.
|
|
1273
|
+
|
|
1274
|
+
* @throws {RequiredError}
|
|
1275
|
+
* @memberof BetaApi
|
|
1276
|
+
*/
|
|
1277
|
+
updateProjectBoard(requestParameters: BetaApiUpdateProjectBoardRequest): Promise<UpsertProjectBoardResponse>;
|
|
1278
|
+
/**
|
|
1279
|
+
* Updates a project custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
|
|
1280
|
+
* @summary Update one project field
|
|
1281
|
+
* @param {BetaApiUpdateProjectFieldRequest} requestParameters Request parameters.
|
|
1282
|
+
|
|
1283
|
+
* @throws {RequiredError}
|
|
1284
|
+
* @memberof BetaApi
|
|
1285
|
+
*/
|
|
1286
|
+
updateProjectField(requestParameters: BetaApiUpdateProjectFieldRequest): Promise<AddProjectField200Response>;
|
|
1287
|
+
/**
|
|
1288
|
+
* Updates existing options for a project custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
|
|
1289
|
+
* @summary Update project field options in bulk
|
|
1290
|
+
* @param {BetaApiUpdateProjectFieldOptionsRequest} requestParameters Request parameters.
|
|
1291
|
+
|
|
1292
|
+
* @throws {RequiredError}
|
|
1293
|
+
* @memberof BetaApi
|
|
1294
|
+
*/
|
|
1295
|
+
updateProjectFieldOptions(requestParameters: BetaApiUpdateProjectFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
|
|
1296
|
+
/**
|
|
1297
|
+
* Updates the properties of a project phase.
|
|
1298
|
+
* @summary Update a project phase
|
|
1299
|
+
* @param {BetaApiUpdateProjectPhaseRequest} requestParameters Request parameters.
|
|
1300
|
+
|
|
1301
|
+
* @throws {RequiredError}
|
|
1302
|
+
* @memberof BetaApi
|
|
1303
|
+
*/
|
|
1304
|
+
updateProjectPhase(requestParameters: BetaApiUpdateProjectPhaseRequest): Promise<UpsertProjectPhaseResponse>;
|
|
1305
|
+
/**
|
|
1306
|
+
* Updates a task.
|
|
1307
|
+
* @summary Update a task
|
|
1308
|
+
* @param {BetaApiUpdateTaskRequest} requestParameters Request parameters.
|
|
1309
|
+
|
|
1310
|
+
* @throws {RequiredError}
|
|
1311
|
+
* @memberof BetaApi
|
|
1312
|
+
*/
|
|
1313
|
+
updateTask(requestParameters: BetaApiUpdateTaskRequest): Promise<UpdateTaskResponse>;
|
|
1314
|
+
}
|