diff --git a/CHANGELOG.md b/CHANGELOG.md index e99ff720..daf723d3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,9 @@ 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] +### Added +- Added `is_archived` to request bodies of POST `deals` endpoints and PUT/PATCH `/deals/:id` endpoints +- Added `archive_time` to request bodies of POST `deals` endpoints ## [27.0.0] - 2025-05-09 ### Changed diff --git a/src/versions/v1/models/base-deal.ts b/src/versions/v1/models/base-deal.ts index dd346a7b..60c37cfb 100644 --- a/src/versions/v1/models/base-deal.ts +++ b/src/versions/v1/models/base-deal.ts @@ -66,6 +66,11 @@ 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 d3e04c3a..ab4f857c 100644 --- a/src/versions/v1/models/new-deal-parameters.ts +++ b/src/versions/v1/models/new-deal-parameters.ts @@ -61,6 +61,16 @@ 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 d16fb47c..44de8172 100644 --- a/src/versions/v1/models/update-deal-parameters.ts +++ b/src/versions/v1/models/update-deal-parameters.ts @@ -61,6 +61,11 @@ 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/models/add-deal-request.ts b/src/versions/v2/models/add-deal-request.ts index cbdc2f04..001f4813 100644 --- a/src/versions/v2/models/add-deal-request.ts +++ b/src/versions/v2/models/add-deal-request.ts @@ -81,6 +81,16 @@ 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 d6f258ea..9b69a7db 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 archived or not + * Whether the deal is deleted or not * @type {boolean} */ - 'is_archived'?: boolean; + 'is_deleted'?: boolean; /** - * Whether the deal is deleted or not + * Whether the deal is archived or not * @type {boolean} */ - 'is_deleted'?: boolean; + 'is_archived'?: 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 cca18da5..9c05d750 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 archived or not + * Whether the deal is deleted or not * @type {boolean} */ - 'is_archived'?: boolean; + 'is_deleted'?: boolean; /** - * Whether the deal is deleted or not + * Whether the deal is archived or not * @type {boolean} */ - 'is_deleted'?: boolean; + 'is_archived'?: 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 fe669b68..768ed681 100644 --- a/src/versions/v2/models/update-deal-request.ts +++ b/src/versions/v2/models/update-deal-request.ts @@ -81,6 +81,16 @@ 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} */