diff --git a/CHANGELOG.md b/CHANGELOG.md index f1d3a1e8..30116dd0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,558 @@ The file format of it is based on [Keep a Changelog](http://keepachangelog.com/e For public Changelog covering all changes done to Pipedrive’s API, webhooks and app extensions platforms, see [public Changelog](https://pipedrive.readme.io/docs/changelog) with discussion area in [Developers Community](https://devcommunity.pipedrive.com/c/documentation/changelog/19). ## [Unreleased] +### Changed +- Send token in the `x-api-token` header instead of `api_token` query parameter +## [27.3.0] - 2025-05-05 +## [27.2.0] - 2025-04-23 +### Added +- Added `project_id` and `pinned_to_project_flag` query parameter to the GET `/notes` endpoint +- Added `project_id` and `pinned_to_project_flag` request bodies to the POST/PUT `/notes` endpoint +- Added `project_id` and `pinned_to_project_flag` to success responses of GET/POST/PUT +## [27.1.0] - 2025-04-22 +## [27.0.0] - 2025-04-15 +### Added +- Added archived deals/leads endpoints: + - `GET /v1/deals/archived` + - `GET /v2/deals/archived` + - `GET /v1/deals/timeline/archived` + - `GET /v1/deals/summary/archived` + - `GET /v1/leads/archived` +- Added `is_archived` and `archive_time` properties to deals endpoints response +### Changed +- Updated non archived deals/leads endpoint description to specify that following endpoints do not return archived items: + - `GET /v1/deals` + - `GET /v2/deals` + - `GET /v1/deals/timeline` + - `GET /v1/deals/summary` + - `GET /v1/leads` +- Removed deprecated `archived_status` query parameter from leads endpoints +## [26.3.0] - 2025-04-07 +## [26.2.2] - 2025-04-07 +### Fixed +- Fixed the OAuth scope of "Add a follower to a product" endpoint in API v2 +## [26.2.1] - 2025-03-28 +## [26.2.0] - 2025-03-18 +### Added +- Added v2 versions of the following v1 endpoints: + - `GET /api/v2/deals/:id/followers` + - `GET /api/v2/deals/:id/followers/changelog` + - `POST /api/v2/deals/:id/followers` + - `DELETE /api/v2/deals/:id/followers/:id` + - `GET /api/v2/persons/:id/followers` + - `POST /api/v2/persons/:id/followers` + - `DELETE /api/v2/persons/:id/followers/:id` + - `GET /api/v2/organizations/:id/followers` + - `POST /api/v2/organizations/:id/followers` + - `DELETE /api/v2/organizations/:id/followers/:id` + - `GET /api/v2/products/:id/followers` + - `POST /api/v2/products/:id/followers` + - `DELETE /api/v2/products/:id/followers/:id` + - `GET /api/v2/users/:id/followers` +- Added new v2 endpoints for fetching entity followers changelog: + - `GET /api/v2/deals/:id/followers/changelog` + - `GET /api/v2/persons/:id/followers/changelog` + - `GET /api/v2/organizations/:id/followers/changelog` + - `GET /api/v2/products/:id/followers/changelog` +## [26.1.0] - 2025-03-18 +## [26.0.0] - 2025-03-17 +### Changed +- Updated Webhooks endpoints to v2, including available event_action and event_object properties +## [25.2.0] - 2025-03-12 +## [25.1.5] - 2025-03-11 +- Added deal_id, person_id, org_id and lead_id quick filters for GET /api/v2/activities endpoint. +- Added AdditionalData to the v2 schemas: + - deal + - stage + - pipeline + - activity +## [25.1.4] - 2025-03-05 +## [25.1.3] - 2025-02-19 +### Fixed +- Fixed AdditionalData object schema +## [25.1.2] - 2025-02-07 +## [25.1.1] - 2025-02-04 +### Changed +- Updated list of lead label colors to include 'brown', 'dark-gray', 'orange', 'pink' +## [25.1.0] - 2025-01-31 +## [25.0.0] - 2025-01-27 +### Added +- Introduced a new client-nodejs library with full TypeScript support +- Added compatibility for both API v1 and v2 endpoints. See migration guide for more details +## [24.0.0] - 2025-01-15 +## [23.6.0] - 2024-09-27 +### Added +- Add "additionalProperties" to entities with custom fields +### Changed +- Updated the code examples in the README for the JavaScript SDK +### Added +- Add "custom_fields" query paremeter to GET /api/v2/products +## [23.5.0] - 2024-09-24 +## [23.4.0] - 2024-09-23 +### Added +- Add documentation for installments functionality: + - `POST` `/v1/deals/{id}/products` endpoint + - `PUT` `/v1/deals/{id}/products/{product_attachment_id}` endpoint + - `DELETE` `/v1/deals/{id}/products/{product_attachment_id}` endpoint + - `POST` `/v2/deals/{id}/products` endpoint + - `PATCH` `/v2/deals/{id}/products/{product_attachment_id}` endpoint + - `DELETE` `/v2/deals/{id}/products/{product_attachment_id}` endpoint +## [23.3.8] - 2024-09-10 +## [23.3.7] - 2024-08-27 +### Fixed +- Updated default values for "billing_frequency_cycles", "billing_start_date" fields +## [23.3.6] - 2024-08-21 +## [23.3.5] - 2024-08-05 +### Changed +Renamed `title` property in responses +## [23.3.4] - 2024-08-13 +## [23.3.3] - 2024-08-08 +### Fixed +- Fix "label_ids" field formatting. +## [23.3.1] - 2024-08-01 +## [23.3.0] - 2024-07-22 +### Added +- Notice informing the users of the upcoming Activity Invites feature deprecation: + - `POST` and `PUT` `/v1/activities` endpoints +## [23.2.0] - 2024-07-04 +## [23.1.0] - 2024-07-03 +### Added +- Added `notes` field to Prices in: + - `GET` and `POST` `/v2/products/{productId}/variations` endpoints + - `PATCH` `/api/v2/products/{productId}/variations/{productVariationId}` endpoint +## [23.0.0] - 2024-06-11 +## [22.10.1] - 2024-06-07 +### Removed +- Cleanup unused company settings +## [22.10.0] - 2024-06-06 +## [22.9.1] - 2024-06-05 +### Fixed +- Removed mention about admin API token requirement for setting add_time fields. +## [22.9.0] - 2024-05-29 +## [22.8.1] - 2024-05-29 +### Fixed +- Fixed documentation: property `value` of Lead is nullable. +## [22.8.0] - 2024-05-28 +## [22.7.0] - 2024-05-20 +### Added +- Added `origin`, `origin_id`, `channel` and `channel_id` parameters representing the Source for Lead and Deal entity. +## [22.6.0] - 2024-05-13 +## [22.5.0] - 2024-04-17 +### Added +- Added `is_deleted` parameter for `/v1/users/*` responses. +## [22.4.0] - 2024-04-09 +## [22.3.0] - 2024-02-14 +### Added +- Added documentation for new endpoints `/deals/{id}/changelog`, `/persons/{id}/changelog` and `/organizations/{id}/changelog`. +## [22.2.0] - 2024-01-31 +## [22.1.4] - 2024-01-05 +- Add `won_time`, `lost_time` and `close_time` parameters for the `POST /v1/deals` and `PUT /v1/deals/{id}` endpoints +## [22.1.3] - 2024-01-04 +## [22.1.2] - 2023-12-11 +- Add `lead_id` as an acceptable body parameter for the `POST /v1/callLogs` endpoint +## [22.1.1] - 2023-11-14 +## [22.1.0] - 2023-10-16 +- Add `Projects`, `ProjectTemplates` and `Tasks` public routes. +## [22.0.5] - 2023-10-10 +## [22.0.4] - 2023-10-05 +- Fixed incorrect type of `options` for the `POST and PUT /dealFields, /personFields and /organizationFields` endpoints +## [22.0.3] - 2023-09-13 +## [22.0.2] - 2023-09-12 +### Fixed +- Fixed incorrect response schema for the `GET /deals/{id}/products` endpoint +## [22.0.1] - 2023-09-12 +## [22.0.0] - 2023-08-23 +### Removed +- Removed request and response fields `sum_no_discount` for `GET /deals/{id}/products`, `POST /deals/{id}/products` and `PUT /deals/{id}/products/{product_attachment_id}` +## [21.2.0] - 2023-08-22 +## [21.1.0] - 2023-06-28 +### Added +- Added `GET /organizations/collection` endpoint to fetch all organizations with cursor pagination +- Added `GET /persons/collection` endpoint to fetch all persons with cursor pagination +## [21.0.0] - 2023-06-27 +## [20.5.2] - 2023-06-18 +### Fixed +- Variable name in the "Complete example" paragraph in the README +## [20.5.1] - 2023-06-12 +## [20.5.0] - 2023-06-17 +### Added +- `deprecated_operators` field to `GET /filters/helpers` endpoint response +## [20.4.0] - 2023-06-12 +## [20.3.0] - 2023-06-12 +### Changed +- Schemas for `call-logs` as they only included `base-response` without additional properties in the response schema +## [20.2.1] - 2023-05-31 +## [20.2.0] - 2023-05-31 +### Changed +- Update the paths to DealStrict and DealNonStrict schemas +## [20.1.0] - 2023-05-24 +## [20.0.2] - 2023-05-22 +### Changed +- Updated README.md file: fixed documentation links, added content table +## [20.0.0] - 2023-05-22 +## [5.2.1] - 2023-04-12 +### Changed +- Updated `label` field data type in response examples from number -> string for Deals related endpoints + Changed `active_flag`, `enabled_flag`, and `selectable` body parameters and response examples data type from number -> boolean for all Products related endpoints +## [5.2.0] - 2023-03-20 +## [5.1.0] - 2023-03-16 +### Added +- Added `GET roles/:id/pipelines` endpoint to get pipelines visibility for a role +- Added `PUT roles/:id/pipelines` endpoint to update pipelines visibility for a role +## [5.0.2] - 2023-03-15 +## [5.0.1] - 2023-02-15 +### Added +- Added `GET leads/:id/permittedUsers` endpoint to retrieve the users that have access to a certain lead +## [5.0.0] - 2023-02-13 +## [4.0.11] - 2023-02-09 +### Removed +- Removed `name` body parameter from `POST /v1/users` based on this [post](https://developers.pipedrive.com/changelog/post/removal-of-fields-from-users-api). +## [4.0.10] - 2023-01-31 +## [4.0.9] - 2023-01-31 +### Fixed +- Added missing OAuth scopes for PermissionSets, Roles, and Users API endpoints +## [4.0.8] - 2023-01-24 +## [4.0.7] - 2023-01-12 +### Fixed +- Removed mistakenly documented `required` labels from body parameters `name` and `manager_id` in `PUT /legacyTeams/{id}` +## [4.0.6] - 2023-01-10 +## [4.0.5] - 2023-01-04 +### Fixed +- Fixed mistakenly documented response field for `GET /v1/deals/{id}/followers` from `person_id` to `deal_id`. +### Removed +- Removed `followers_count` from Product-related entities and endpoints based on this [post](https://developers.pipedrive.com/changelog/post/removal-of-codefollowers_countcode-response-field-from-products-endpoints-and-webhook). Changing the following endpoints: + - GET /deals/{id}/products + - GET /products + - GET /products/{id} + - POST /products + - PUT /products/{id} +## [4.0.3] - 2022-12-22 +## [4.0.2] - 2022-12-08 +### Removed +- Removed deprecated endpoints that will be deleted: + - `GET /roles/{id}/roles` +## [4.0.1] - 2022-12-06 +## [4.0.0] - 2022-11-23 +### Security +- Removed `.instance` static property from sdk client to prevent race conditions when using it as a singleton +See the updated examples in the readme to get an overview of the necessary code changes. +## [3.0.33] - 2022-11-18 +## [3.0.32] - 2022-11-18 +### Changed +- Updated `GET /v1/deals/{id}/persons` endpoint description to include information about `marketing_status` +## [3.0.31] - 2022-11-16 +## [3.0.30] - 2022-11-16 +### Changed +- Updated `phone` and `email` body parameter descriptions for `POST v1/persons` and `PUT v1/persons/{id}` +## [3.0.29] - 2022-11-09 +## [3.0.28] - 2022-11-09 +### Changed +- Updated `status` parameter description to explain that deals deleted more than 30 days ago will be deleted permanently +## [3.0.27] - 2022-11-08 +## [3.0.26] - 2022-11-08 +### Changed +- Updated endpoints to include accurate response + - `DELETE /mailThreads/{id}` +## [3.0.25] - 2022-11-07 +## [3.0.24] - 2022-10-25 +### Changed +- Updated endpoint descriptions to warn about permanently removing deleted entities: + - `DELETE /activities` + - `DELETE /activities/{id}` + - `DELETE /deals` + - `DELETE /deals/{id}` + - `DELETE /files/{id}` + - `DELETE /organizations` + - `DELETE /organizations/{id}` + - `DELETE /persons` + - `DELETE /persons/{id}` + - `DELETE /products/{id}` +- Updated `conditions` parameter description for `POST /filters` and `PUT /filters/{id}` +## [3.0.23] - 2022-10-24 +## [3.0.22] - 2022-10-17 +### Changed +- Updated `type.params.pipeline_id` and `type.params.activity_type_id` description, type and response example for goals queries +## [3.0.21] - 2022-10-14 +## [3.0.20] - 2022-10-12 +### Changed +- Changed the content type to `application/json` in the following endpoints: + - `POST /activityTypes` + - `PUT /activityTypes/{id}` +## [3.0.19] - 2022-10-11 +## [3.0.18] - 2022-10-05 +### Changed +- Added deprecated flag to `GET /roles/{id}/roles` +## [3.0.17] - 2022-09-30 +## [3.0.16] - 2022-09-29 +### Changed +- Added and updated the descriptions of roles endpoints +## [3.0.15] - 2022-09-27 +## [3.0.14] - 2022-09-23 +### Changed +- Updated `PUT /users/{:id}`: required parameter `active_flag` has no default value +## [3.0.13] - 2022-09-12 +## [3.0.12] - 2022-09-09 +### Changed +- Description for product requests +## [3.0.11] - 2022-09-02 +## [3.0.10] - 2022-08-30 +### Changed +- Updated `PUT /organizations/{id}`: parameter `name` is not required +- Updated `PUT /notes/{id}`: parameter `content` is not required +## [3.0.9] - 2022-08-26 +## [3.0.8] - 2022-08-15 +### Changed +- Removed `matches_filters` field from the POST `/deals` and PUT `/deals/{id}` endpoints response +## [3.0.7] - 2022-08-09 +## [3.0.6] - 2022-08-08 +### Changed +- Added `access` field to responses from `GET /v1/users`, `GET /v1/users/{id}`, etc. +- Added optional `access` parameter and made `name` optional in `POST /v1/users` +- Added `app`, `type` and `description` fields to responses from `GET /v1/permissionSets` and `GET v1/permissionSets/{id}` +- Added optional `app` parameter to `GET /v1/permissionSets` +- Deprecated `is_admin` and `signup_flow_variation` fields in responses from `GET /v1/users`, `GET /v1/users/{id}`, etc. +## [3.0.5] - 2022-08-03 +## [3.0.4] - 2022-07-27 +### Added +- Added `person_id` and `organization_id` query parameters to GET `/v1/leads` +## [3.0.3] - 2022-07-18 +## [3.0.2] - 2022-07-22 +### Fixed +- Fixed issue with custom monetary field currency +## [3.0.1] - 2022-06-28 +## [3.0.0] - 2022-06-22 +### Changed +- Changed `id` parameter data type to `string` for GET `/permissionSets/{id}` and GET `/permissionSets/{id}/assignments` endpoints +- Changed `id` field data type to `string` for response from GET `/permissionSets` and GET `/permissionSets/{id}` endpoints +- Changed `permission_set_id` field data type to `string` for response GET `/permissionSets/{id}/assignments` endpoints +- Removed `id` field from response for GET `/permissionSets/{id}/assignments` endpoints +## [2.0.4] - 2022-06-21 +## [2.0.3] - 2022-06-20 +### Changed +- Changed `visible_to` parameter data type to `string` for POST `/products` and PUT `/products/{id}` endpoints +## [2.0.2] - 2022-06-07 +## [2.0.1] - 2022-05-31 +### Fixed +- Fixed NumberBooleanDefault0 object's default value from 1 to 0 +## [2.0.0] - 2022-05-23 +## [1.0.1] - 2022-05-10 +### Fixed +- Updated `PUT /persons/{id}`: parameter `name` is not required +## [1.0.0] - 2022-05-09 +## [0.2.75] - 2022-05-04 +### Added +- Add `POST /channels` endpoint +- Add `DELETE /channels/{id}` endpoint +- Add `DELETE /channels/{id}/conversations/{id}` endpoint +- Add `POST /channels/messages/receive` endpoint +## [0.2.74] - 2022-05-03 +## [0.2.73] - 2022-05-04 +### Changed +- Added babel/runtime to dependencies +## [0.2.72] - 2022-04-26 +## [0.2.71] - 2022-04-25 +### Changed +- Changed `visible_to` parameter data type to `string` for POST `/leads` and PATCH `/leads/{id}` endpoints +## [0.2.70] - 2022-04-25 +## [0.2.69] - 2022-04-20 +### Fixed +- Date formatting in responses in the following entities and their respective fields: + - **activities**: `due_date` + - **deals**: `expected_close_date` + - **leads**: `expected_close_date` + - **subscriptions**: `due_at`, `start_date`, `end_date` +Those fields will be formatted as "2020-07-13" instead of "2020-07-13T00:00:00.000Z" in the request response. +## [0.2.68] - 2022-04-14 +## [0.2.67] - 2022-04-08 +### Changed +- Updated `leadSources` description and response object +## [0.2.66] - 2022-03-21 +## [0.2.65] - 2022-03-16 +## Changed +- Added missing oauth scopes to /products/{id}/permittedUsers endpoint +## [0.2.64] - 2022-03-15 +## [0.2.63] - 2022-03-14 +## Changed +- Updated pull request checklist point about review/approval +## [0.2.62] - 2022-03-03 +## [0.2.61] - 2022-02-28 +## Fixed +- fixed data type for `POST /filter` endpoint +## Changed +- release `GET /leads/search` +## [0.2.60] - 2022-02-25 +## [0.2.59] - 2022-02-25 +## Changed +- Updated `POST /products`: parameter `name` is required +- Updated `PUT /deals/:dealId/products`: parameter `quantity` and `item_price` are required +- Updated `POST /deals/:dealId/products`: parameter `quantity` and `item_price` are required +- +## [0.2.58] - 2022-02-22 +## [0.2.57] - 2022-02-18 +## Changed +- Updated `POST /notes`: parameter `content` is required +- Updated `POST /organizations`: parameter `name` is required +- Updated `POST /persons`: parameter `name` is required +- Updated `DELETE /persons`: parameter `ids` is required +- Updated `visible_to` parameter for `POST /deals` and `PUT /deals/{id}` to include type `number` +- Updated `visible_to` parameter for `POST /persons` and `PUT /persons/{id}` to include type `number` +- Updated `visible_to` parameter for `POST /organizations` and `PUT /organizations/{id}` to include type `number` +## [0.2.56] - 2022-02-07 +## [0.2.55] - 2022-02-07 +## Changed +- Upper-casing to format pill type instead of capitalization. +## [0.2.54] - 2022-02-03 +## [0.2.54] - 2022-02-03 +## Added +- Changed numeral typed keys to scalar string type +## [0.2.53] - 2022-02-03 +## [0.2.52] - 2022-02-01 +### Fixed +- Fixed wrong field name normalization for custom fields keys +## [0.2.51] - 2022-01-28 +## [0.2.50] - 2022-01-25 +### Fixed +- Styling fixes: capitalization, tutorial links' texts, code-highlighting in descriptions +## [0.2.49] - 2022-01-24 +## [0.2.48] - 2022-01-20 +### Fixed +- Fixed runtime error for `FilesApi.addFile` +## [0.2.47] - 2022-01-20 +## [0.2.46] - 2022-01-20 +### Fixed +- Fixed runtime error for `FilesApi.addFile` +## [0.2.45] - 2022-01-07 +## [0.2.44] - 2022-01-05 +### Fixed +- Fix `POST /organizationRelationships` 'required' labels not showing +## [0.2.43] - 2022-01-03 +## [0.2.42] - 2021-12-30 +### Fixed +- Fix subscriptions response documentation inconsistency +## [0.2.41] - 2021-12-20 +## [0.2.40] - 2021-12-20 +### Fixed +- Fixed functional tests +## [0.2.39] - 2021-12-15 +## [0.2.38] - 2021-12-13 +### Changed +- Added camelCase support to json endpoints. +## [0.2.37] - 2021-12-13 +## [0.2.36] - 2021-01-07 +### Changed +- Improve Products `price` description +## [0.2.36] - 2021-01-02 +## [0.2.35] - 2021-12-01 +### Fixed +- Fixed `POST /roles/{id}/settings` `value` parameter description +### Added +- Added type to `POST /roles/{id}/settings` `value` parameter +- Added description to `POST /roles/{id}/settings` +## [0.2.34] - 2021-11-30 +## [0.2.33] - 2021-11-26 +### Added +- Added `required` parameters for `POST` endpoints on the client side. +## [0.1.34] - 2021-11-24 +## [0.1.34] - 2021-11-22 +- added missing oauth scopes in some endpoints +## [0.1.33] - 2021-11-24 +## [0.1.32] - 2021-11-22 +### Changed +- Changed/improved `subscription_url` body parameter description +- POST /webhooks +## [0.1.31] - 2021-11-22 +## [0.1.30] - 2021-11-19 +### Fixed +- Fixed items type for `email` and `phone` body parameters +- POST /persons +## [0.1.29] - 2021-11-17 +## [0.1.28] - 2021-11-12 +### Removed +- Removed `int` type from `POST /v1/organizationFields` field_type values +- Removed `int` type from `POST /v1/personFields` field_type values +- Removed `int` type from `POST /v1/dealFields` field_type values +## [0.1.27] - 2021-10-21 +## [0.1.26] - 2021-10-18 +### Removed +- Removed deprecated endpoints that were deleted: +- GET /deals/find +- GET /persons/find +- GET /organizations/find +- GET /products/find +- GET /searchResults +- GET /searchResults/field +## [0.1.25] - 2021-10-07 +## [0.1.24] - 2021-10-06 +### Fixed +- Fixed the UNKNOWN_BASE_TYPE error related to updateStage +## [0.1.23] - 2021-10-04 +## [0.1.21] - 2021-10-04 +### Added +- Adding pagination parameters documentation for endpoints: +- api/v1/DealFields#getDealFields +- api/v1/OrganizationFields#getOrganizationFields +- api/v1/PersonFields#getPersonFields +- api/v1/ProductFields#getProductFields +## [0.1.20] - 2021-09-29 +## [0.1.19] - 2021-08-30 +### Changed +- Changed `GET /v1/files/{id}/download` response schema format to `byte` instead of `binary` +## [0.1.18] - 2021-08-03 +## [0.1.17] - 2021-07-28 +### Added +- documented add_visible_flag for name in `POST and PUT /dealFields, /personFields and /organizationFields` endpoints documentation +## [0.1.16] - 2021-07-28 +## [0.1.15] - 2021-07-26 +### Added +- `visible_to` can be set in `POST /leads` and `PATCH /leads/{id}` +- `cc_email` now exposed in public API +- `was_seen` can be set in `POST /leads` and `PATCH /leads/{id}` +## [0.1.14] - 2021-07-23 +## [0.1.13] - 2021-07-26 +### Added +- added product and related_objects sections to example of `GET /deals/{id}/products` endpoint documentation +## [0.1.12] - 2021-07-26 +## [0.1.11] - 2021-06-25 +### Added +- Added `GET /notes/{id}/comments` +- Added `POST /notes/{id}/comments` +- Added `PUT /notes/{id}/comments/{commentId}` +- Added `DELETE /notes/{id}/comments/{commentId}` +## [0.1.10] - 2021-07-14 +## [0.1.9] - 2021-07-14 +### Changed +Fixed typo in organization-relationships.yaml file (`getOrganizationRelationShips` to `getOrganizationRelationships`) +## [0.1.8] - 2021-07-09 +## [0.1.7] - 2021-05-03 +### Added +- added lead source `Manually created` to the leadSources.yaml +### Changed +- lead sources description in lead.yaml to reflect the new changes coming to the lead response +## [0.1.6] - 2021-06-27 +## [0.1.5] - 2021-06-27 +### Removed +- Deleted deprecated `note` field from all lead related documents. +- Fixed typo in lead example response (`crrency` to `currency`) +## [0.1.4] - 2021-06-09 +## [0.1.3] - 2021-06-09 +### Added +- `Team` (singular) schema for endpoints that deal with a signle team +### Changed +- `TeamSuccess` response schema to refer to `Team` (singular) instead of `Teams` (plural) +## [0.1.2] - 2021-06-09 +## [0.1.0] - 2021-04-22 +### Changed +- Deleted `MailThreads` and `MailMessages` from API operation groups and combined them under `Mailbox` group. +- Extracted `LeadLabels` and `LeadSources` API operation groups from `Leads` group. +## [0.0.4] - 2021-02-16 +## [0.0.3] - 2021-01-11 +### Added +- Add into documentation that also a Lead is one of the possible returned entities in related objects for the search endpoint. +## [0.0.2] - 2021-01-11 +## [0.0.1] - 2020-11-17 +### Added +- Add changelog +### Changed ## [27.1.1] - 2025-05-23 ### Fixed diff --git a/src/versions/v1/models/base-deal.ts b/src/versions/v1/models/base-deal.ts index 60c37cfb..dd346a7b 100644 --- a/src/versions/v1/models/base-deal.ts +++ b/src/versions/v1/models/base-deal.ts @@ -66,11 +66,6 @@ export interface BaseDeal { */ 'deleted'?: boolean; /** - * Whether the deal is archived or not - * @type {boolean} - */ - 'is_archived'?: boolean; - /** * The status of the deal * @type {string} */ diff --git a/src/versions/v1/models/new-deal-parameters.ts b/src/versions/v1/models/new-deal-parameters.ts index ab4f857c..d3e04c3a 100644 --- a/src/versions/v1/models/new-deal-parameters.ts +++ b/src/versions/v1/models/new-deal-parameters.ts @@ -61,16 +61,6 @@ export interface NewDealParameters { */ 'stage_id'?: number; /** - * Whether the deal is archived or not. If omitted, is_archived will be set to false. - * @type {boolean} - */ - 'is_archived'?: boolean; - /** - * The optional date and time of archiving the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. If omitted and `is_archived` is true, it will be set to the current date and time. - * @type {string} - */ - 'archive_time'?: string; - /** * open = Open, won = Won, lost = Lost, deleted = Deleted. If omitted, status will be set to open. * @type {string} */ diff --git a/src/versions/v1/models/update-deal-parameters.ts b/src/versions/v1/models/update-deal-parameters.ts index 44de8172..d16fb47c 100644 --- a/src/versions/v1/models/update-deal-parameters.ts +++ b/src/versions/v1/models/update-deal-parameters.ts @@ -61,11 +61,6 @@ export interface UpdateDealParameters { */ 'stage_id'?: number; /** - * Whether the deal is archived or not - * @type {boolean} - */ - 'is_archived'?: boolean; - /** * open = Open, won = Won, lost = Lost, deleted = Deleted. * @type {string} */ diff --git a/src/versions/v2/api/beta-api.ts b/src/versions/v2/api/beta-api.ts index c358ad38..b15870df 100644 --- a/src/versions/v2/api/beta-api.ts +++ b/src/versions/v2/api/beta-api.ts @@ -77,7 +77,7 @@ export const BetaApiAxiosParamCreator = function (configuration?: Configuration) // authentication oauth2 required // oauth required - await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:full"], configuration) + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:full", "leads:full"], configuration) @@ -119,7 +119,7 @@ export const BetaApiAxiosParamCreator = function (configuration?: Configuration) // authentication oauth2 required // oauth required - await setOAuthToObject(localVarHeaderParameter, "oauth2", ["leads:full"], configuration) + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:full", "leads:full"], configuration) @@ -212,7 +212,7 @@ export const BetaApiAxiosParamCreator = function (configuration?: Configuration) // authentication oauth2 required // oauth required - await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:full", "deals:read"], configuration) + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read"], configuration) @@ -321,7 +321,7 @@ export const BetaApiAxiosParamCreator = function (configuration?: Configuration) // authentication oauth2 required // oauth required - await setOAuthToObject(localVarHeaderParameter, "oauth2", ["leads:full", "leads:read"], configuration) + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["leads:read"], configuration) diff --git a/src/versions/v2/api/deals-api.ts b/src/versions/v2/api/deals-api.ts index 864bea29..491ee871 100644 --- a/src/versions/v2/api/deals-api.ts +++ b/src/versions/v2/api/deals-api.ts @@ -248,7 +248,7 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration // authentication oauth2 required // oauth required - await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:full"], configuration) + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:full", "leads:full"], configuration) @@ -538,14 +538,14 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration * @param {string} [updated_until] If set, only deals with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. * @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`. * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`. - * @param {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include + * @param {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time'} [include_fields] Optional comma separated string array of additional fields to include * @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. * @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. * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page * @throws {RequiredError} */ - getArchivedDeals: async (filter_id?: number, ids?: string, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted', updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email', custom_fields?: string, limit?: number, cursor?: string, ): Promise => { + getArchivedDeals: async (filter_id?: number, ids?: string, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted', updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time', custom_fields?: string, limit?: number, cursor?: string, ): Promise => { const localVarPath = `/deals/archived`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -644,12 +644,12 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration * Returns the details of a specific deal. * @summary Get details of a deal * @param {number} id The ID of the deal - * @param {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include + * @param {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time'} [include_fields] Optional comma separated string array of additional fields to include * @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. * @throws {RequiredError} */ - getDeal: async (id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email', custom_fields?: string, ): Promise => { + getDeal: async (id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time', custom_fields?: string, ): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getDeal', 'id', id) const localVarPath = `/deals/{id}` @@ -723,7 +723,7 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration // authentication oauth2 required // oauth required - await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:full", "deals:read"], configuration) + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read"], configuration) @@ -914,14 +914,14 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration * @param {string} [updated_until] If set, only deals with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. * @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`. * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`. - * @param {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include + * @param {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time'} [include_fields] Optional comma separated string array of additional fields to include * @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. * @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. * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page * @throws {RequiredError} */ - getDeals: async (filter_id?: number, ids?: string, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted', updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email', custom_fields?: string, limit?: number, cursor?: string, ): Promise => { + getDeals: async (filter_id?: number, ids?: string, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted', updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time', custom_fields?: string, limit?: number, cursor?: string, ): Promise => { const localVarPath = `/deals`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -1652,14 +1652,14 @@ export const DealsApiFp = function(configuration?: Configuration) { * @param {string} [updated_until] If set, only deals with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. * @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`. * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`. - * @param {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include + * @param {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time'} [include_fields] Optional comma separated string array of additional fields to include * @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. * @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. * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page * @throws {RequiredError} */ - async getArchivedDeals(filter_id?: number, ids?: string, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted', updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email', custom_fields?: string, limit?: number, cursor?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + async getArchivedDeals(filter_id?: number, ids?: string, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted', updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time', custom_fields?: string, limit?: number, cursor?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getArchivedDeals(filter_id, ids, owner_id, person_id, org_id, pipeline_id, stage_id, status, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, limit, cursor, ); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -1667,12 +1667,12 @@ export const DealsApiFp = function(configuration?: Configuration) { * Returns the details of a specific deal. * @summary Get details of a deal * @param {number} id The ID of the deal - * @param {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include + * @param {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time'} [include_fields] Optional comma separated string array of additional fields to include * @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. * @throws {RequiredError} */ - async getDeal(id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email', custom_fields?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + async getDeal(id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time', custom_fields?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getDeal(id, include_fields, custom_fields, ); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -1744,14 +1744,14 @@ export const DealsApiFp = function(configuration?: Configuration) { * @param {string} [updated_until] If set, only deals with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. * @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`. * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`. - * @param {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include + * @param {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time'} [include_fields] Optional comma separated string array of additional fields to include * @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. * @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. * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page * @throws {RequiredError} */ - async getDeals(filter_id?: number, ids?: string, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted', updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email', custom_fields?: string, limit?: number, cursor?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + async getDeals(filter_id?: number, ids?: string, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted', updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time', custom_fields?: string, limit?: number, cursor?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getDeals(filter_id, ids, owner_id, person_id, org_id, pipeline_id, stage_id, status, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, limit, cursor, ); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -2426,10 +2426,10 @@ export interface DealsApiGetArchivedDealsRequest { /** * Optional comma separated string array of additional fields to include - * @type {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email'} + * @type {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time'} * @memberof DealsApiGetArchivedDeals */ - readonly include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' + readonly include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' /** * 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. @@ -2468,10 +2468,10 @@ export interface DealsApiGetDealRequest { /** * Optional comma separated string array of additional fields to include - * @type {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email'} + * @type {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time'} * @memberof DealsApiGetDeal */ - readonly include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' + readonly include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' /** * 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. @@ -2692,10 +2692,10 @@ export interface DealsApiGetDealsRequest { /** * Optional comma separated string array of additional fields to include - * @type {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email'} + * @type {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time'} * @memberof DealsApiGetDeals */ - readonly include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' + readonly include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' /** * 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. diff --git a/src/versions/v2/api/leads-api.ts b/src/versions/v2/api/leads-api.ts index f7bdc131..43fe2c25 100644 --- a/src/versions/v2/api/leads-api.ts +++ b/src/versions/v2/api/leads-api.ts @@ -66,7 +66,7 @@ export const LeadsApiAxiosParamCreator = function (configuration?: Configuration // authentication oauth2 required // oauth required - await setOAuthToObject(localVarHeaderParameter, "oauth2", ["leads:full"], configuration) + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:full", "leads:full"], configuration) @@ -114,7 +114,7 @@ export const LeadsApiAxiosParamCreator = function (configuration?: Configuration // authentication oauth2 required // oauth required - await setOAuthToObject(localVarHeaderParameter, "oauth2", ["leads:full", "leads:read"], configuration) + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["leads:read"], configuration) diff --git a/src/versions/v2/models/add-deal-request.ts b/src/versions/v2/models/add-deal-request.ts index 001f4813..cbdc2f04 100644 --- a/src/versions/v2/models/add-deal-request.ts +++ b/src/versions/v2/models/add-deal-request.ts @@ -81,16 +81,6 @@ export interface AddDealRequest { */ 'is_deleted'?: boolean; /** - * Whether the deal is archived or not - * @type {boolean} - */ - 'is_archived'?: boolean; - /** - * The optional date and time of archiving the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. If omitted and `is_archived` is true, it will be set to the current date and time. - * @type {string} - */ - 'archive_time'?: string; - /** * The status of the deal * @type {string} */ diff --git a/src/versions/v2/models/deal-item.ts b/src/versions/v2/models/deal-item.ts index 9b69a7db..d6f258ea 100644 --- a/src/versions/v2/models/deal-item.ts +++ b/src/versions/v2/models/deal-item.ts @@ -81,15 +81,15 @@ export interface DealItem { */ 'stage_change_time'?: string; /** - * Whether the deal is deleted or not + * Whether the deal is archived or not * @type {boolean} */ - 'is_deleted'?: boolean; + 'is_archived'?: boolean; /** - * Whether the deal is archived or not + * Whether the deal is deleted or not * @type {boolean} */ - 'is_archived'?: boolean; + 'is_deleted'?: boolean; /** * The status of the deal * @type {string} diff --git a/src/versions/v2/models/deal-item1.ts b/src/versions/v2/models/deal-item1.ts index 9c05d750..cca18da5 100644 --- a/src/versions/v2/models/deal-item1.ts +++ b/src/versions/v2/models/deal-item1.ts @@ -81,15 +81,15 @@ export interface DealItem1 { */ 'stage_change_time'?: string; /** - * Whether the deal is deleted or not + * Whether the deal is archived or not * @type {boolean} */ - 'is_deleted'?: boolean; + 'is_archived'?: boolean; /** - * Whether the deal is archived or not + * Whether the deal is deleted or not * @type {boolean} */ - 'is_archived'?: boolean; + 'is_deleted'?: boolean; /** * The status of the deal * @type {string} diff --git a/src/versions/v2/models/update-deal-request.ts b/src/versions/v2/models/update-deal-request.ts index 768ed681..fe669b68 100644 --- a/src/versions/v2/models/update-deal-request.ts +++ b/src/versions/v2/models/update-deal-request.ts @@ -81,16 +81,6 @@ export interface UpdateDealRequest { */ 'is_deleted'?: boolean; /** - * Whether the deal is archived or not - * @type {boolean} - */ - 'is_archived'?: boolean; - /** - * The optional date and time of archiving the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. If omitted and `is_archived` is true, it will be set to the current date and time. - * @type {string} - */ - 'archive_time'?: string; - /** * The status of the deal * @type {string} */