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
|
@@ -68,10 +68,12 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
68
68
|
* @param {number} id The ID of the organization
|
|
69
69
|
* @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include
|
|
70
70
|
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
71
|
+
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
72
|
+
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
71
73
|
|
|
72
74
|
* @throws {RequiredError}
|
|
73
75
|
*/
|
|
74
|
-
getOrganization: (id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email', custom_fields?: string) => Promise<RequestArgs>;
|
|
76
|
+
getOrganization: (id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email', custom_fields?: string, include_option_labels?: boolean, include_labels?: boolean) => Promise<RequestArgs>;
|
|
75
77
|
/**
|
|
76
78
|
* Lists users who are following the organization.
|
|
77
79
|
* @summary List followers of an organization
|
|
@@ -104,12 +106,14 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
104
106
|
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
105
107
|
* @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include
|
|
106
108
|
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
109
|
+
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
110
|
+
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
107
111
|
* @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.
|
|
108
112
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
109
113
|
|
|
110
114
|
* @throws {RequiredError}
|
|
111
115
|
*/
|
|
112
|
-
getOrganizations: (filter_id?: number, ids?: string, owner_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email', custom_fields?: string, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
116
|
+
getOrganizations: (filter_id?: number, ids?: string, owner_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email', custom_fields?: string, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
113
117
|
/**
|
|
114
118
|
* Searches all organizations by name, address, 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.
|
|
115
119
|
* @summary Search organizations
|
|
@@ -177,10 +181,12 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
|
177
181
|
* @param {number} id The ID of the organization
|
|
178
182
|
* @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include
|
|
179
183
|
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
184
|
+
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
185
|
+
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
180
186
|
|
|
181
187
|
* @throws {RequiredError}
|
|
182
188
|
*/
|
|
183
|
-
getOrganization(id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email', custom_fields?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertOrganizationResponse>>;
|
|
189
|
+
getOrganization(id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email', custom_fields?: string, include_option_labels?: boolean, include_labels?: boolean): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertOrganizationResponse>>;
|
|
184
190
|
/**
|
|
185
191
|
* Lists users who are following the organization.
|
|
186
192
|
* @summary List followers of an organization
|
|
@@ -213,12 +219,14 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
|
213
219
|
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
214
220
|
* @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include
|
|
215
221
|
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
222
|
+
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
223
|
+
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
216
224
|
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
|
217
225
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
218
226
|
|
|
219
227
|
* @throws {RequiredError}
|
|
220
228
|
*/
|
|
221
|
-
getOrganizations(filter_id?: number, ids?: string, owner_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email', custom_fields?: string, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetOrganizationsResponse>>;
|
|
229
|
+
getOrganizations(filter_id?: number, ids?: string, owner_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email', custom_fields?: string, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetOrganizationsResponse>>;
|
|
222
230
|
/**
|
|
223
231
|
* Searches all organizations by name, address, 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.
|
|
224
232
|
* @summary Search organizations
|
|
@@ -415,6 +423,18 @@ export interface OrganizationsApiGetOrganizationRequest {
|
|
|
415
423
|
* @memberof OrganizationsApiGetOrganization
|
|
416
424
|
*/
|
|
417
425
|
readonly custom_fields?: string;
|
|
426
|
+
/**
|
|
427
|
+
* When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
428
|
+
* @type {boolean}
|
|
429
|
+
* @memberof OrganizationsApiGetOrganization
|
|
430
|
+
*/
|
|
431
|
+
readonly include_option_labels?: boolean;
|
|
432
|
+
/**
|
|
433
|
+
* When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
434
|
+
* @type {boolean}
|
|
435
|
+
* @memberof OrganizationsApiGetOrganization
|
|
436
|
+
*/
|
|
437
|
+
readonly include_labels?: boolean;
|
|
418
438
|
}
|
|
419
439
|
/**
|
|
420
440
|
* Request parameters for getOrganizationFollowers operation in OrganizationsApi.
|
|
@@ -526,6 +546,18 @@ export interface OrganizationsApiGetOrganizationsRequest {
|
|
|
526
546
|
* @memberof OrganizationsApiGetOrganizations
|
|
527
547
|
*/
|
|
528
548
|
readonly custom_fields?: string;
|
|
549
|
+
/**
|
|
550
|
+
* When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
551
|
+
* @type {boolean}
|
|
552
|
+
* @memberof OrganizationsApiGetOrganizations
|
|
553
|
+
*/
|
|
554
|
+
readonly include_option_labels?: boolean;
|
|
555
|
+
/**
|
|
556
|
+
* When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
557
|
+
* @type {boolean}
|
|
558
|
+
* @memberof OrganizationsApiGetOrganizations
|
|
559
|
+
*/
|
|
560
|
+
readonly include_labels?: boolean;
|
|
529
561
|
/**
|
|
530
562
|
* 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.
|
|
531
563
|
* @type {number}
|
|
@@ -180,10 +180,12 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
180
180
|
* @param {number} id The ID of the organization
|
|
181
181
|
* @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include
|
|
182
182
|
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
183
|
+
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
184
|
+
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
183
185
|
|
|
184
186
|
* @throws {RequiredError}
|
|
185
187
|
*/
|
|
186
|
-
getOrganization: (id, include_fields, custom_fields) => __awaiter(this, void 0, void 0, function* () {
|
|
188
|
+
getOrganization: (id, include_fields, custom_fields, include_option_labels, include_labels) => __awaiter(this, void 0, void 0, function* () {
|
|
187
189
|
// verify required parameter 'id' is not null or undefined
|
|
188
190
|
assertParamExists('getOrganization', 'id', id);
|
|
189
191
|
const localVarPath = `/organizations/{id}`
|
|
@@ -208,6 +210,12 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
208
210
|
if (custom_fields !== undefined) {
|
|
209
211
|
localVarQueryParameter['custom_fields'] = custom_fields;
|
|
210
212
|
}
|
|
213
|
+
if (include_option_labels !== undefined) {
|
|
214
|
+
localVarQueryParameter['include_option_labels'] = include_option_labels;
|
|
215
|
+
}
|
|
216
|
+
if (include_labels !== undefined) {
|
|
217
|
+
localVarQueryParameter['include_labels'] = include_labels;
|
|
218
|
+
}
|
|
211
219
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
212
220
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
213
221
|
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
@@ -312,12 +320,14 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
312
320
|
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
313
321
|
* @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include
|
|
314
322
|
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
323
|
+
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
324
|
+
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
315
325
|
* @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.
|
|
316
326
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
317
327
|
|
|
318
328
|
* @throws {RequiredError}
|
|
319
329
|
*/
|
|
320
|
-
getOrganizations: (filter_id, ids, owner_id, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
|
|
330
|
+
getOrganizations: (filter_id, ids, owner_id, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, include_option_labels, include_labels, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
|
|
321
331
|
const localVarPath = `/organizations`;
|
|
322
332
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
323
333
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -360,6 +370,12 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
360
370
|
if (custom_fields !== undefined) {
|
|
361
371
|
localVarQueryParameter['custom_fields'] = custom_fields;
|
|
362
372
|
}
|
|
373
|
+
if (include_option_labels !== undefined) {
|
|
374
|
+
localVarQueryParameter['include_option_labels'] = include_option_labels;
|
|
375
|
+
}
|
|
376
|
+
if (include_labels !== undefined) {
|
|
377
|
+
localVarQueryParameter['include_labels'] = include_labels;
|
|
378
|
+
}
|
|
363
379
|
if (limit !== undefined) {
|
|
364
380
|
localVarQueryParameter['limit'] = limit;
|
|
365
381
|
}
|
|
@@ -532,12 +548,14 @@ export const OrganizationsApiFp = function (configuration) {
|
|
|
532
548
|
* @param {number} id The ID of the organization
|
|
533
549
|
* @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include
|
|
534
550
|
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
551
|
+
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
552
|
+
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
535
553
|
|
|
536
554
|
* @throws {RequiredError}
|
|
537
555
|
*/
|
|
538
|
-
getOrganization(id, include_fields, custom_fields) {
|
|
556
|
+
getOrganization(id, include_fields, custom_fields, include_option_labels, include_labels) {
|
|
539
557
|
return __awaiter(this, void 0, void 0, function* () {
|
|
540
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrganization(id, include_fields, custom_fields);
|
|
558
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrganization(id, include_fields, custom_fields, include_option_labels, include_labels);
|
|
541
559
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
542
560
|
});
|
|
543
561
|
},
|
|
@@ -583,14 +601,16 @@ export const OrganizationsApiFp = function (configuration) {
|
|
|
583
601
|
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
584
602
|
* @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include
|
|
585
603
|
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
604
|
+
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
605
|
+
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
586
606
|
* @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.
|
|
587
607
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
588
608
|
|
|
589
609
|
* @throws {RequiredError}
|
|
590
610
|
*/
|
|
591
|
-
getOrganizations(filter_id, ids, owner_id, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, limit, cursor) {
|
|
611
|
+
getOrganizations(filter_id, ids, owner_id, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, include_option_labels, include_labels, limit, cursor) {
|
|
592
612
|
return __awaiter(this, void 0, void 0, function* () {
|
|
593
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrganizations(filter_id, ids, owner_id, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, limit, cursor);
|
|
613
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrganizations(filter_id, ids, owner_id, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, include_option_labels, include_labels, limit, cursor);
|
|
594
614
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
595
615
|
});
|
|
596
616
|
},
|
|
@@ -682,7 +702,7 @@ export const OrganizationsApiFactory = function (configuration, basePath, axios)
|
|
|
682
702
|
* @throws {RequiredError}
|
|
683
703
|
*/
|
|
684
704
|
getOrganization(requestParameters) {
|
|
685
|
-
return localVarFp.getOrganization(requestParameters.id, requestParameters.include_fields, requestParameters.custom_fields).then((request) => request(axios, basePath));
|
|
705
|
+
return localVarFp.getOrganization(requestParameters.id, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.include_option_labels, requestParameters.include_labels).then((request) => request(axios, basePath));
|
|
686
706
|
},
|
|
687
707
|
/**
|
|
688
708
|
* Lists users who are following the organization.
|
|
@@ -712,7 +732,7 @@ export const OrganizationsApiFactory = function (configuration, basePath, axios)
|
|
|
712
732
|
* @throws {RequiredError}
|
|
713
733
|
*/
|
|
714
734
|
getOrganizations(requestParameters = {}) {
|
|
715
|
-
return localVarFp.getOrganizations(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
|
735
|
+
return localVarFp.getOrganizations(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.include_option_labels, requestParameters.include_labels, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
|
716
736
|
},
|
|
717
737
|
/**
|
|
718
738
|
* Searches all organizations by name, address, 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.
|
|
@@ -796,7 +816,7 @@ export class OrganizationsApi extends BaseAPI {
|
|
|
796
816
|
* @memberof OrganizationsApi
|
|
797
817
|
*/
|
|
798
818
|
getOrganization(requestParameters) {
|
|
799
|
-
return OrganizationsApiFp(this.configuration).getOrganization(requestParameters.id, requestParameters.include_fields, requestParameters.custom_fields).then((request) => request(this.axios, this.basePath));
|
|
819
|
+
return OrganizationsApiFp(this.configuration).getOrganization(requestParameters.id, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.include_option_labels, requestParameters.include_labels).then((request) => request(this.axios, this.basePath));
|
|
800
820
|
}
|
|
801
821
|
/**
|
|
802
822
|
* Lists users who are following the organization.
|
|
@@ -829,7 +849,7 @@ export class OrganizationsApi extends BaseAPI {
|
|
|
829
849
|
* @memberof OrganizationsApi
|
|
830
850
|
*/
|
|
831
851
|
getOrganizations(requestParameters = {}) {
|
|
832
|
-
return OrganizationsApiFp(this.configuration).getOrganizations(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
|
852
|
+
return OrganizationsApiFp(this.configuration).getOrganizations(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.include_option_labels, requestParameters.include_labels, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
|
833
853
|
}
|
|
834
854
|
/**
|
|
835
855
|
* Searches all organizations by name, address, 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.
|
|
@@ -68,10 +68,12 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
68
68
|
* @param {number} id The ID of the person
|
|
69
69
|
* @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled.
|
|
70
70
|
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
71
|
+
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
72
|
+
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
71
73
|
|
|
72
74
|
* @throws {RequiredError}
|
|
73
75
|
*/
|
|
74
|
-
getPerson: (id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status' | 'smart_bcc_email', custom_fields?: string) => Promise<RequestArgs>;
|
|
76
|
+
getPerson: (id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status' | 'smart_bcc_email', custom_fields?: string, include_option_labels?: boolean, include_labels?: boolean) => Promise<RequestArgs>;
|
|
75
77
|
/**
|
|
76
78
|
* Lists users who are following the person.
|
|
77
79
|
* @summary List followers of a person
|
|
@@ -114,12 +116,14 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
114
116
|
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
115
117
|
* @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled.
|
|
116
118
|
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
119
|
+
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
120
|
+
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
117
121
|
* @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.
|
|
118
122
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
119
123
|
|
|
120
124
|
* @throws {RequiredError}
|
|
121
125
|
*/
|
|
122
|
-
getPersons: (filter_id?: number, ids?: string, owner_id?: number, org_id?: number, deal_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status' | 'smart_bcc_email', custom_fields?: string, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
126
|
+
getPersons: (filter_id?: number, ids?: string, owner_id?: number, org_id?: number, deal_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status' | 'smart_bcc_email', custom_fields?: string, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
123
127
|
/**
|
|
124
128
|
* Searches all persons by name, email, phone, 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 persons can be filtered by organization ID.
|
|
125
129
|
* @summary Search persons
|
|
@@ -189,10 +193,12 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
189
193
|
* @param {number} id The ID of the person
|
|
190
194
|
* @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled.
|
|
191
195
|
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
196
|
+
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
197
|
+
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
192
198
|
|
|
193
199
|
* @throws {RequiredError}
|
|
194
200
|
*/
|
|
195
|
-
getPerson(id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status' | 'smart_bcc_email', custom_fields?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertPersonResponse>>;
|
|
201
|
+
getPerson(id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status' | 'smart_bcc_email', custom_fields?: string, include_option_labels?: boolean, include_labels?: boolean): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertPersonResponse>>;
|
|
196
202
|
/**
|
|
197
203
|
* Lists users who are following the person.
|
|
198
204
|
* @summary List followers of a person
|
|
@@ -235,12 +241,14 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
235
241
|
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
236
242
|
* @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled.
|
|
237
243
|
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
244
|
+
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
245
|
+
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
238
246
|
* @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.
|
|
239
247
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
240
248
|
|
|
241
249
|
* @throws {RequiredError}
|
|
242
250
|
*/
|
|
243
|
-
getPersons(filter_id?: number, ids?: string, owner_id?: number, org_id?: number, deal_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status' | 'smart_bcc_email', custom_fields?: string, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonsResponse>>;
|
|
251
|
+
getPersons(filter_id?: number, ids?: string, owner_id?: number, org_id?: number, deal_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status' | 'smart_bcc_email', custom_fields?: string, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonsResponse>>;
|
|
244
252
|
/**
|
|
245
253
|
* Searches all persons by name, email, phone, 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 persons can be filtered by organization ID.
|
|
246
254
|
* @summary Search persons
|
|
@@ -447,6 +455,18 @@ export interface PersonsApiGetPersonRequest {
|
|
|
447
455
|
* @memberof PersonsApiGetPerson
|
|
448
456
|
*/
|
|
449
457
|
readonly custom_fields?: string;
|
|
458
|
+
/**
|
|
459
|
+
* When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
460
|
+
* @type {boolean}
|
|
461
|
+
* @memberof PersonsApiGetPerson
|
|
462
|
+
*/
|
|
463
|
+
readonly include_option_labels?: boolean;
|
|
464
|
+
/**
|
|
465
|
+
* When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
466
|
+
* @type {boolean}
|
|
467
|
+
* @memberof PersonsApiGetPerson
|
|
468
|
+
*/
|
|
469
|
+
readonly include_labels?: boolean;
|
|
450
470
|
}
|
|
451
471
|
/**
|
|
452
472
|
* Request parameters for getPersonFollowers operation in PersonsApi.
|
|
@@ -583,6 +603,18 @@ export interface PersonsApiGetPersonsRequest {
|
|
|
583
603
|
* @memberof PersonsApiGetPersons
|
|
584
604
|
*/
|
|
585
605
|
readonly custom_fields?: string;
|
|
606
|
+
/**
|
|
607
|
+
* When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
608
|
+
* @type {boolean}
|
|
609
|
+
* @memberof PersonsApiGetPersons
|
|
610
|
+
*/
|
|
611
|
+
readonly include_option_labels?: boolean;
|
|
612
|
+
/**
|
|
613
|
+
* When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
614
|
+
* @type {boolean}
|
|
615
|
+
* @memberof PersonsApiGetPersons
|
|
616
|
+
*/
|
|
617
|
+
readonly include_labels?: boolean;
|
|
586
618
|
/**
|
|
587
619
|
* 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.
|
|
588
620
|
* @type {number}
|
|
@@ -180,10 +180,12 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
180
180
|
* @param {number} id The ID of the person
|
|
181
181
|
* @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled.
|
|
182
182
|
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
183
|
+
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
184
|
+
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
183
185
|
|
|
184
186
|
* @throws {RequiredError}
|
|
185
187
|
*/
|
|
186
|
-
getPerson: (id, include_fields, custom_fields) => __awaiter(this, void 0, void 0, function* () {
|
|
188
|
+
getPerson: (id, include_fields, custom_fields, include_option_labels, include_labels) => __awaiter(this, void 0, void 0, function* () {
|
|
187
189
|
// verify required parameter 'id' is not null or undefined
|
|
188
190
|
assertParamExists('getPerson', 'id', id);
|
|
189
191
|
const localVarPath = `/persons/{id}`
|
|
@@ -208,6 +210,12 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
208
210
|
if (custom_fields !== undefined) {
|
|
209
211
|
localVarQueryParameter['custom_fields'] = custom_fields;
|
|
210
212
|
}
|
|
213
|
+
if (include_option_labels !== undefined) {
|
|
214
|
+
localVarQueryParameter['include_option_labels'] = include_option_labels;
|
|
215
|
+
}
|
|
216
|
+
if (include_labels !== undefined) {
|
|
217
|
+
localVarQueryParameter['include_labels'] = include_labels;
|
|
218
|
+
}
|
|
211
219
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
212
220
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
213
221
|
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
@@ -348,12 +356,14 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
348
356
|
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
349
357
|
* @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled.
|
|
350
358
|
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
359
|
+
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
360
|
+
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
351
361
|
* @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.
|
|
352
362
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
353
363
|
|
|
354
364
|
* @throws {RequiredError}
|
|
355
365
|
*/
|
|
356
|
-
getPersons: (filter_id, ids, owner_id, org_id, deal_id, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
|
|
366
|
+
getPersons: (filter_id, ids, owner_id, org_id, deal_id, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, include_option_labels, include_labels, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
|
|
357
367
|
const localVarPath = `/persons`;
|
|
358
368
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
359
369
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -402,6 +412,12 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
402
412
|
if (custom_fields !== undefined) {
|
|
403
413
|
localVarQueryParameter['custom_fields'] = custom_fields;
|
|
404
414
|
}
|
|
415
|
+
if (include_option_labels !== undefined) {
|
|
416
|
+
localVarQueryParameter['include_option_labels'] = include_option_labels;
|
|
417
|
+
}
|
|
418
|
+
if (include_labels !== undefined) {
|
|
419
|
+
localVarQueryParameter['include_labels'] = include_labels;
|
|
420
|
+
}
|
|
405
421
|
if (limit !== undefined) {
|
|
406
422
|
localVarQueryParameter['limit'] = limit;
|
|
407
423
|
}
|
|
@@ -582,12 +598,14 @@ export const PersonsApiFp = function (configuration) {
|
|
|
582
598
|
* @param {number} id The ID of the person
|
|
583
599
|
* @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled.
|
|
584
600
|
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
601
|
+
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
602
|
+
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
585
603
|
|
|
586
604
|
* @throws {RequiredError}
|
|
587
605
|
*/
|
|
588
|
-
getPerson(id, include_fields, custom_fields) {
|
|
606
|
+
getPerson(id, include_fields, custom_fields, include_option_labels, include_labels) {
|
|
589
607
|
return __awaiter(this, void 0, void 0, function* () {
|
|
590
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPerson(id, include_fields, custom_fields);
|
|
608
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPerson(id, include_fields, custom_fields, include_option_labels, include_labels);
|
|
591
609
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
592
610
|
});
|
|
593
611
|
},
|
|
@@ -648,14 +666,16 @@ export const PersonsApiFp = function (configuration) {
|
|
|
648
666
|
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
649
667
|
* @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled.
|
|
650
668
|
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
669
|
+
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
670
|
+
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
651
671
|
* @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.
|
|
652
672
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
653
673
|
|
|
654
674
|
* @throws {RequiredError}
|
|
655
675
|
*/
|
|
656
|
-
getPersons(filter_id, ids, owner_id, org_id, deal_id, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, limit, cursor) {
|
|
676
|
+
getPersons(filter_id, ids, owner_id, org_id, deal_id, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, include_option_labels, include_labels, limit, cursor) {
|
|
657
677
|
return __awaiter(this, void 0, void 0, function* () {
|
|
658
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPersons(filter_id, ids, owner_id, org_id, deal_id, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, limit, cursor);
|
|
678
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPersons(filter_id, ids, owner_id, org_id, deal_id, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, include_option_labels, include_labels, limit, cursor);
|
|
659
679
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
660
680
|
});
|
|
661
681
|
},
|
|
@@ -749,7 +769,7 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
749
769
|
* @throws {RequiredError}
|
|
750
770
|
*/
|
|
751
771
|
getPerson(requestParameters) {
|
|
752
|
-
return localVarFp.getPerson(requestParameters.id, requestParameters.include_fields, requestParameters.custom_fields).then((request) => request(axios, basePath));
|
|
772
|
+
return localVarFp.getPerson(requestParameters.id, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.include_option_labels, requestParameters.include_labels).then((request) => request(axios, basePath));
|
|
753
773
|
},
|
|
754
774
|
/**
|
|
755
775
|
* Lists users who are following the person.
|
|
@@ -789,7 +809,7 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
789
809
|
* @throws {RequiredError}
|
|
790
810
|
*/
|
|
791
811
|
getPersons(requestParameters = {}) {
|
|
792
|
-
return localVarFp.getPersons(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.org_id, requestParameters.deal_id, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
|
812
|
+
return localVarFp.getPersons(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.org_id, requestParameters.deal_id, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.include_option_labels, requestParameters.include_labels, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
|
793
813
|
},
|
|
794
814
|
/**
|
|
795
815
|
* Searches all persons by name, email, phone, 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 persons can be filtered by organization ID.
|
|
@@ -873,7 +893,7 @@ export class PersonsApi extends BaseAPI {
|
|
|
873
893
|
* @memberof PersonsApi
|
|
874
894
|
*/
|
|
875
895
|
getPerson(requestParameters) {
|
|
876
|
-
return PersonsApiFp(this.configuration).getPerson(requestParameters.id, requestParameters.include_fields, requestParameters.custom_fields).then((request) => request(this.axios, this.basePath));
|
|
896
|
+
return PersonsApiFp(this.configuration).getPerson(requestParameters.id, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.include_option_labels, requestParameters.include_labels).then((request) => request(this.axios, this.basePath));
|
|
877
897
|
}
|
|
878
898
|
/**
|
|
879
899
|
* Lists users who are following the person.
|
|
@@ -917,7 +937,7 @@ export class PersonsApi extends BaseAPI {
|
|
|
917
937
|
* @memberof PersonsApi
|
|
918
938
|
*/
|
|
919
939
|
getPersons(requestParameters = {}) {
|
|
920
|
-
return PersonsApiFp(this.configuration).getPersons(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.org_id, requestParameters.deal_id, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
|
940
|
+
return PersonsApiFp(this.configuration).getPersons(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.org_id, requestParameters.deal_id, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.include_option_labels, requestParameters.include_labels, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
|
921
941
|
}
|
|
922
942
|
/**
|
|
923
943
|
* Searches all persons by name, email, phone, 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 persons can be filtered by organization ID.
|