pipedrive 30.5.0 → 30.7.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/lead-fields-api.d.ts +95 -0
- package/dist/esm/versions/v1/api/lead-fields-api.js +135 -0
- package/dist/esm/versions/v1/api.d.ts +1 -0
- package/dist/esm/versions/v1/api.js +1 -0
- package/dist/esm/versions/v2/api/activity-fields-api.d.ts +158 -0
- package/dist/esm/versions/v2/api/activity-fields-api.js +213 -0
- package/dist/esm/versions/v2/api/deal-fields-api.d.ts +473 -0
- package/dist/esm/versions/v2/api/deal-fields-api.js +646 -0
- package/dist/esm/versions/v2/api/organization-fields-api.d.ts +473 -0
- package/dist/esm/versions/v2/api/organization-fields-api.js +646 -0
- package/dist/esm/versions/v2/api/person-fields-api.d.ts +473 -0
- package/dist/esm/versions/v2/api/person-fields-api.js +646 -0
- package/dist/esm/versions/v2/api/product-fields-api.d.ts +473 -0
- package/dist/esm/versions/v2/api/product-fields-api.js +646 -0
- package/dist/esm/versions/v2/api.d.ts +5 -0
- package/dist/esm/versions/v2/api.js +5 -0
- package/dist/esm/versions/v2/models/add-deal-field-options-request-inner.d.ts +23 -0
- package/dist/esm/versions/v2/models/add-deal-field-options-request-inner.js +14 -0
- package/dist/esm/versions/v2/models/add-deal-field-options200-response-data-inner.d.ts +28 -0
- package/dist/esm/versions/v2/models/add-deal-field-options200-response-data-inner.js +14 -0
- package/dist/esm/versions/v2/models/add-deal-field-options200-response.d.ts +34 -0
- package/dist/esm/versions/v2/models/add-deal-field-options200-response.js +14 -0
- package/dist/esm/versions/v2/models/add-deal-field-request-important-fields.d.ts +29 -0
- package/dist/esm/versions/v2/models/add-deal-field-request-important-fields.js +14 -0
- package/dist/esm/versions/v2/models/add-deal-field-request-options-inner.d.ts +23 -0
- package/dist/esm/versions/v2/models/add-deal-field-request-options-inner.js +14 -0
- package/dist/esm/versions/v2/models/add-deal-field-request-required-fields.d.ts +41 -0
- package/dist/esm/versions/v2/models/add-deal-field-request-required-fields.js +17 -0
- package/dist/esm/versions/v2/models/add-deal-field-request-ui-visibility-show-in-pipelines.d.ts +28 -0
- package/dist/esm/versions/v2/models/add-deal-field-request-ui-visibility-show-in-pipelines.js +14 -0
- package/dist/esm/versions/v2/models/add-deal-field-request-ui-visibility.d.ts +40 -0
- package/dist/esm/versions/v2/models/add-deal-field-request-ui-visibility.js +14 -0
- package/dist/esm/versions/v2/models/add-deal-field-request.d.ts +76 -0
- package/dist/esm/versions/v2/models/add-deal-field-request.js +31 -0
- package/dist/esm/versions/v2/models/add-deal-field200-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/add-deal-field200-response.js +14 -0
- package/dist/esm/versions/v2/models/add-organization-field-request-important-fields.d.ts +29 -0
- package/dist/esm/versions/v2/models/add-organization-field-request-important-fields.js +14 -0
- package/dist/esm/versions/v2/models/add-organization-field-request-required-fields.d.ts +24 -0
- package/dist/esm/versions/v2/models/add-organization-field-request-required-fields.js +14 -0
- package/dist/esm/versions/v2/models/add-organization-field-request-ui-visibility-show-in-add-deal-dialog.d.ts +28 -0
- package/dist/esm/versions/v2/models/add-organization-field-request-ui-visibility-show-in-add-deal-dialog.js +14 -0
- package/dist/esm/versions/v2/models/add-organization-field-request-ui-visibility-show-in-add-person-dialog.d.ts +28 -0
- package/dist/esm/versions/v2/models/add-organization-field-request-ui-visibility-show-in-add-person-dialog.js +14 -0
- package/dist/esm/versions/v2/models/add-organization-field-request-ui-visibility.d.ts +41 -0
- package/dist/esm/versions/v2/models/add-organization-field-request-ui-visibility.js +14 -0
- package/dist/esm/versions/v2/models/add-organization-field-request.d.ts +76 -0
- package/dist/esm/versions/v2/models/add-organization-field-request.js +31 -0
- package/dist/esm/versions/v2/models/add-organization-field200-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/add-organization-field200-response.js +14 -0
- package/dist/esm/versions/v2/models/add-person-field-request-important-fields.d.ts +29 -0
- package/dist/esm/versions/v2/models/add-person-field-request-important-fields.js +14 -0
- package/dist/esm/versions/v2/models/add-person-field-request-required-fields.d.ts +24 -0
- package/dist/esm/versions/v2/models/add-person-field-request-required-fields.js +14 -0
- package/dist/esm/versions/v2/models/add-person-field-request-ui-visibility-show-in-add-deal-dialog.d.ts +28 -0
- package/dist/esm/versions/v2/models/add-person-field-request-ui-visibility-show-in-add-deal-dialog.js +14 -0
- package/dist/esm/versions/v2/models/add-person-field-request-ui-visibility.d.ts +35 -0
- package/dist/esm/versions/v2/models/add-person-field-request-ui-visibility.js +14 -0
- package/dist/esm/versions/v2/models/add-person-field-request.d.ts +76 -0
- package/dist/esm/versions/v2/models/add-person-field-request.js +31 -0
- package/dist/esm/versions/v2/models/add-person-field200-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/add-person-field200-response.js +14 -0
- package/dist/esm/versions/v2/models/add-product-field-request-ui-visibility.d.ts +29 -0
- package/dist/esm/versions/v2/models/add-product-field-request-ui-visibility.js +14 -0
- package/dist/esm/versions/v2/models/add-product-field-request.d.ts +64 -0
- package/dist/esm/versions/v2/models/add-product-field-request.js +31 -0
- package/dist/esm/versions/v2/models/delete-deal-field-options-request-inner.d.ts +23 -0
- package/dist/esm/versions/v2/models/delete-deal-field-options-request-inner.js +14 -0
- package/dist/esm/versions/v2/models/delete-deal-field200-response-data.d.ts +58 -0
- package/dist/esm/versions/v2/models/delete-deal-field200-response-data.js +14 -0
- package/dist/esm/versions/v2/models/delete-deal-field200-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/delete-deal-field200-response.js +14 -0
- package/dist/esm/versions/v2/models/delete-person-field200-response-data.d.ts +53 -0
- package/dist/esm/versions/v2/models/delete-person-field200-response-data.js +14 -0
- package/dist/esm/versions/v2/models/delete-person-field200-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/delete-person-field200-response.js +14 -0
- package/dist/esm/versions/v2/models/get-activity-field200-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/get-activity-field200-response.js +14 -0
- package/dist/esm/versions/v2/models/get-activity-fields200-response-additional-data.d.ts +23 -0
- package/dist/esm/versions/v2/models/get-activity-fields200-response-additional-data.js +14 -0
- package/dist/esm/versions/v2/models/get-activity-fields200-response-data-inner-options-inner.d.ts +43 -0
- package/dist/esm/versions/v2/models/get-activity-fields200-response-data-inner-options-inner.js +14 -0
- package/dist/esm/versions/v2/models/get-activity-fields200-response-data-inner-subfields-inner.d.ts +33 -0
- package/dist/esm/versions/v2/models/get-activity-fields200-response-data-inner-subfields-inner.js +14 -0
- package/dist/esm/versions/v2/models/get-activity-fields200-response-data-inner-ui-visibility.d.ts +28 -0
- package/dist/esm/versions/v2/models/get-activity-fields200-response-data-inner-ui-visibility.js +14 -0
- package/dist/esm/versions/v2/models/get-activity-fields200-response-data-inner.d.ts +97 -0
- package/dist/esm/versions/v2/models/get-activity-fields200-response-data-inner.js +48 -0
- package/dist/esm/versions/v2/models/get-activity-fields200-response.d.ts +35 -0
- package/dist/esm/versions/v2/models/get-activity-fields200-response.js +14 -0
- package/dist/esm/versions/v2/models/get-deal-fields200-response-data-inner-important-fields.d.ts +28 -0
- package/dist/esm/versions/v2/models/get-deal-fields200-response-data-inner-important-fields.js +14 -0
- package/dist/esm/versions/v2/models/get-deal-fields200-response-data-inner-required-fields.d.ts +40 -0
- package/dist/esm/versions/v2/models/get-deal-fields200-response-data-inner-required-fields.js +17 -0
- package/dist/esm/versions/v2/models/get-deal-fields200-response-data-inner-ui-visibility-show-in-pipelines.d.ts +28 -0
- package/dist/esm/versions/v2/models/get-deal-fields200-response-data-inner-ui-visibility-show-in-pipelines.js +14 -0
- package/dist/esm/versions/v2/models/get-deal-fields200-response-data-inner-ui-visibility.d.ts +39 -0
- package/dist/esm/versions/v2/models/get-deal-fields200-response-data-inner-ui-visibility.js +14 -0
- package/dist/esm/versions/v2/models/get-deal-fields200-response-data-inner.d.ts +114 -0
- package/dist/esm/versions/v2/models/get-deal-fields200-response-data-inner.js +48 -0
- package/dist/esm/versions/v2/models/get-deal-fields200-response.d.ts +35 -0
- package/dist/esm/versions/v2/models/get-deal-fields200-response.js +14 -0
- package/dist/esm/versions/v2/models/get-organization-fields200-response-data-inner-ui-visibility-show-in-add-person-dialog.d.ts +28 -0
- package/dist/esm/versions/v2/models/get-organization-fields200-response-data-inner-ui-visibility-show-in-add-person-dialog.js +14 -0
- package/dist/esm/versions/v2/models/get-organization-fields200-response-data-inner-ui-visibility.d.ts +40 -0
- package/dist/esm/versions/v2/models/get-organization-fields200-response-data-inner-ui-visibility.js +14 -0
- package/dist/esm/versions/v2/models/get-organization-fields200-response-data-inner.d.ts +109 -0
- package/dist/esm/versions/v2/models/get-organization-fields200-response-data-inner.js +48 -0
- package/dist/esm/versions/v2/models/get-organization-fields200-response.d.ts +35 -0
- package/dist/esm/versions/v2/models/get-organization-fields200-response.js +14 -0
- package/dist/esm/versions/v2/models/get-person-fields200-response-data-inner-important-fields.d.ts +28 -0
- package/dist/esm/versions/v2/models/get-person-fields200-response-data-inner-important-fields.js +14 -0
- package/dist/esm/versions/v2/models/get-person-fields200-response-data-inner-required-fields.d.ts +23 -0
- package/dist/esm/versions/v2/models/get-person-fields200-response-data-inner-required-fields.js +14 -0
- package/dist/esm/versions/v2/models/get-person-fields200-response-data-inner-ui-visibility-show-in-add-deal-dialog.d.ts +28 -0
- package/dist/esm/versions/v2/models/get-person-fields200-response-data-inner-ui-visibility-show-in-add-deal-dialog.js +14 -0
- package/dist/esm/versions/v2/models/get-person-fields200-response-data-inner-ui-visibility.d.ts +34 -0
- package/dist/esm/versions/v2/models/get-person-fields200-response-data-inner-ui-visibility.js +14 -0
- package/dist/esm/versions/v2/models/get-person-fields200-response-data-inner.d.ts +109 -0
- package/dist/esm/versions/v2/models/get-person-fields200-response-data-inner.js +48 -0
- package/dist/esm/versions/v2/models/get-person-fields200-response.d.ts +35 -0
- package/dist/esm/versions/v2/models/get-person-fields200-response.js +14 -0
- package/dist/esm/versions/v2/models/index.d.ts +58 -0
- package/dist/esm/versions/v2/models/index.js +58 -0
- package/dist/esm/versions/v2/models/update-deal-field-options-request-inner.d.ts +28 -0
- package/dist/esm/versions/v2/models/update-deal-field-options-request-inner.js +14 -0
- package/dist/esm/versions/v2/models/update-deal-field-request.d.ts +46 -0
- package/dist/esm/versions/v2/models/update-deal-field-request.js +14 -0
- package/dist/esm/versions/v2/models/update-organization-field-request.d.ts +46 -0
- package/dist/esm/versions/v2/models/update-organization-field-request.js +14 -0
- package/dist/esm/versions/v2/models/update-person-field-request.d.ts +46 -0
- package/dist/esm/versions/v2/models/update-person-field-request.js +14 -0
- package/dist/esm/versions/v2/models/update-product-field-request.d.ts +34 -0
- package/dist/esm/versions/v2/models/update-product-field-request.js +14 -0
- package/dist/versions/v1/api/lead-fields-api.d.ts +95 -0
- package/dist/versions/v1/api/lead-fields-api.js +145 -0
- package/dist/versions/v1/api.d.ts +1 -0
- package/dist/versions/v1/api.js +1 -0
- package/dist/versions/v2/api/activity-fields-api.d.ts +158 -0
- package/dist/versions/v2/api/activity-fields-api.js +223 -0
- package/dist/versions/v2/api/deal-fields-api.d.ts +473 -0
- package/dist/versions/v2/api/deal-fields-api.js +656 -0
- package/dist/versions/v2/api/organization-fields-api.d.ts +473 -0
- package/dist/versions/v2/api/organization-fields-api.js +656 -0
- package/dist/versions/v2/api/person-fields-api.d.ts +473 -0
- package/dist/versions/v2/api/person-fields-api.js +656 -0
- package/dist/versions/v2/api/product-fields-api.d.ts +473 -0
- package/dist/versions/v2/api/product-fields-api.js +656 -0
- package/dist/versions/v2/api.d.ts +5 -0
- package/dist/versions/v2/api.js +5 -0
- package/dist/versions/v2/models/add-deal-field-options-request-inner.d.ts +23 -0
- package/dist/versions/v2/models/add-deal-field-options-request-inner.js +15 -0
- package/dist/versions/v2/models/add-deal-field-options200-response-data-inner.d.ts +28 -0
- package/dist/versions/v2/models/add-deal-field-options200-response-data-inner.js +15 -0
- package/dist/versions/v2/models/add-deal-field-options200-response.d.ts +34 -0
- package/dist/versions/v2/models/add-deal-field-options200-response.js +15 -0
- package/dist/versions/v2/models/add-deal-field-request-important-fields.d.ts +29 -0
- package/dist/versions/v2/models/add-deal-field-request-important-fields.js +15 -0
- package/dist/versions/v2/models/add-deal-field-request-options-inner.d.ts +23 -0
- package/dist/versions/v2/models/add-deal-field-request-options-inner.js +15 -0
- package/dist/versions/v2/models/add-deal-field-request-required-fields.d.ts +41 -0
- package/dist/versions/v2/models/add-deal-field-request-required-fields.js +20 -0
- package/dist/versions/v2/models/add-deal-field-request-ui-visibility-show-in-pipelines.d.ts +28 -0
- package/dist/versions/v2/models/add-deal-field-request-ui-visibility-show-in-pipelines.js +15 -0
- package/dist/versions/v2/models/add-deal-field-request-ui-visibility.d.ts +40 -0
- package/dist/versions/v2/models/add-deal-field-request-ui-visibility.js +15 -0
- package/dist/versions/v2/models/add-deal-field-request.d.ts +76 -0
- package/dist/versions/v2/models/add-deal-field-request.js +34 -0
- package/dist/versions/v2/models/add-deal-field200-response.d.ts +29 -0
- package/dist/versions/v2/models/add-deal-field200-response.js +15 -0
- package/dist/versions/v2/models/add-organization-field-request-important-fields.d.ts +29 -0
- package/dist/versions/v2/models/add-organization-field-request-important-fields.js +15 -0
- package/dist/versions/v2/models/add-organization-field-request-required-fields.d.ts +24 -0
- package/dist/versions/v2/models/add-organization-field-request-required-fields.js +15 -0
- package/dist/versions/v2/models/add-organization-field-request-ui-visibility-show-in-add-deal-dialog.d.ts +28 -0
- package/dist/versions/v2/models/add-organization-field-request-ui-visibility-show-in-add-deal-dialog.js +15 -0
- package/dist/versions/v2/models/add-organization-field-request-ui-visibility-show-in-add-person-dialog.d.ts +28 -0
- package/dist/versions/v2/models/add-organization-field-request-ui-visibility-show-in-add-person-dialog.js +15 -0
- package/dist/versions/v2/models/add-organization-field-request-ui-visibility.d.ts +41 -0
- package/dist/versions/v2/models/add-organization-field-request-ui-visibility.js +15 -0
- package/dist/versions/v2/models/add-organization-field-request.d.ts +76 -0
- package/dist/versions/v2/models/add-organization-field-request.js +34 -0
- package/dist/versions/v2/models/add-organization-field200-response.d.ts +29 -0
- package/dist/versions/v2/models/add-organization-field200-response.js +15 -0
- package/dist/versions/v2/models/add-person-field-request-important-fields.d.ts +29 -0
- package/dist/versions/v2/models/add-person-field-request-important-fields.js +15 -0
- package/dist/versions/v2/models/add-person-field-request-required-fields.d.ts +24 -0
- package/dist/versions/v2/models/add-person-field-request-required-fields.js +15 -0
- package/dist/versions/v2/models/add-person-field-request-ui-visibility-show-in-add-deal-dialog.d.ts +28 -0
- package/dist/versions/v2/models/add-person-field-request-ui-visibility-show-in-add-deal-dialog.js +15 -0
- package/dist/versions/v2/models/add-person-field-request-ui-visibility.d.ts +35 -0
- package/dist/versions/v2/models/add-person-field-request-ui-visibility.js +15 -0
- package/dist/versions/v2/models/add-person-field-request.d.ts +76 -0
- package/dist/versions/v2/models/add-person-field-request.js +34 -0
- package/dist/versions/v2/models/add-person-field200-response.d.ts +29 -0
- package/dist/versions/v2/models/add-person-field200-response.js +15 -0
- package/dist/versions/v2/models/add-product-field-request-ui-visibility.d.ts +29 -0
- package/dist/versions/v2/models/add-product-field-request-ui-visibility.js +15 -0
- package/dist/versions/v2/models/add-product-field-request.d.ts +64 -0
- package/dist/versions/v2/models/add-product-field-request.js +34 -0
- package/dist/versions/v2/models/delete-deal-field-options-request-inner.d.ts +23 -0
- package/dist/versions/v2/models/delete-deal-field-options-request-inner.js +15 -0
- package/dist/versions/v2/models/delete-deal-field200-response-data.d.ts +58 -0
- package/dist/versions/v2/models/delete-deal-field200-response-data.js +15 -0
- package/dist/versions/v2/models/delete-deal-field200-response.d.ts +29 -0
- package/dist/versions/v2/models/delete-deal-field200-response.js +15 -0
- package/dist/versions/v2/models/delete-person-field200-response-data.d.ts +53 -0
- package/dist/versions/v2/models/delete-person-field200-response-data.js +15 -0
- package/dist/versions/v2/models/delete-person-field200-response.d.ts +29 -0
- package/dist/versions/v2/models/delete-person-field200-response.js +15 -0
- package/dist/versions/v2/models/get-activity-field200-response.d.ts +29 -0
- package/dist/versions/v2/models/get-activity-field200-response.js +15 -0
- package/dist/versions/v2/models/get-activity-fields200-response-additional-data.d.ts +23 -0
- package/dist/versions/v2/models/get-activity-fields200-response-additional-data.js +15 -0
- package/dist/versions/v2/models/get-activity-fields200-response-data-inner-options-inner.d.ts +43 -0
- package/dist/versions/v2/models/get-activity-fields200-response-data-inner-options-inner.js +15 -0
- package/dist/versions/v2/models/get-activity-fields200-response-data-inner-subfields-inner.d.ts +33 -0
- package/dist/versions/v2/models/get-activity-fields200-response-data-inner-subfields-inner.js +15 -0
- package/dist/versions/v2/models/get-activity-fields200-response-data-inner-ui-visibility.d.ts +28 -0
- package/dist/versions/v2/models/get-activity-fields200-response-data-inner-ui-visibility.js +15 -0
- package/dist/versions/v2/models/get-activity-fields200-response-data-inner.d.ts +97 -0
- package/dist/versions/v2/models/get-activity-fields200-response-data-inner.js +51 -0
- package/dist/versions/v2/models/get-activity-fields200-response.d.ts +35 -0
- package/dist/versions/v2/models/get-activity-fields200-response.js +15 -0
- package/dist/versions/v2/models/get-deal-fields200-response-data-inner-important-fields.d.ts +28 -0
- package/dist/versions/v2/models/get-deal-fields200-response-data-inner-important-fields.js +15 -0
- package/dist/versions/v2/models/get-deal-fields200-response-data-inner-required-fields.d.ts +40 -0
- package/dist/versions/v2/models/get-deal-fields200-response-data-inner-required-fields.js +20 -0
- package/dist/versions/v2/models/get-deal-fields200-response-data-inner-ui-visibility-show-in-pipelines.d.ts +28 -0
- package/dist/versions/v2/models/get-deal-fields200-response-data-inner-ui-visibility-show-in-pipelines.js +15 -0
- package/dist/versions/v2/models/get-deal-fields200-response-data-inner-ui-visibility.d.ts +39 -0
- package/dist/versions/v2/models/get-deal-fields200-response-data-inner-ui-visibility.js +15 -0
- package/dist/versions/v2/models/get-deal-fields200-response-data-inner.d.ts +114 -0
- package/dist/versions/v2/models/get-deal-fields200-response-data-inner.js +51 -0
- package/dist/versions/v2/models/get-deal-fields200-response.d.ts +35 -0
- package/dist/versions/v2/models/get-deal-fields200-response.js +15 -0
- package/dist/versions/v2/models/get-organization-fields200-response-data-inner-ui-visibility-show-in-add-person-dialog.d.ts +28 -0
- package/dist/versions/v2/models/get-organization-fields200-response-data-inner-ui-visibility-show-in-add-person-dialog.js +15 -0
- package/dist/versions/v2/models/get-organization-fields200-response-data-inner-ui-visibility.d.ts +40 -0
- package/dist/versions/v2/models/get-organization-fields200-response-data-inner-ui-visibility.js +15 -0
- package/dist/versions/v2/models/get-organization-fields200-response-data-inner.d.ts +109 -0
- package/dist/versions/v2/models/get-organization-fields200-response-data-inner.js +51 -0
- package/dist/versions/v2/models/get-organization-fields200-response.d.ts +35 -0
- package/dist/versions/v2/models/get-organization-fields200-response.js +15 -0
- package/dist/versions/v2/models/get-person-fields200-response-data-inner-important-fields.d.ts +28 -0
- package/dist/versions/v2/models/get-person-fields200-response-data-inner-important-fields.js +15 -0
- package/dist/versions/v2/models/get-person-fields200-response-data-inner-required-fields.d.ts +23 -0
- package/dist/versions/v2/models/get-person-fields200-response-data-inner-required-fields.js +15 -0
- package/dist/versions/v2/models/get-person-fields200-response-data-inner-ui-visibility-show-in-add-deal-dialog.d.ts +28 -0
- package/dist/versions/v2/models/get-person-fields200-response-data-inner-ui-visibility-show-in-add-deal-dialog.js +15 -0
- package/dist/versions/v2/models/get-person-fields200-response-data-inner-ui-visibility.d.ts +34 -0
- package/dist/versions/v2/models/get-person-fields200-response-data-inner-ui-visibility.js +15 -0
- package/dist/versions/v2/models/get-person-fields200-response-data-inner.d.ts +109 -0
- package/dist/versions/v2/models/get-person-fields200-response-data-inner.js +51 -0
- package/dist/versions/v2/models/get-person-fields200-response.d.ts +35 -0
- package/dist/versions/v2/models/get-person-fields200-response.js +15 -0
- package/dist/versions/v2/models/index.d.ts +58 -0
- package/dist/versions/v2/models/index.js +58 -0
- package/dist/versions/v2/models/update-deal-field-options-request-inner.d.ts +28 -0
- package/dist/versions/v2/models/update-deal-field-options-request-inner.js +15 -0
- package/dist/versions/v2/models/update-deal-field-request.d.ts +46 -0
- package/dist/versions/v2/models/update-deal-field-request.js +15 -0
- package/dist/versions/v2/models/update-organization-field-request.d.ts +46 -0
- package/dist/versions/v2/models/update-organization-field-request.js +15 -0
- package/dist/versions/v2/models/update-person-field-request.d.ts +46 -0
- package/dist/versions/v2/models/update-person-field-request.js +15 -0
- package/dist/versions/v2/models/update-product-field-request.d.ts +34 -0
- package/dist/versions/v2/models/update-product-field-request.js +15 -0
- package/package.json +1 -1
|
@@ -0,0 +1,473 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Pipedrive API v2
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from '../configuration';
|
|
13
|
+
import type { AxiosInstance } from 'axios';
|
|
14
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { AddDealFieldOptions200Response } from '../models';
|
|
16
|
+
import { AddDealFieldOptionsRequestInner } from '../models';
|
|
17
|
+
import { AddOrganizationField200Response } from '../models';
|
|
18
|
+
import { AddOrganizationFieldRequest } from '../models';
|
|
19
|
+
import { DeleteDealFieldOptionsRequestInner } from '../models';
|
|
20
|
+
import { DeletePersonField200Response } from '../models';
|
|
21
|
+
import { GetOrganizationFields200Response } from '../models';
|
|
22
|
+
import { UpdateDealFieldOptionsRequestInner } from '../models';
|
|
23
|
+
import { UpdateOrganizationFieldRequest } from '../models';
|
|
24
|
+
/**
|
|
25
|
+
* OrganizationFieldsApi - axios parameter creator
|
|
26
|
+
* @export
|
|
27
|
+
*/
|
|
28
|
+
export declare const OrganizationFieldsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
29
|
+
/**
|
|
30
|
+
* Creates a new organization custom field.
|
|
31
|
+
* @summary Create one organization field
|
|
32
|
+
* @param {AddOrganizationFieldRequest} AddOrganizationFieldRequest
|
|
33
|
+
|
|
34
|
+
* @throws {RequiredError}
|
|
35
|
+
*/
|
|
36
|
+
addOrganizationField: (AddOrganizationFieldRequest: AddOrganizationFieldRequest) => Promise<RequestArgs>;
|
|
37
|
+
/**
|
|
38
|
+
* Adds new options to an organization custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
|
|
39
|
+
* @summary Add organization field options in bulk
|
|
40
|
+
* @param {string} field_code The unique code identifying the field
|
|
41
|
+
* @param {Array<AddDealFieldOptionsRequestInner>} AddDealFieldOptionsRequestInner
|
|
42
|
+
|
|
43
|
+
* @throws {RequiredError}
|
|
44
|
+
*/
|
|
45
|
+
addOrganizationFieldOptions: (field_code: string, AddDealFieldOptionsRequestInner: AddDealFieldOptionsRequestInner[]) => Promise<RequestArgs>;
|
|
46
|
+
/**
|
|
47
|
+
* Marks a custom field as deleted.
|
|
48
|
+
* @summary Delete one organization field
|
|
49
|
+
* @param {string} field_code The unique code identifying the field
|
|
50
|
+
|
|
51
|
+
* @throws {RequiredError}
|
|
52
|
+
*/
|
|
53
|
+
deleteOrganizationField: (field_code: string) => Promise<RequestArgs>;
|
|
54
|
+
/**
|
|
55
|
+
* Removes existing options from an organization custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
|
|
56
|
+
* @summary Delete organization field options in bulk
|
|
57
|
+
* @param {string} field_code The unique code identifying the field
|
|
58
|
+
* @param {Array<DeleteDealFieldOptionsRequestInner>} DeleteDealFieldOptionsRequestInner
|
|
59
|
+
|
|
60
|
+
* @throws {RequiredError}
|
|
61
|
+
*/
|
|
62
|
+
deleteOrganizationFieldOptions: (field_code: string, DeleteDealFieldOptionsRequestInner: DeleteDealFieldOptionsRequestInner[]) => Promise<RequestArgs>;
|
|
63
|
+
/**
|
|
64
|
+
* Returns metadata about a specific organization field.
|
|
65
|
+
* @summary Get one organization field
|
|
66
|
+
* @param {string} field_code The unique code identifying the field
|
|
67
|
+
* @param {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
68
|
+
|
|
69
|
+
* @throws {RequiredError}
|
|
70
|
+
*/
|
|
71
|
+
getOrganizationField: (field_code: string, include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields') => Promise<RequestArgs>;
|
|
72
|
+
/**
|
|
73
|
+
* Returns metadata about all organization fields in the company.
|
|
74
|
+
* @summary Get all organization fields
|
|
75
|
+
* @param {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
76
|
+
* @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.
|
|
77
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
78
|
+
|
|
79
|
+
* @throws {RequiredError}
|
|
80
|
+
*/
|
|
81
|
+
getOrganizationFields: (include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields', limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
82
|
+
/**
|
|
83
|
+
* Updates an organization custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
|
|
84
|
+
* @summary Update one organization field
|
|
85
|
+
* @param {string} field_code The unique code identifying the field
|
|
86
|
+
* @param {UpdateOrganizationFieldRequest} UpdateOrganizationFieldRequest
|
|
87
|
+
|
|
88
|
+
* @throws {RequiredError}
|
|
89
|
+
*/
|
|
90
|
+
updateOrganizationField: (field_code: string, UpdateOrganizationFieldRequest: UpdateOrganizationFieldRequest) => Promise<RequestArgs>;
|
|
91
|
+
/**
|
|
92
|
+
* Updates existing options for an organization custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
|
|
93
|
+
* @summary Update organization field options in bulk
|
|
94
|
+
* @param {string} field_code The unique code identifying the field
|
|
95
|
+
* @param {Array<UpdateDealFieldOptionsRequestInner>} UpdateDealFieldOptionsRequestInner
|
|
96
|
+
|
|
97
|
+
* @throws {RequiredError}
|
|
98
|
+
*/
|
|
99
|
+
updateOrganizationFieldOptions: (field_code: string, UpdateDealFieldOptionsRequestInner: UpdateDealFieldOptionsRequestInner[]) => Promise<RequestArgs>;
|
|
100
|
+
};
|
|
101
|
+
/**
|
|
102
|
+
* OrganizationFieldsApi - functional programming interface
|
|
103
|
+
* @export
|
|
104
|
+
*/
|
|
105
|
+
export declare const OrganizationFieldsApiFp: (configuration?: Configuration) => {
|
|
106
|
+
/**
|
|
107
|
+
* Creates a new organization custom field.
|
|
108
|
+
* @summary Create one organization field
|
|
109
|
+
* @param {AddOrganizationFieldRequest} AddOrganizationFieldRequest
|
|
110
|
+
|
|
111
|
+
* @throws {RequiredError}
|
|
112
|
+
*/
|
|
113
|
+
addOrganizationField(AddOrganizationFieldRequest: AddOrganizationFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddOrganizationField200Response>>;
|
|
114
|
+
/**
|
|
115
|
+
* Adds new options to an organization custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
|
|
116
|
+
* @summary Add organization field options in bulk
|
|
117
|
+
* @param {string} field_code The unique code identifying the field
|
|
118
|
+
* @param {Array<AddDealFieldOptionsRequestInner>} AddDealFieldOptionsRequestInner
|
|
119
|
+
|
|
120
|
+
* @throws {RequiredError}
|
|
121
|
+
*/
|
|
122
|
+
addOrganizationFieldOptions(field_code: string, AddDealFieldOptionsRequestInner: AddDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
|
|
123
|
+
/**
|
|
124
|
+
* Marks a custom field as deleted.
|
|
125
|
+
* @summary Delete one organization field
|
|
126
|
+
* @param {string} field_code The unique code identifying the field
|
|
127
|
+
|
|
128
|
+
* @throws {RequiredError}
|
|
129
|
+
*/
|
|
130
|
+
deleteOrganizationField(field_code: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeletePersonField200Response>>;
|
|
131
|
+
/**
|
|
132
|
+
* Removes existing options from an organization custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
|
|
133
|
+
* @summary Delete organization field options in bulk
|
|
134
|
+
* @param {string} field_code The unique code identifying the field
|
|
135
|
+
* @param {Array<DeleteDealFieldOptionsRequestInner>} DeleteDealFieldOptionsRequestInner
|
|
136
|
+
|
|
137
|
+
* @throws {RequiredError}
|
|
138
|
+
*/
|
|
139
|
+
deleteOrganizationFieldOptions(field_code: string, DeleteDealFieldOptionsRequestInner: DeleteDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
|
|
140
|
+
/**
|
|
141
|
+
* Returns metadata about a specific organization field.
|
|
142
|
+
* @summary Get one organization field
|
|
143
|
+
* @param {string} field_code The unique code identifying the field
|
|
144
|
+
* @param {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
145
|
+
|
|
146
|
+
* @throws {RequiredError}
|
|
147
|
+
*/
|
|
148
|
+
getOrganizationField(field_code: string, include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddOrganizationField200Response>>;
|
|
149
|
+
/**
|
|
150
|
+
* Returns metadata about all organization fields in the company.
|
|
151
|
+
* @summary Get all organization fields
|
|
152
|
+
* @param {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
153
|
+
* @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.
|
|
154
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
155
|
+
|
|
156
|
+
* @throws {RequiredError}
|
|
157
|
+
*/
|
|
158
|
+
getOrganizationFields(include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetOrganizationFields200Response>>;
|
|
159
|
+
/**
|
|
160
|
+
* Updates an organization custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
|
|
161
|
+
* @summary Update one organization field
|
|
162
|
+
* @param {string} field_code The unique code identifying the field
|
|
163
|
+
* @param {UpdateOrganizationFieldRequest} UpdateOrganizationFieldRequest
|
|
164
|
+
|
|
165
|
+
* @throws {RequiredError}
|
|
166
|
+
*/
|
|
167
|
+
updateOrganizationField(field_code: string, UpdateOrganizationFieldRequest: UpdateOrganizationFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddOrganizationField200Response>>;
|
|
168
|
+
/**
|
|
169
|
+
* Updates existing options for an organization custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
|
|
170
|
+
* @summary Update organization field options in bulk
|
|
171
|
+
* @param {string} field_code The unique code identifying the field
|
|
172
|
+
* @param {Array<UpdateDealFieldOptionsRequestInner>} UpdateDealFieldOptionsRequestInner
|
|
173
|
+
|
|
174
|
+
* @throws {RequiredError}
|
|
175
|
+
*/
|
|
176
|
+
updateOrganizationFieldOptions(field_code: string, UpdateDealFieldOptionsRequestInner: UpdateDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
|
|
177
|
+
};
|
|
178
|
+
/**
|
|
179
|
+
* OrganizationFieldsApi - factory interface
|
|
180
|
+
* @export
|
|
181
|
+
*/
|
|
182
|
+
export declare const OrganizationFieldsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
183
|
+
/**
|
|
184
|
+
* Creates a new organization custom field.
|
|
185
|
+
* @summary Create one organization field
|
|
186
|
+
* @param {OrganizationFieldsApiAddOrganizationFieldRequest} requestParameters Request parameters.
|
|
187
|
+
|
|
188
|
+
* @throws {RequiredError}
|
|
189
|
+
*/
|
|
190
|
+
addOrganizationField(requestParameters: OrganizationFieldsApiAddOrganizationFieldRequest): Promise<AddOrganizationField200Response>;
|
|
191
|
+
/**
|
|
192
|
+
* Adds new options to an organization custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
|
|
193
|
+
* @summary Add organization field options in bulk
|
|
194
|
+
* @param {OrganizationFieldsApiAddOrganizationFieldOptionsRequest} requestParameters Request parameters.
|
|
195
|
+
|
|
196
|
+
* @throws {RequiredError}
|
|
197
|
+
*/
|
|
198
|
+
addOrganizationFieldOptions(requestParameters: OrganizationFieldsApiAddOrganizationFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
|
|
199
|
+
/**
|
|
200
|
+
* Marks a custom field as deleted.
|
|
201
|
+
* @summary Delete one organization field
|
|
202
|
+
* @param {OrganizationFieldsApiDeleteOrganizationFieldRequest} requestParameters Request parameters.
|
|
203
|
+
|
|
204
|
+
* @throws {RequiredError}
|
|
205
|
+
*/
|
|
206
|
+
deleteOrganizationField(requestParameters: OrganizationFieldsApiDeleteOrganizationFieldRequest): Promise<DeletePersonField200Response>;
|
|
207
|
+
/**
|
|
208
|
+
* Removes existing options from an organization custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
|
|
209
|
+
* @summary Delete organization field options in bulk
|
|
210
|
+
* @param {OrganizationFieldsApiDeleteOrganizationFieldOptionsRequest} requestParameters Request parameters.
|
|
211
|
+
|
|
212
|
+
* @throws {RequiredError}
|
|
213
|
+
*/
|
|
214
|
+
deleteOrganizationFieldOptions(requestParameters: OrganizationFieldsApiDeleteOrganizationFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
|
|
215
|
+
/**
|
|
216
|
+
* Returns metadata about a specific organization field.
|
|
217
|
+
* @summary Get one organization field
|
|
218
|
+
* @param {OrganizationFieldsApiGetOrganizationFieldRequest} requestParameters Request parameters.
|
|
219
|
+
|
|
220
|
+
* @throws {RequiredError}
|
|
221
|
+
*/
|
|
222
|
+
getOrganizationField(requestParameters: OrganizationFieldsApiGetOrganizationFieldRequest): Promise<AddOrganizationField200Response>;
|
|
223
|
+
/**
|
|
224
|
+
* Returns metadata about all organization fields in the company.
|
|
225
|
+
* @summary Get all organization fields
|
|
226
|
+
* @param {OrganizationFieldsApiGetOrganizationFieldsRequest} requestParameters Request parameters.
|
|
227
|
+
|
|
228
|
+
* @throws {RequiredError}
|
|
229
|
+
*/
|
|
230
|
+
getOrganizationFields(requestParameters?: OrganizationFieldsApiGetOrganizationFieldsRequest): Promise<GetOrganizationFields200Response>;
|
|
231
|
+
/**
|
|
232
|
+
* Updates an organization custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
|
|
233
|
+
* @summary Update one organization field
|
|
234
|
+
* @param {OrganizationFieldsApiUpdateOrganizationFieldRequest} requestParameters Request parameters.
|
|
235
|
+
|
|
236
|
+
* @throws {RequiredError}
|
|
237
|
+
*/
|
|
238
|
+
updateOrganizationField(requestParameters: OrganizationFieldsApiUpdateOrganizationFieldRequest): Promise<AddOrganizationField200Response>;
|
|
239
|
+
/**
|
|
240
|
+
* Updates existing options for an organization custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
|
|
241
|
+
* @summary Update organization field options in bulk
|
|
242
|
+
* @param {OrganizationFieldsApiUpdateOrganizationFieldOptionsRequest} requestParameters Request parameters.
|
|
243
|
+
|
|
244
|
+
* @throws {RequiredError}
|
|
245
|
+
*/
|
|
246
|
+
updateOrganizationFieldOptions(requestParameters: OrganizationFieldsApiUpdateOrganizationFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
|
|
247
|
+
};
|
|
248
|
+
/**
|
|
249
|
+
* Request parameters for addOrganizationField operation in OrganizationFieldsApi.
|
|
250
|
+
* @export
|
|
251
|
+
* @interface OrganizationFieldsApiAddOrganizationFieldRequest
|
|
252
|
+
*/
|
|
253
|
+
export interface OrganizationFieldsApiAddOrganizationFieldRequest {
|
|
254
|
+
/**
|
|
255
|
+
*
|
|
256
|
+
* @type {AddOrganizationFieldRequest}
|
|
257
|
+
* @memberof OrganizationFieldsApiAddOrganizationField
|
|
258
|
+
*/
|
|
259
|
+
readonly AddOrganizationFieldRequest: AddOrganizationFieldRequest;
|
|
260
|
+
}
|
|
261
|
+
/**
|
|
262
|
+
* Request parameters for addOrganizationFieldOptions operation in OrganizationFieldsApi.
|
|
263
|
+
* @export
|
|
264
|
+
* @interface OrganizationFieldsApiAddOrganizationFieldOptionsRequest
|
|
265
|
+
*/
|
|
266
|
+
export interface OrganizationFieldsApiAddOrganizationFieldOptionsRequest {
|
|
267
|
+
/**
|
|
268
|
+
* The unique code identifying the field
|
|
269
|
+
* @type {string}
|
|
270
|
+
* @memberof OrganizationFieldsApiAddOrganizationFieldOptions
|
|
271
|
+
*/
|
|
272
|
+
readonly field_code: string;
|
|
273
|
+
/**
|
|
274
|
+
*
|
|
275
|
+
* @type {Array<AddDealFieldOptionsRequestInner>}
|
|
276
|
+
* @memberof OrganizationFieldsApiAddOrganizationFieldOptions
|
|
277
|
+
*/
|
|
278
|
+
readonly AddDealFieldOptionsRequestInner: Array<AddDealFieldOptionsRequestInner>;
|
|
279
|
+
}
|
|
280
|
+
/**
|
|
281
|
+
* Request parameters for deleteOrganizationField operation in OrganizationFieldsApi.
|
|
282
|
+
* @export
|
|
283
|
+
* @interface OrganizationFieldsApiDeleteOrganizationFieldRequest
|
|
284
|
+
*/
|
|
285
|
+
export interface OrganizationFieldsApiDeleteOrganizationFieldRequest {
|
|
286
|
+
/**
|
|
287
|
+
* The unique code identifying the field
|
|
288
|
+
* @type {string}
|
|
289
|
+
* @memberof OrganizationFieldsApiDeleteOrganizationField
|
|
290
|
+
*/
|
|
291
|
+
readonly field_code: string;
|
|
292
|
+
}
|
|
293
|
+
/**
|
|
294
|
+
* Request parameters for deleteOrganizationFieldOptions operation in OrganizationFieldsApi.
|
|
295
|
+
* @export
|
|
296
|
+
* @interface OrganizationFieldsApiDeleteOrganizationFieldOptionsRequest
|
|
297
|
+
*/
|
|
298
|
+
export interface OrganizationFieldsApiDeleteOrganizationFieldOptionsRequest {
|
|
299
|
+
/**
|
|
300
|
+
* The unique code identifying the field
|
|
301
|
+
* @type {string}
|
|
302
|
+
* @memberof OrganizationFieldsApiDeleteOrganizationFieldOptions
|
|
303
|
+
*/
|
|
304
|
+
readonly field_code: string;
|
|
305
|
+
/**
|
|
306
|
+
*
|
|
307
|
+
* @type {Array<DeleteDealFieldOptionsRequestInner>}
|
|
308
|
+
* @memberof OrganizationFieldsApiDeleteOrganizationFieldOptions
|
|
309
|
+
*/
|
|
310
|
+
readonly DeleteDealFieldOptionsRequestInner: Array<DeleteDealFieldOptionsRequestInner>;
|
|
311
|
+
}
|
|
312
|
+
/**
|
|
313
|
+
* Request parameters for getOrganizationField operation in OrganizationFieldsApi.
|
|
314
|
+
* @export
|
|
315
|
+
* @interface OrganizationFieldsApiGetOrganizationFieldRequest
|
|
316
|
+
*/
|
|
317
|
+
export interface OrganizationFieldsApiGetOrganizationFieldRequest {
|
|
318
|
+
/**
|
|
319
|
+
* The unique code identifying the field
|
|
320
|
+
* @type {string}
|
|
321
|
+
* @memberof OrganizationFieldsApiGetOrganizationField
|
|
322
|
+
*/
|
|
323
|
+
readonly field_code: string;
|
|
324
|
+
/**
|
|
325
|
+
* Optional comma separated string array of additional data namespaces to include in response
|
|
326
|
+
* @type {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'}
|
|
327
|
+
* @memberof OrganizationFieldsApiGetOrganizationField
|
|
328
|
+
*/
|
|
329
|
+
readonly include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields';
|
|
330
|
+
}
|
|
331
|
+
/**
|
|
332
|
+
* Request parameters for getOrganizationFields operation in OrganizationFieldsApi.
|
|
333
|
+
* @export
|
|
334
|
+
* @interface OrganizationFieldsApiGetOrganizationFieldsRequest
|
|
335
|
+
*/
|
|
336
|
+
export interface OrganizationFieldsApiGetOrganizationFieldsRequest {
|
|
337
|
+
/**
|
|
338
|
+
* Optional comma separated string array of additional data namespaces to include in response
|
|
339
|
+
* @type {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'}
|
|
340
|
+
* @memberof OrganizationFieldsApiGetOrganizationFields
|
|
341
|
+
*/
|
|
342
|
+
readonly include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields';
|
|
343
|
+
/**
|
|
344
|
+
* 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.
|
|
345
|
+
* @type {number}
|
|
346
|
+
* @memberof OrganizationFieldsApiGetOrganizationFields
|
|
347
|
+
*/
|
|
348
|
+
readonly limit?: number;
|
|
349
|
+
/**
|
|
350
|
+
* For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
351
|
+
* @type {string}
|
|
352
|
+
* @memberof OrganizationFieldsApiGetOrganizationFields
|
|
353
|
+
*/
|
|
354
|
+
readonly cursor?: string;
|
|
355
|
+
}
|
|
356
|
+
/**
|
|
357
|
+
* Request parameters for updateOrganizationField operation in OrganizationFieldsApi.
|
|
358
|
+
* @export
|
|
359
|
+
* @interface OrganizationFieldsApiUpdateOrganizationFieldRequest
|
|
360
|
+
*/
|
|
361
|
+
export interface OrganizationFieldsApiUpdateOrganizationFieldRequest {
|
|
362
|
+
/**
|
|
363
|
+
* The unique code identifying the field
|
|
364
|
+
* @type {string}
|
|
365
|
+
* @memberof OrganizationFieldsApiUpdateOrganizationField
|
|
366
|
+
*/
|
|
367
|
+
readonly field_code: string;
|
|
368
|
+
/**
|
|
369
|
+
*
|
|
370
|
+
* @type {UpdateOrganizationFieldRequest}
|
|
371
|
+
* @memberof OrganizationFieldsApiUpdateOrganizationField
|
|
372
|
+
*/
|
|
373
|
+
readonly UpdateOrganizationFieldRequest: UpdateOrganizationFieldRequest;
|
|
374
|
+
}
|
|
375
|
+
/**
|
|
376
|
+
* Request parameters for updateOrganizationFieldOptions operation in OrganizationFieldsApi.
|
|
377
|
+
* @export
|
|
378
|
+
* @interface OrganizationFieldsApiUpdateOrganizationFieldOptionsRequest
|
|
379
|
+
*/
|
|
380
|
+
export interface OrganizationFieldsApiUpdateOrganizationFieldOptionsRequest {
|
|
381
|
+
/**
|
|
382
|
+
* The unique code identifying the field
|
|
383
|
+
* @type {string}
|
|
384
|
+
* @memberof OrganizationFieldsApiUpdateOrganizationFieldOptions
|
|
385
|
+
*/
|
|
386
|
+
readonly field_code: string;
|
|
387
|
+
/**
|
|
388
|
+
*
|
|
389
|
+
* @type {Array<UpdateDealFieldOptionsRequestInner>}
|
|
390
|
+
* @memberof OrganizationFieldsApiUpdateOrganizationFieldOptions
|
|
391
|
+
*/
|
|
392
|
+
readonly UpdateDealFieldOptionsRequestInner: Array<UpdateDealFieldOptionsRequestInner>;
|
|
393
|
+
}
|
|
394
|
+
/**
|
|
395
|
+
* OrganizationFieldsApi - object-oriented interface
|
|
396
|
+
* @export
|
|
397
|
+
* @class OrganizationFieldsApi
|
|
398
|
+
* @extends {BaseAPI}
|
|
399
|
+
*/
|
|
400
|
+
export declare class OrganizationFieldsApi extends BaseAPI {
|
|
401
|
+
/**
|
|
402
|
+
* Creates a new organization custom field.
|
|
403
|
+
* @summary Create one organization field
|
|
404
|
+
* @param {OrganizationFieldsApiAddOrganizationFieldRequest} requestParameters Request parameters.
|
|
405
|
+
|
|
406
|
+
* @throws {RequiredError}
|
|
407
|
+
* @memberof OrganizationFieldsApi
|
|
408
|
+
*/
|
|
409
|
+
addOrganizationField(requestParameters: OrganizationFieldsApiAddOrganizationFieldRequest): Promise<AddOrganizationField200Response>;
|
|
410
|
+
/**
|
|
411
|
+
* Adds new options to an organization custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
|
|
412
|
+
* @summary Add organization field options in bulk
|
|
413
|
+
* @param {OrganizationFieldsApiAddOrganizationFieldOptionsRequest} requestParameters Request parameters.
|
|
414
|
+
|
|
415
|
+
* @throws {RequiredError}
|
|
416
|
+
* @memberof OrganizationFieldsApi
|
|
417
|
+
*/
|
|
418
|
+
addOrganizationFieldOptions(requestParameters: OrganizationFieldsApiAddOrganizationFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
|
|
419
|
+
/**
|
|
420
|
+
* Marks a custom field as deleted.
|
|
421
|
+
* @summary Delete one organization field
|
|
422
|
+
* @param {OrganizationFieldsApiDeleteOrganizationFieldRequest} requestParameters Request parameters.
|
|
423
|
+
|
|
424
|
+
* @throws {RequiredError}
|
|
425
|
+
* @memberof OrganizationFieldsApi
|
|
426
|
+
*/
|
|
427
|
+
deleteOrganizationField(requestParameters: OrganizationFieldsApiDeleteOrganizationFieldRequest): Promise<DeletePersonField200Response>;
|
|
428
|
+
/**
|
|
429
|
+
* Removes existing options from an organization custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
|
|
430
|
+
* @summary Delete organization field options in bulk
|
|
431
|
+
* @param {OrganizationFieldsApiDeleteOrganizationFieldOptionsRequest} requestParameters Request parameters.
|
|
432
|
+
|
|
433
|
+
* @throws {RequiredError}
|
|
434
|
+
* @memberof OrganizationFieldsApi
|
|
435
|
+
*/
|
|
436
|
+
deleteOrganizationFieldOptions(requestParameters: OrganizationFieldsApiDeleteOrganizationFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
|
|
437
|
+
/**
|
|
438
|
+
* Returns metadata about a specific organization field.
|
|
439
|
+
* @summary Get one organization field
|
|
440
|
+
* @param {OrganizationFieldsApiGetOrganizationFieldRequest} requestParameters Request parameters.
|
|
441
|
+
|
|
442
|
+
* @throws {RequiredError}
|
|
443
|
+
* @memberof OrganizationFieldsApi
|
|
444
|
+
*/
|
|
445
|
+
getOrganizationField(requestParameters: OrganizationFieldsApiGetOrganizationFieldRequest): Promise<AddOrganizationField200Response>;
|
|
446
|
+
/**
|
|
447
|
+
* Returns metadata about all organization fields in the company.
|
|
448
|
+
* @summary Get all organization fields
|
|
449
|
+
* @param {OrganizationFieldsApiGetOrganizationFieldsRequest} requestParameters Request parameters.
|
|
450
|
+
|
|
451
|
+
* @throws {RequiredError}
|
|
452
|
+
* @memberof OrganizationFieldsApi
|
|
453
|
+
*/
|
|
454
|
+
getOrganizationFields(requestParameters?: OrganizationFieldsApiGetOrganizationFieldsRequest): Promise<GetOrganizationFields200Response>;
|
|
455
|
+
/**
|
|
456
|
+
* Updates an organization custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
|
|
457
|
+
* @summary Update one organization field
|
|
458
|
+
* @param {OrganizationFieldsApiUpdateOrganizationFieldRequest} requestParameters Request parameters.
|
|
459
|
+
|
|
460
|
+
* @throws {RequiredError}
|
|
461
|
+
* @memberof OrganizationFieldsApi
|
|
462
|
+
*/
|
|
463
|
+
updateOrganizationField(requestParameters: OrganizationFieldsApiUpdateOrganizationFieldRequest): Promise<AddOrganizationField200Response>;
|
|
464
|
+
/**
|
|
465
|
+
* Updates existing options for an organization custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
|
|
466
|
+
* @summary Update organization field options in bulk
|
|
467
|
+
* @param {OrganizationFieldsApiUpdateOrganizationFieldOptionsRequest} requestParameters Request parameters.
|
|
468
|
+
|
|
469
|
+
* @throws {RequiredError}
|
|
470
|
+
* @memberof OrganizationFieldsApi
|
|
471
|
+
*/
|
|
472
|
+
updateOrganizationFieldOptions(requestParameters: OrganizationFieldsApiUpdateOrganizationFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
|
|
473
|
+
}
|