From bce70192c717a0da3817eab5e9b5eb5678d399cf Mon Sep 17 00:00:00 2001 From: pipedrive-bot Date: Thu, 6 Jun 2024 13:58:29 +0000 Subject: [PATCH 1/2] Build 25 - version-minor --- CHANGELOG.md | 7 ++ docs/AddNoteRequest.md | 2 +- docs/BaseDeal.md | 6 ++ docs/BasicPerson.md | 2 +- docs/DealNonStrict.md | 6 ++ docs/DealNonStrictWithDetails.md | 6 ++ docs/DealStrict.md | 6 ++ docs/DealStrictWithMergeId.md | 6 ++ docs/NewDeal.md | 2 +- docs/NewDealParameters.md | 2 +- docs/NewOrganization.md | 2 +- docs/NewOrganizationAllOf.md | 2 +- docs/NewPerson.md | 2 +- docs/Note.md | 2 +- docs/NoteParams.md | 2 +- docs/UpdatePerson.md | 2 +- src/model/AddNoteRequest.js | 4 +- src/model/BaseDeal.js | 66 ++++++++++++++++++ src/model/BasicPerson.js | 2 +- src/model/DealNonStrict.js | 96 +++++++++++++++++++++++++++ src/model/DealNonStrictWithDetails.js | 96 +++++++++++++++++++++++++++ src/model/DealStrict.js | 96 +++++++++++++++++++++++++++ src/model/DealStrictWithMergeId.js | 96 +++++++++++++++++++++++++++ src/model/NewDeal.js | 4 +- src/model/NewDealParameters.js | 2 +- src/model/NewOrganization.js | 4 +- src/model/NewOrganizationAllOf.js | 2 +- src/model/NewPerson.js | 4 +- src/model/Note.js | 4 +- src/model/NoteParams.js | 2 +- src/model/UpdatePerson.js | 4 +- 31 files changed, 513 insertions(+), 26 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2e8cf003..df8ca437 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,13 @@ 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 `acv`, `mrr`, `arr`, `acv_currency`, `mrr_currency`, and `arr_currency` to the BaseDeal entity and the following endpoints' response: +- `GET`, `POST` `/v1/deals` +- `GET`, `PUT` `/v1/deals/{id}` +- `GET` `/v1/deals/timeline` +- `PUT` `/v1/deals/{id}/merge` +- `POST` `/v1/deals/{id}/duplicate` ## [22.9.0] - 2024-05-30 ### Fixed diff --git a/docs/AddNoteRequest.md b/docs/AddNoteRequest.md index 03072c47..39bd99a8 100644 --- a/docs/AddNoteRequest.md +++ b/docs/AddNoteRequest.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **person_id** | **Number** | The ID of the person this note will be attached to. This property is required unless one of (`deal_id/lead_id/org_id`) is specified. | [optional] **org_id** | **Number** | The ID of the organization this note will be attached to. This property is required unless one of (`deal_id/lead_id/person_id`) is specified. | [optional] **user_id** | **Number** | The ID of the user who will be marked as the author of the note. Only an admin can change the author. | [optional] -**add_time** | **String** | The optional creation date & time of the note in UTC. Can be set in the past or in the future. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] +**add_time** | **String** | The optional creation date & time of the note in UTC. Can be set in the past or in the future. Format: YYYY-MM-DD HH:MM:SS | [optional] **pinned_to_lead_flag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to lead pinning state (`lead_id` is also required) | [optional] **pinned_to_deal_flag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to deal pinning state (`deal_id` is also required) | [optional] **pinned_to_organization_flag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to organization pinning state (`org_id` is also required) | [optional] diff --git a/docs/BaseDeal.md b/docs/BaseDeal.md index 3466feaf..990f5648 100644 --- a/docs/BaseDeal.md +++ b/docs/BaseDeal.md @@ -60,5 +60,11 @@ Name | Type | Description | Notes **origin_id** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. | [optional] **channel** | **Number** | The ID of your Marketing channel this Deal was created from. Recognized Marketing channels can be configured in your <a href=\"https://app.pipedrive.com/settings/fields\" target=\"_blank\" rel=\"noopener noreferrer\">Company settings</a>. | [optional] **channel_id** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] +**arr** | **Number** | Only available in Advanced and above plans The Annual Recurring Revenue of the deal Null if there are no products attached to the deal | [optional] +**mrr** | **Number** | Only available in Advanced and above plans The Monthly Recurring Revenue of the deal Null if there are no products attached to the deal | [optional] +**acv** | **Number** | Only available in Advanced and above plans The Annual Contract Value of the deal Null if there are no products attached to the deal | [optional] +**arr_currency** | **String** | Only available in Advanced and above plans The Currency for Annual Recurring Revenue of the deal If the `arr` is null, this will also be null | [optional] +**mrr_currency** | **String** | Only available in Advanced and above plans The Currency for Monthly Recurring Revenue of the deal If the `mrr` is null, this will also be null | [optional] +**acv_currency** | **String** | Only available in Advanced and above plans The Currency for Annual Contract Value of the deal If the `acv` is null, this will also be null | [optional] diff --git a/docs/BasicPerson.md b/docs/BasicPerson.md index be81aad9..1c2f8e3e 100644 --- a/docs/BasicPerson.md +++ b/docs/BasicPerson.md @@ -11,6 +11,6 @@ Name | Type | Description | Notes **label** | **Number** | The ID of the label. | [optional] **visible_to** | [**VisibleTo**](VisibleTo.md) | The visibility of the person. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] **marketing_status** | [**MarketingStatus**](MarketingStatus.md) | If the person does not have a valid email address, then the marketing status is **not set** and `no_consent` is returned for the `marketing_status` value when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed **once** to change the marketing status from an old status to a new one.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`no_consent`</td><td>The customer has not given consent to receive any marketing communications</td></tr><tr><td>`unsubscribed`</td><td>The customers have unsubscribed from ALL marketing communications</td></tr><tr><td>`subscribed`</td><td>The customers are subscribed and are counted towards marketing caps</td></tr><tr><td>`archived`</td><td>The customers with `subscribed` status can be moved to `archived` to save consent, but they are not paid for</td></tr></table> | [optional] -**add_time** | **String** | The optional creation date & time of the person in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] +**add_time** | **String** | The optional creation date & time of the person in UTC. Format: YYYY-MM-DD HH:MM:SS | [optional] diff --git a/docs/DealNonStrict.md b/docs/DealNonStrict.md index c489daf1..5997e10d 100644 --- a/docs/DealNonStrict.md +++ b/docs/DealNonStrict.md @@ -65,5 +65,11 @@ Name | Type | Description | Notes **origin_id** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. | [optional] **channel** | **Number** | The ID of your Marketing channel this Deal was created from. Recognized Marketing channels can be configured in your <a href=\"https://app.pipedrive.com/settings/fields\" target=\"_blank\" rel=\"noopener noreferrer\">Company settings</a>. | [optional] **channel_id** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] +**arr** | **Number** | Only available in Advanced and above plans The Annual Recurring Revenue of the deal Null if there are no products attached to the deal | [optional] +**mrr** | **Number** | Only available in Advanced and above plans The Monthly Recurring Revenue of the deal Null if there are no products attached to the deal | [optional] +**acv** | **Number** | Only available in Advanced and above plans The Annual Contract Value of the deal Null if there are no products attached to the deal | [optional] +**arr_currency** | **String** | Only available in Advanced and above plans The Currency for Annual Recurring Revenue of the deal If the `arr` is null, this will also be null | [optional] +**mrr_currency** | **String** | Only available in Advanced and above plans The Currency for Monthly Recurring Revenue of the deal If the `mrr` is null, this will also be null | [optional] +**acv_currency** | **String** | Only available in Advanced and above plans The Currency for Annual Contract Value of the deal If the `acv` is null, this will also be null | [optional] diff --git a/docs/DealNonStrictWithDetails.md b/docs/DealNonStrictWithDetails.md index dd3b9699..5e215cd2 100644 --- a/docs/DealNonStrictWithDetails.md +++ b/docs/DealNonStrictWithDetails.md @@ -65,6 +65,12 @@ Name | Type | Description | Notes **origin_id** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. | [optional] **channel** | **Number** | The ID of your Marketing channel this Deal was created from. Recognized Marketing channels can be configured in your <a href=\"https://app.pipedrive.com/settings/fields\" target=\"_blank\" rel=\"noopener noreferrer\">Company settings</a>. | [optional] **channel_id** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] +**arr** | **Number** | Only available in Advanced and above plans The Annual Recurring Revenue of the deal Null if there are no products attached to the deal | [optional] +**mrr** | **Number** | Only available in Advanced and above plans The Monthly Recurring Revenue of the deal Null if there are no products attached to the deal | [optional] +**acv** | **Number** | Only available in Advanced and above plans The Annual Contract Value of the deal Null if there are no products attached to the deal | [optional] +**arr_currency** | **String** | Only available in Advanced and above plans The Currency for Annual Recurring Revenue of the deal If the `arr` is null, this will also be null | [optional] +**mrr_currency** | **String** | Only available in Advanced and above plans The Currency for Monthly Recurring Revenue of the deal If the `mrr` is null, this will also be null | [optional] +**acv_currency** | **String** | Only available in Advanced and above plans The Currency for Annual Contract Value of the deal If the `acv` is null, this will also be null | [optional] **average_time_to_won** | [**DealNonStrictWithDetailsAllOfAverageTimeToWon**](DealNonStrictWithDetailsAllOfAverageTimeToWon.md) | | [optional] **average_stage_progress** | **Number** | The average of the deal stage progression | [optional] **age** | [**DealNonStrictWithDetailsAllOfAge**](DealNonStrictWithDetailsAllOfAge.md) | | [optional] diff --git a/docs/DealStrict.md b/docs/DealStrict.md index e356b3b0..3676eab0 100644 --- a/docs/DealStrict.md +++ b/docs/DealStrict.md @@ -65,5 +65,11 @@ Name | Type | Description | Notes **origin_id** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. | [optional] **channel** | **Number** | The ID of your Marketing channel this Deal was created from. Recognized Marketing channels can be configured in your <a href=\"https://app.pipedrive.com/settings/fields\" target=\"_blank\" rel=\"noopener noreferrer\">Company settings</a>. | [optional] **channel_id** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] +**arr** | **Number** | Only available in Advanced and above plans The Annual Recurring Revenue of the deal Null if there are no products attached to the deal | [optional] +**mrr** | **Number** | Only available in Advanced and above plans The Monthly Recurring Revenue of the deal Null if there are no products attached to the deal | [optional] +**acv** | **Number** | Only available in Advanced and above plans The Annual Contract Value of the deal Null if there are no products attached to the deal | [optional] +**arr_currency** | **String** | Only available in Advanced and above plans The Currency for Annual Recurring Revenue of the deal If the `arr` is null, this will also be null | [optional] +**mrr_currency** | **String** | Only available in Advanced and above plans The Currency for Monthly Recurring Revenue of the deal If the `mrr` is null, this will also be null | [optional] +**acv_currency** | **String** | Only available in Advanced and above plans The Currency for Annual Contract Value of the deal If the `acv` is null, this will also be null | [optional] diff --git a/docs/DealStrictWithMergeId.md b/docs/DealStrictWithMergeId.md index f006c86c..5e67fcf5 100644 --- a/docs/DealStrictWithMergeId.md +++ b/docs/DealStrictWithMergeId.md @@ -65,6 +65,12 @@ Name | Type | Description | Notes **origin_id** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. | [optional] **channel** | **Number** | The ID of your Marketing channel this Deal was created from. Recognized Marketing channels can be configured in your <a href=\"https://app.pipedrive.com/settings/fields\" target=\"_blank\" rel=\"noopener noreferrer\">Company settings</a>. | [optional] **channel_id** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] +**arr** | **Number** | Only available in Advanced and above plans The Annual Recurring Revenue of the deal Null if there are no products attached to the deal | [optional] +**mrr** | **Number** | Only available in Advanced and above plans The Monthly Recurring Revenue of the deal Null if there are no products attached to the deal | [optional] +**acv** | **Number** | Only available in Advanced and above plans The Annual Contract Value of the deal Null if there are no products attached to the deal | [optional] +**arr_currency** | **String** | Only available in Advanced and above plans The Currency for Annual Recurring Revenue of the deal If the `arr` is null, this will also be null | [optional] +**mrr_currency** | **String** | Only available in Advanced and above plans The Currency for Monthly Recurring Revenue of the deal If the `mrr` is null, this will also be null | [optional] +**acv_currency** | **String** | Only available in Advanced and above plans The Currency for Annual Contract Value of the deal If the `acv` is null, this will also be null | [optional] **merge_what_id** | **Number** | The deal ID of the deal which the original deal was merged with | [optional] diff --git a/docs/NewDeal.md b/docs/NewDeal.md index 8a5fd4c3..9f39b04f 100644 --- a/docs/NewDeal.md +++ b/docs/NewDeal.md @@ -17,7 +17,7 @@ Name | Type | Description | Notes **origin_id** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this deal. If omitted, `origin_id` will be set to null. | [optional] **channel** | **Number** | The ID of Marketing channel this deal was created from. Provided value must be one of the channels configured for your company. You can fetch allowed values with <a href=\"https://developers.pipedrive.com/docs/api/v1/DealFields#getDealField\" target=\"_blank\" rel=\"noopener noreferrer\">GET /v1/dealFields</a>. If omitted, channel will be set to null. | [optional] **channel_id** | **String** | The optional ID to further distinguish the Marketing channel. If omitted, `channel_id` will be set to null. | [optional] -**add_time** | **String** | The optional creation date & time of the deal in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] +**add_time** | **String** | The optional creation date & time of the deal in UTC. Format: YYYY-MM-DD HH:MM:SS | [optional] **won_time** | **String** | The optional date and time of changing the deal status as won in UTC. Format: YYYY-MM-DD HH:MM:SS. Can be set only when deal `status` is already Won. Can not be used together with `lost_time`. | [optional] **lost_time** | **String** | The optional date and time of changing the deal status as lost in UTC. Format: YYYY-MM-DD HH:MM:SS. Can be set only when deal `status` is already Lost. Can not be used together with `won_time`. | [optional] **close_time** | **String** | The optional date and time of closing the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] diff --git a/docs/NewDealParameters.md b/docs/NewDealParameters.md index f95e005e..f45a7e57 100644 --- a/docs/NewDealParameters.md +++ b/docs/NewDealParameters.md @@ -16,7 +16,7 @@ Name | Type | Description | Notes **origin_id** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this deal. If omitted, `origin_id` will be set to null. | [optional] **channel** | **Number** | The ID of Marketing channel this deal was created from. Provided value must be one of the channels configured for your company. You can fetch allowed values with <a href=\"https://developers.pipedrive.com/docs/api/v1/DealFields#getDealField\" target=\"_blank\" rel=\"noopener noreferrer\">GET /v1/dealFields</a>. If omitted, channel will be set to null. | [optional] **channel_id** | **String** | The optional ID to further distinguish the Marketing channel. If omitted, `channel_id` will be set to null. | [optional] -**add_time** | **String** | The optional creation date & time of the deal in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] +**add_time** | **String** | The optional creation date & time of the deal in UTC. Format: YYYY-MM-DD HH:MM:SS | [optional] diff --git a/docs/NewOrganization.md b/docs/NewOrganization.md index 81d6907e..4adce497 100644 --- a/docs/NewOrganization.md +++ b/docs/NewOrganization.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the organization | -**add_time** | **String** | The optional creation date & time of the organization in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] +**add_time** | **String** | The optional creation date & time of the organization in UTC. Format: YYYY-MM-DD HH:MM:SS | [optional] **owner_id** | **Number** | The ID of the user who will be marked as the owner of this organization. When omitted, the authorized user ID will be used. | [optional] **label** | **Number** | The ID of the label. | [optional] **visible_to** | [**VisibleTo**](VisibleTo.md) | The visibility of the organization. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] diff --git a/docs/NewOrganizationAllOf.md b/docs/NewOrganizationAllOf.md index 43edd5a5..676b67db 100644 --- a/docs/NewOrganizationAllOf.md +++ b/docs/NewOrganizationAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the organization | -**add_time** | **String** | The optional creation date & time of the organization in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] +**add_time** | **String** | The optional creation date & time of the organization in UTC. Format: YYYY-MM-DD HH:MM:SS | [optional] diff --git a/docs/NewPerson.md b/docs/NewPerson.md index 225f55d8..fab5b572 100644 --- a/docs/NewPerson.md +++ b/docs/NewPerson.md @@ -12,6 +12,6 @@ Name | Type | Description | Notes **label** | **Number** | The ID of the label. | [optional] **visible_to** | [**VisibleTo**](VisibleTo.md) | The visibility of the person. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] **marketing_status** | [**MarketingStatus**](MarketingStatus.md) | If the person does not have a valid email address, then the marketing status is **not set** and `no_consent` is returned for the `marketing_status` value when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed **once** to change the marketing status from an old status to a new one.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`no_consent`</td><td>The customer has not given consent to receive any marketing communications</td></tr><tr><td>`unsubscribed`</td><td>The customers have unsubscribed from ALL marketing communications</td></tr><tr><td>`subscribed`</td><td>The customers are subscribed and are counted towards marketing caps</td></tr><tr><td>`archived`</td><td>The customers with `subscribed` status can be moved to `archived` to save consent, but they are not paid for</td></tr></table> | [optional] -**add_time** | **String** | The optional creation date & time of the person in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] +**add_time** | **String** | The optional creation date & time of the person in UTC. Format: YYYY-MM-DD HH:MM:SS | [optional] diff --git a/docs/Note.md b/docs/Note.md index 71c0ee44..1e18c1e0 100644 --- a/docs/Note.md +++ b/docs/Note.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **person_id** | **Number** | The ID of the person the note will be attached to | [optional] **org_id** | **Number** | The ID of the organization the note will be attached to | [optional] **user_id** | **Number** | The ID of the user who will be marked as the author of the note. Only an admin can change the author. | [optional] -**add_time** | **String** | The optional creation date & time of the note in UTC. Can be set in the past or in the future. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] +**add_time** | **String** | The optional creation date & time of the note in UTC. Can be set in the past or in the future. Format: YYYY-MM-DD HH:MM:SS | [optional] **pinned_to_lead_flag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to lead pinning state (`lead_id` is also required) | [optional] **pinned_to_deal_flag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to deal pinning state (`deal_id` is also required) | [optional] **pinned_to_organization_flag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to organization pinning state (`org_id` is also required) | [optional] diff --git a/docs/NoteParams.md b/docs/NoteParams.md index fb3b515c..6d1e9cd8 100644 --- a/docs/NoteParams.md +++ b/docs/NoteParams.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **user_id** | **Number** | The ID of the user who will be marked as the author of the note. Only an admin can change the author. | [optional] -**add_time** | **String** | The optional creation date & time of the note in UTC. Can be set in the past or in the future. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] +**add_time** | **String** | The optional creation date & time of the note in UTC. Can be set in the past or in the future. Format: YYYY-MM-DD HH:MM:SS | [optional] **pinned_to_lead_flag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to lead pinning state (`lead_id` is also required) | [optional] **pinned_to_deal_flag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to deal pinning state (`deal_id` is also required) | [optional] **pinned_to_organization_flag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to organization pinning state (`org_id` is also required) | [optional] diff --git a/docs/UpdatePerson.md b/docs/UpdatePerson.md index 7b5c55e4..6801dc6b 100644 --- a/docs/UpdatePerson.md +++ b/docs/UpdatePerson.md @@ -12,6 +12,6 @@ Name | Type | Description | Notes **label** | **Number** | The ID of the label. | [optional] **visible_to** | [**VisibleTo**](VisibleTo.md) | The visibility of the person. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] **marketing_status** | [**MarketingStatus**](MarketingStatus.md) | If the person does not have a valid email address, then the marketing status is **not set** and `no_consent` is returned for the `marketing_status` value when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed **once** to change the marketing status from an old status to a new one.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`no_consent`</td><td>The customer has not given consent to receive any marketing communications</td></tr><tr><td>`unsubscribed`</td><td>The customers have unsubscribed from ALL marketing communications</td></tr><tr><td>`subscribed`</td><td>The customers are subscribed and are counted towards marketing caps</td></tr><tr><td>`archived`</td><td>The customers with `subscribed` status can be moved to `archived` to save consent, but they are not paid for</td></tr></table> | [optional] -**add_time** | **String** | The optional creation date & time of the person in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] +**add_time** | **String** | The optional creation date & time of the person in UTC. Format: YYYY-MM-DD HH:MM:SS | [optional] diff --git a/src/model/AddNoteRequest.js b/src/model/AddNoteRequest.js index c8952788..f4e381a9 100644 --- a/src/model/AddNoteRequest.js +++ b/src/model/AddNoteRequest.js @@ -160,7 +160,7 @@ AddNoteRequest.prototype['org_id'] = undefined; AddNoteRequest.prototype['user_id'] = undefined; /** - * The optional creation date & time of the note in UTC. Can be set in the past or in the future. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS + * The optional creation date & time of the note in UTC. Can be set in the past or in the future. Format: YYYY-MM-DD HH:MM:SS * @member {String} add_time */ AddNoteRequest.prototype['add_time'] = undefined; @@ -223,7 +223,7 @@ AddNoteRequestAllOf.prototype['org_id'] = undefined; */ NoteParams.prototype['user_id'] = undefined; /** - * The optional creation date & time of the note in UTC. Can be set in the past or in the future. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS + * The optional creation date & time of the note in UTC. Can be set in the past or in the future. Format: YYYY-MM-DD HH:MM:SS * @member {String} add_time */ NoteParams.prototype['add_time'] = undefined; diff --git a/src/model/BaseDeal.js b/src/model/BaseDeal.js index 04f74c76..241488b1 100644 --- a/src/model/BaseDeal.js +++ b/src/model/BaseDeal.js @@ -327,6 +327,36 @@ class BaseDeal { delete data['channel_id']; } + if (data.hasOwnProperty('arr')) { + obj['arr'] = ApiClient.convertToType(data['arr'], 'Number'); + + delete data['arr']; + } + if (data.hasOwnProperty('mrr')) { + obj['mrr'] = ApiClient.convertToType(data['mrr'], 'Number'); + + delete data['mrr']; + } + if (data.hasOwnProperty('acv')) { + obj['acv'] = ApiClient.convertToType(data['acv'], 'Number'); + + delete data['acv']; + } + if (data.hasOwnProperty('arr_currency')) { + obj['arr_currency'] = ApiClient.convertToType(data['arr_currency'], 'String'); + + delete data['arr_currency']; + } + if (data.hasOwnProperty('mrr_currency')) { + obj['mrr_currency'] = ApiClient.convertToType(data['mrr_currency'], 'String'); + + delete data['mrr_currency']; + } + if (data.hasOwnProperty('acv_currency')) { + obj['acv_currency'] = ApiClient.convertToType(data['acv_currency'], 'String'); + + delete data['acv_currency']; + } if (Object.keys(data).length > 0) { Object.assign(obj, data); @@ -675,6 +705,42 @@ BaseDeal.prototype['channel'] = undefined; */ BaseDeal.prototype['channel_id'] = undefined; +/** + * Only available in Advanced and above plans The Annual Recurring Revenue of the deal Null if there are no products attached to the deal + * @member {Number} arr + */ +BaseDeal.prototype['arr'] = undefined; + +/** + * Only available in Advanced and above plans The Monthly Recurring Revenue of the deal Null if there are no products attached to the deal + * @member {Number} mrr + */ +BaseDeal.prototype['mrr'] = undefined; + +/** + * Only available in Advanced and above plans The Annual Contract Value of the deal Null if there are no products attached to the deal + * @member {Number} acv + */ +BaseDeal.prototype['acv'] = undefined; + +/** + * Only available in Advanced and above plans The Currency for Annual Recurring Revenue of the deal If the `arr` is null, this will also be null + * @member {String} arr_currency + */ +BaseDeal.prototype['arr_currency'] = undefined; + +/** + * Only available in Advanced and above plans The Currency for Monthly Recurring Revenue of the deal If the `mrr` is null, this will also be null + * @member {String} mrr_currency + */ +BaseDeal.prototype['mrr_currency'] = undefined; + +/** + * Only available in Advanced and above plans The Currency for Annual Contract Value of the deal If the `acv` is null, this will also be null + * @member {String} acv_currency + */ +BaseDeal.prototype['acv_currency'] = undefined; + diff --git a/src/model/BasicPerson.js b/src/model/BasicPerson.js index 2ab5701c..ace7edd3 100644 --- a/src/model/BasicPerson.js +++ b/src/model/BasicPerson.js @@ -146,7 +146,7 @@ BasicPerson.prototype['visible_to'] = undefined; BasicPerson.prototype['marketing_status'] = undefined; /** - * The optional creation date & time of the person in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS + * The optional creation date & time of the person in UTC. Format: YYYY-MM-DD HH:MM:SS * @member {String} add_time */ BasicPerson.prototype['add_time'] = undefined; diff --git a/src/model/DealNonStrict.js b/src/model/DealNonStrict.js index cdffa9ee..d9564463 100644 --- a/src/model/DealNonStrict.js +++ b/src/model/DealNonStrict.js @@ -362,6 +362,36 @@ class DealNonStrict { delete data['channel_id']; } + if (data.hasOwnProperty('arr')) { + obj['arr'] = ApiClient.convertToType(data['arr'], 'Number'); + + delete data['arr']; + } + if (data.hasOwnProperty('mrr')) { + obj['mrr'] = ApiClient.convertToType(data['mrr'], 'Number'); + + delete data['mrr']; + } + if (data.hasOwnProperty('acv')) { + obj['acv'] = ApiClient.convertToType(data['acv'], 'Number'); + + delete data['acv']; + } + if (data.hasOwnProperty('arr_currency')) { + obj['arr_currency'] = ApiClient.convertToType(data['arr_currency'], 'String'); + + delete data['arr_currency']; + } + if (data.hasOwnProperty('mrr_currency')) { + obj['mrr_currency'] = ApiClient.convertToType(data['mrr_currency'], 'String'); + + delete data['mrr_currency']; + } + if (data.hasOwnProperty('acv_currency')) { + obj['acv_currency'] = ApiClient.convertToType(data['acv_currency'], 'String'); + + delete data['acv_currency']; + } if (Object.keys(data).length > 0) { Object.assign(obj, data); @@ -736,6 +766,42 @@ DealNonStrict.prototype['channel'] = undefined; */ DealNonStrict.prototype['channel_id'] = undefined; +/** + * Only available in Advanced and above plans The Annual Recurring Revenue of the deal Null if there are no products attached to the deal + * @member {Number} arr + */ +DealNonStrict.prototype['arr'] = undefined; + +/** + * Only available in Advanced and above plans The Monthly Recurring Revenue of the deal Null if there are no products attached to the deal + * @member {Number} mrr + */ +DealNonStrict.prototype['mrr'] = undefined; + +/** + * Only available in Advanced and above plans The Annual Contract Value of the deal Null if there are no products attached to the deal + * @member {Number} acv + */ +DealNonStrict.prototype['acv'] = undefined; + +/** + * Only available in Advanced and above plans The Currency for Annual Recurring Revenue of the deal If the `arr` is null, this will also be null + * @member {String} arr_currency + */ +DealNonStrict.prototype['arr_currency'] = undefined; + +/** + * Only available in Advanced and above plans The Currency for Monthly Recurring Revenue of the deal If the `mrr` is null, this will also be null + * @member {String} mrr_currency + */ +DealNonStrict.prototype['mrr_currency'] = undefined; + +/** + * Only available in Advanced and above plans The Currency for Annual Contract Value of the deal If the `acv` is null, this will also be null + * @member {String} acv_currency + */ +DealNonStrict.prototype['acv_currency'] = undefined; + // Implement DealNonStrictModeFields interface: /** @@ -1040,6 +1106,36 @@ BaseDeal.prototype['channel'] = undefined; * @member {String} channel_id */ BaseDeal.prototype['channel_id'] = undefined; +/** + * Only available in Advanced and above plans The Annual Recurring Revenue of the deal Null if there are no products attached to the deal + * @member {Number} arr + */ +BaseDeal.prototype['arr'] = undefined; +/** + * Only available in Advanced and above plans The Monthly Recurring Revenue of the deal Null if there are no products attached to the deal + * @member {Number} mrr + */ +BaseDeal.prototype['mrr'] = undefined; +/** + * Only available in Advanced and above plans The Annual Contract Value of the deal Null if there are no products attached to the deal + * @member {Number} acv + */ +BaseDeal.prototype['acv'] = undefined; +/** + * Only available in Advanced and above plans The Currency for Annual Recurring Revenue of the deal If the `arr` is null, this will also be null + * @member {String} arr_currency + */ +BaseDeal.prototype['arr_currency'] = undefined; +/** + * Only available in Advanced and above plans The Currency for Monthly Recurring Revenue of the deal If the `mrr` is null, this will also be null + * @member {String} mrr_currency + */ +BaseDeal.prototype['mrr_currency'] = undefined; +/** + * Only available in Advanced and above plans The Currency for Annual Contract Value of the deal If the `acv` is null, this will also be null + * @member {String} acv_currency + */ +BaseDeal.prototype['acv_currency'] = undefined; diff --git a/src/model/DealNonStrictWithDetails.js b/src/model/DealNonStrictWithDetails.js index 624abaf0..7c63e988 100644 --- a/src/model/DealNonStrictWithDetails.js +++ b/src/model/DealNonStrictWithDetails.js @@ -365,6 +365,36 @@ class DealNonStrictWithDetails { delete data['channel_id']; } + if (data.hasOwnProperty('arr')) { + obj['arr'] = ApiClient.convertToType(data['arr'], 'Number'); + + delete data['arr']; + } + if (data.hasOwnProperty('mrr')) { + obj['mrr'] = ApiClient.convertToType(data['mrr'], 'Number'); + + delete data['mrr']; + } + if (data.hasOwnProperty('acv')) { + obj['acv'] = ApiClient.convertToType(data['acv'], 'Number'); + + delete data['acv']; + } + if (data.hasOwnProperty('arr_currency')) { + obj['arr_currency'] = ApiClient.convertToType(data['arr_currency'], 'String'); + + delete data['arr_currency']; + } + if (data.hasOwnProperty('mrr_currency')) { + obj['mrr_currency'] = ApiClient.convertToType(data['mrr_currency'], 'String'); + + delete data['mrr_currency']; + } + if (data.hasOwnProperty('acv_currency')) { + obj['acv_currency'] = ApiClient.convertToType(data['acv_currency'], 'String'); + + delete data['acv_currency']; + } if (data.hasOwnProperty('average_time_to_won')) { obj['average_time_to_won'] = DealNonStrictWithDetailsAllOfAverageTimeToWon.constructFromObject(data['average_time_to_won']); @@ -769,6 +799,42 @@ DealNonStrictWithDetails.prototype['channel'] = undefined; */ DealNonStrictWithDetails.prototype['channel_id'] = undefined; +/** + * Only available in Advanced and above plans The Annual Recurring Revenue of the deal Null if there are no products attached to the deal + * @member {Number} arr + */ +DealNonStrictWithDetails.prototype['arr'] = undefined; + +/** + * Only available in Advanced and above plans The Monthly Recurring Revenue of the deal Null if there are no products attached to the deal + * @member {Number} mrr + */ +DealNonStrictWithDetails.prototype['mrr'] = undefined; + +/** + * Only available in Advanced and above plans The Annual Contract Value of the deal Null if there are no products attached to the deal + * @member {Number} acv + */ +DealNonStrictWithDetails.prototype['acv'] = undefined; + +/** + * Only available in Advanced and above plans The Currency for Annual Recurring Revenue of the deal If the `arr` is null, this will also be null + * @member {String} arr_currency + */ +DealNonStrictWithDetails.prototype['arr_currency'] = undefined; + +/** + * Only available in Advanced and above plans The Currency for Monthly Recurring Revenue of the deal If the `mrr` is null, this will also be null + * @member {String} mrr_currency + */ +DealNonStrictWithDetails.prototype['mrr_currency'] = undefined; + +/** + * Only available in Advanced and above plans The Currency for Annual Contract Value of the deal If the `acv` is null, this will also be null + * @member {String} acv_currency + */ +DealNonStrictWithDetails.prototype['acv_currency'] = undefined; + /** * @member {module:model/DealNonStrictWithDetailsAllOfAverageTimeToWon} average_time_to_won */ @@ -1105,6 +1171,36 @@ DealNonStrict.prototype['channel'] = undefined; * @member {String} channel_id */ DealNonStrict.prototype['channel_id'] = undefined; +/** + * Only available in Advanced and above plans The Annual Recurring Revenue of the deal Null if there are no products attached to the deal + * @member {Number} arr + */ +DealNonStrict.prototype['arr'] = undefined; +/** + * Only available in Advanced and above plans The Monthly Recurring Revenue of the deal Null if there are no products attached to the deal + * @member {Number} mrr + */ +DealNonStrict.prototype['mrr'] = undefined; +/** + * Only available in Advanced and above plans The Annual Contract Value of the deal Null if there are no products attached to the deal + * @member {Number} acv + */ +DealNonStrict.prototype['acv'] = undefined; +/** + * Only available in Advanced and above plans The Currency for Annual Recurring Revenue of the deal If the `arr` is null, this will also be null + * @member {String} arr_currency + */ +DealNonStrict.prototype['arr_currency'] = undefined; +/** + * Only available in Advanced and above plans The Currency for Monthly Recurring Revenue of the deal If the `mrr` is null, this will also be null + * @member {String} mrr_currency + */ +DealNonStrict.prototype['mrr_currency'] = undefined; +/** + * Only available in Advanced and above plans The Currency for Annual Contract Value of the deal If the `acv` is null, this will also be null + * @member {String} acv_currency + */ +DealNonStrict.prototype['acv_currency'] = undefined; // Implement DealNonStrictWithDetailsAllOf interface: /** * @member {module:model/DealNonStrictWithDetailsAllOfAverageTimeToWon} average_time_to_won diff --git a/src/model/DealStrict.js b/src/model/DealStrict.js index 0bb6e663..e5a404f2 100644 --- a/src/model/DealStrict.js +++ b/src/model/DealStrict.js @@ -358,6 +358,36 @@ class DealStrict { delete data['channel_id']; } + if (data.hasOwnProperty('arr')) { + obj['arr'] = ApiClient.convertToType(data['arr'], 'Number'); + + delete data['arr']; + } + if (data.hasOwnProperty('mrr')) { + obj['mrr'] = ApiClient.convertToType(data['mrr'], 'Number'); + + delete data['mrr']; + } + if (data.hasOwnProperty('acv')) { + obj['acv'] = ApiClient.convertToType(data['acv'], 'Number'); + + delete data['acv']; + } + if (data.hasOwnProperty('arr_currency')) { + obj['arr_currency'] = ApiClient.convertToType(data['arr_currency'], 'String'); + + delete data['arr_currency']; + } + if (data.hasOwnProperty('mrr_currency')) { + obj['mrr_currency'] = ApiClient.convertToType(data['mrr_currency'], 'String'); + + delete data['mrr_currency']; + } + if (data.hasOwnProperty('acv_currency')) { + obj['acv_currency'] = ApiClient.convertToType(data['acv_currency'], 'String'); + + delete data['acv_currency']; + } if (Object.keys(data).length > 0) { Object.assign(obj, data); @@ -736,6 +766,42 @@ DealStrict.prototype['channel'] = undefined; */ DealStrict.prototype['channel_id'] = undefined; +/** + * Only available in Advanced and above plans The Annual Recurring Revenue of the deal Null if there are no products attached to the deal + * @member {Number} arr + */ +DealStrict.prototype['arr'] = undefined; + +/** + * Only available in Advanced and above plans The Monthly Recurring Revenue of the deal Null if there are no products attached to the deal + * @member {Number} mrr + */ +DealStrict.prototype['mrr'] = undefined; + +/** + * Only available in Advanced and above plans The Annual Contract Value of the deal Null if there are no products attached to the deal + * @member {Number} acv + */ +DealStrict.prototype['acv'] = undefined; + +/** + * Only available in Advanced and above plans The Currency for Annual Recurring Revenue of the deal If the `arr` is null, this will also be null + * @member {String} arr_currency + */ +DealStrict.prototype['arr_currency'] = undefined; + +/** + * Only available in Advanced and above plans The Currency for Monthly Recurring Revenue of the deal If the `mrr` is null, this will also be null + * @member {String} mrr_currency + */ +DealStrict.prototype['mrr_currency'] = undefined; + +/** + * Only available in Advanced and above plans The Currency for Annual Contract Value of the deal If the `acv` is null, this will also be null + * @member {String} acv_currency + */ +DealStrict.prototype['acv_currency'] = undefined; + // Implement DealStrictModeFields interface: /** @@ -1044,6 +1110,36 @@ BaseDeal.prototype['channel'] = undefined; * @member {String} channel_id */ BaseDeal.prototype['channel_id'] = undefined; +/** + * Only available in Advanced and above plans The Annual Recurring Revenue of the deal Null if there are no products attached to the deal + * @member {Number} arr + */ +BaseDeal.prototype['arr'] = undefined; +/** + * Only available in Advanced and above plans The Monthly Recurring Revenue of the deal Null if there are no products attached to the deal + * @member {Number} mrr + */ +BaseDeal.prototype['mrr'] = undefined; +/** + * Only available in Advanced and above plans The Annual Contract Value of the deal Null if there are no products attached to the deal + * @member {Number} acv + */ +BaseDeal.prototype['acv'] = undefined; +/** + * Only available in Advanced and above plans The Currency for Annual Recurring Revenue of the deal If the `arr` is null, this will also be null + * @member {String} arr_currency + */ +BaseDeal.prototype['arr_currency'] = undefined; +/** + * Only available in Advanced and above plans The Currency for Monthly Recurring Revenue of the deal If the `mrr` is null, this will also be null + * @member {String} mrr_currency + */ +BaseDeal.prototype['mrr_currency'] = undefined; +/** + * Only available in Advanced and above plans The Currency for Annual Contract Value of the deal If the `acv` is null, this will also be null + * @member {String} acv_currency + */ +BaseDeal.prototype['acv_currency'] = undefined; diff --git a/src/model/DealStrictWithMergeId.js b/src/model/DealStrictWithMergeId.js index fcec0aff..6cc1565b 100644 --- a/src/model/DealStrictWithMergeId.js +++ b/src/model/DealStrictWithMergeId.js @@ -358,6 +358,36 @@ class DealStrictWithMergeId { delete data['channel_id']; } + if (data.hasOwnProperty('arr')) { + obj['arr'] = ApiClient.convertToType(data['arr'], 'Number'); + + delete data['arr']; + } + if (data.hasOwnProperty('mrr')) { + obj['mrr'] = ApiClient.convertToType(data['mrr'], 'Number'); + + delete data['mrr']; + } + if (data.hasOwnProperty('acv')) { + obj['acv'] = ApiClient.convertToType(data['acv'], 'Number'); + + delete data['acv']; + } + if (data.hasOwnProperty('arr_currency')) { + obj['arr_currency'] = ApiClient.convertToType(data['arr_currency'], 'String'); + + delete data['arr_currency']; + } + if (data.hasOwnProperty('mrr_currency')) { + obj['mrr_currency'] = ApiClient.convertToType(data['mrr_currency'], 'String'); + + delete data['mrr_currency']; + } + if (data.hasOwnProperty('acv_currency')) { + obj['acv_currency'] = ApiClient.convertToType(data['acv_currency'], 'String'); + + delete data['acv_currency']; + } if (data.hasOwnProperty('merge_what_id')) { obj['merge_what_id'] = ApiClient.convertToType(data['merge_what_id'], 'Number'); @@ -741,6 +771,42 @@ DealStrictWithMergeId.prototype['channel'] = undefined; */ DealStrictWithMergeId.prototype['channel_id'] = undefined; +/** + * Only available in Advanced and above plans The Annual Recurring Revenue of the deal Null if there are no products attached to the deal + * @member {Number} arr + */ +DealStrictWithMergeId.prototype['arr'] = undefined; + +/** + * Only available in Advanced and above plans The Monthly Recurring Revenue of the deal Null if there are no products attached to the deal + * @member {Number} mrr + */ +DealStrictWithMergeId.prototype['mrr'] = undefined; + +/** + * Only available in Advanced and above plans The Annual Contract Value of the deal Null if there are no products attached to the deal + * @member {Number} acv + */ +DealStrictWithMergeId.prototype['acv'] = undefined; + +/** + * Only available in Advanced and above plans The Currency for Annual Recurring Revenue of the deal If the `arr` is null, this will also be null + * @member {String} arr_currency + */ +DealStrictWithMergeId.prototype['arr_currency'] = undefined; + +/** + * Only available in Advanced and above plans The Currency for Monthly Recurring Revenue of the deal If the `mrr` is null, this will also be null + * @member {String} mrr_currency + */ +DealStrictWithMergeId.prototype['mrr_currency'] = undefined; + +/** + * Only available in Advanced and above plans The Currency for Annual Contract Value of the deal If the `acv` is null, this will also be null + * @member {String} acv_currency + */ +DealStrictWithMergeId.prototype['acv_currency'] = undefined; + /** * The deal ID of the deal which the original deal was merged with * @member {Number} merge_what_id @@ -1054,6 +1120,36 @@ DealStrict.prototype['channel'] = undefined; * @member {String} channel_id */ DealStrict.prototype['channel_id'] = undefined; +/** + * Only available in Advanced and above plans The Annual Recurring Revenue of the deal Null if there are no products attached to the deal + * @member {Number} arr + */ +DealStrict.prototype['arr'] = undefined; +/** + * Only available in Advanced and above plans The Monthly Recurring Revenue of the deal Null if there are no products attached to the deal + * @member {Number} mrr + */ +DealStrict.prototype['mrr'] = undefined; +/** + * Only available in Advanced and above plans The Annual Contract Value of the deal Null if there are no products attached to the deal + * @member {Number} acv + */ +DealStrict.prototype['acv'] = undefined; +/** + * Only available in Advanced and above plans The Currency for Annual Recurring Revenue of the deal If the `arr` is null, this will also be null + * @member {String} arr_currency + */ +DealStrict.prototype['arr_currency'] = undefined; +/** + * Only available in Advanced and above plans The Currency for Monthly Recurring Revenue of the deal If the `mrr` is null, this will also be null + * @member {String} mrr_currency + */ +DealStrict.prototype['mrr_currency'] = undefined; +/** + * Only available in Advanced and above plans The Currency for Annual Contract Value of the deal If the `acv` is null, this will also be null + * @member {String} acv_currency + */ +DealStrict.prototype['acv_currency'] = undefined; // Implement DealStrictWithMergeIdAllOf interface: /** * The deal ID of the deal which the original deal was merged with diff --git a/src/model/NewDeal.js b/src/model/NewDeal.js index 25fc96a8..80854daf 100644 --- a/src/model/NewDeal.js +++ b/src/model/NewDeal.js @@ -255,7 +255,7 @@ NewDeal.prototype['channel'] = undefined; NewDeal.prototype['channel_id'] = undefined; /** - * The optional creation date & time of the deal in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS + * The optional creation date & time of the deal in UTC. Format: YYYY-MM-DD HH:MM:SS * @member {String} add_time */ NewDeal.prototype['add_time'] = undefined; @@ -371,7 +371,7 @@ NewDealParameters.prototype['channel'] = undefined; */ NewDealParameters.prototype['channel_id'] = undefined; /** - * The optional creation date & time of the deal in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS + * The optional creation date & time of the deal in UTC. Format: YYYY-MM-DD HH:MM:SS * @member {String} add_time */ NewDealParameters.prototype['add_time'] = undefined; diff --git a/src/model/NewDealParameters.js b/src/model/NewDealParameters.js index a32807f8..02e0adc0 100644 --- a/src/model/NewDealParameters.js +++ b/src/model/NewDealParameters.js @@ -197,7 +197,7 @@ NewDealParameters.prototype['channel'] = undefined; NewDealParameters.prototype['channel_id'] = undefined; /** - * The optional creation date & time of the deal in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS + * The optional creation date & time of the deal in UTC. Format: YYYY-MM-DD HH:MM:SS * @member {String} add_time */ NewDealParameters.prototype['add_time'] = undefined; diff --git a/src/model/NewOrganization.js b/src/model/NewOrganization.js index ab9420fa..b8de795e 100644 --- a/src/model/NewOrganization.js +++ b/src/model/NewOrganization.js @@ -100,7 +100,7 @@ class NewOrganization { NewOrganization.prototype['name'] = undefined; /** - * The optional creation date & time of the organization in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS + * The optional creation date & time of the organization in UTC. Format: YYYY-MM-DD HH:MM:SS * @member {String} add_time */ NewOrganization.prototype['add_time'] = undefined; @@ -131,7 +131,7 @@ NewOrganization.prototype['visible_to'] = undefined; */ NewOrganizationAllOf.prototype['name'] = undefined; /** - * The optional creation date & time of the organization in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS + * The optional creation date & time of the organization in UTC. Format: YYYY-MM-DD HH:MM:SS * @member {String} add_time */ NewOrganizationAllOf.prototype['add_time'] = undefined; diff --git a/src/model/NewOrganizationAllOf.js b/src/model/NewOrganizationAllOf.js index e9a7692f..1fa5fa21 100644 --- a/src/model/NewOrganizationAllOf.js +++ b/src/model/NewOrganizationAllOf.js @@ -78,7 +78,7 @@ class NewOrganizationAllOf { NewOrganizationAllOf.prototype['name'] = undefined; /** - * The optional creation date & time of the organization in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS + * The optional creation date & time of the organization in UTC. Format: YYYY-MM-DD HH:MM:SS * @member {String} add_time */ NewOrganizationAllOf.prototype['add_time'] = undefined; diff --git a/src/model/NewPerson.js b/src/model/NewPerson.js index 4929db53..87adbaec 100644 --- a/src/model/NewPerson.js +++ b/src/model/NewPerson.js @@ -165,7 +165,7 @@ NewPerson.prototype['visible_to'] = undefined; NewPerson.prototype['marketing_status'] = undefined; /** - * The optional creation date & time of the person in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS + * The optional creation date & time of the person in UTC. Format: YYYY-MM-DD HH:MM:SS * @member {String} add_time */ NewPerson.prototype['add_time'] = undefined; @@ -214,7 +214,7 @@ BasicPerson.prototype['visible_to'] = undefined; */ BasicPerson.prototype['marketing_status'] = undefined; /** - * The optional creation date & time of the person in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS + * The optional creation date & time of the person in UTC. Format: YYYY-MM-DD HH:MM:SS * @member {String} add_time */ BasicPerson.prototype['add_time'] = undefined; diff --git a/src/model/Note.js b/src/model/Note.js index dc679582..24a69d12 100644 --- a/src/model/Note.js +++ b/src/model/Note.js @@ -161,7 +161,7 @@ Note.prototype['org_id'] = undefined; Note.prototype['user_id'] = undefined; /** - * The optional creation date & time of the note in UTC. Can be set in the past or in the future. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS + * The optional creation date & time of the note in UTC. Can be set in the past or in the future. Format: YYYY-MM-DD HH:MM:SS * @member {String} add_time */ Note.prototype['add_time'] = undefined; @@ -225,7 +225,7 @@ NoteConnectToParams.prototype['org_id'] = undefined; */ NoteParams.prototype['user_id'] = undefined; /** - * The optional creation date & time of the note in UTC. Can be set in the past or in the future. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS + * The optional creation date & time of the note in UTC. Can be set in the past or in the future. Format: YYYY-MM-DD HH:MM:SS * @member {String} add_time */ NoteParams.prototype['add_time'] = undefined; diff --git a/src/model/NoteParams.js b/src/model/NoteParams.js index 3ddda9c3..d403f2d8 100644 --- a/src/model/NoteParams.js +++ b/src/model/NoteParams.js @@ -97,7 +97,7 @@ class NoteParams { NoteParams.prototype['user_id'] = undefined; /** - * The optional creation date & time of the note in UTC. Can be set in the past or in the future. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS + * The optional creation date & time of the note in UTC. Can be set in the past or in the future. Format: YYYY-MM-DD HH:MM:SS * @member {String} add_time */ NoteParams.prototype['add_time'] = undefined; diff --git a/src/model/UpdatePerson.js b/src/model/UpdatePerson.js index 3defa25f..8767a773 100644 --- a/src/model/UpdatePerson.js +++ b/src/model/UpdatePerson.js @@ -163,7 +163,7 @@ UpdatePerson.prototype['visible_to'] = undefined; UpdatePerson.prototype['marketing_status'] = undefined; /** - * The optional creation date & time of the person in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS + * The optional creation date & time of the person in UTC. Format: YYYY-MM-DD HH:MM:SS * @member {String} add_time */ UpdatePerson.prototype['add_time'] = undefined; @@ -212,7 +212,7 @@ BasicPerson.prototype['visible_to'] = undefined; */ BasicPerson.prototype['marketing_status'] = undefined; /** - * The optional creation date & time of the person in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS + * The optional creation date & time of the person in UTC. Format: YYYY-MM-DD HH:MM:SS * @member {String} add_time */ BasicPerson.prototype['add_time'] = undefined; From a96660776167d8d6059afdd13936edea72064c69 Mon Sep 17 00:00:00 2001 From: jenkins User Date: Fri, 7 Jun 2024 10:01:02 +0000 Subject: [PATCH 2/2] 22.10.0 --- CHANGELOG.md | 5 ++++- package-lock.json | 4 ++-- package.json | 2 +- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index df8ca437..a9d96f2f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,8 @@ 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] + +## [22.10.0] - 2024-06-07 ### Added Added `acv`, `mrr`, `arr`, `acv_currency`, `mrr_currency`, and `arr_currency` to the BaseDeal entity and the following endpoints' response: - `GET`, `POST` `/v1/deals` @@ -636,7 +638,8 @@ structure * Fixed `GET /goal/:id/results` error handling in case when there are no existing stages connected to specified goal * Fixed typo in lead example response (`crrency` to `currency`) -[Unreleased]: https://github.com/pipedrive/api-docs/compare/v22.9.0...HEAD +[Unreleased]: https://github.com/pipedrive/api-docs/compare/v22.10.0...HEAD +[22.10.0]: https://github.com/pipedrive/api-docs/compare/v22.9.0...v22.10.0 [22.9.0]: https://github.com/pipedrive/api-docs/compare/v22.8.2...v22.9.0 [22.8.2]: https://github.com/pipedrive/api-docs/compare/v22.8.1...v22.8.2 [22.8.1]: https://github.com/pipedrive/api-docs/compare/v22.8.0...v22.8.1 diff --git a/package-lock.json b/package-lock.json index 545ca135..54a96b43 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "pipedrive", - "version": "22.9.0", + "version": "22.10.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "pipedrive", - "version": "22.9.0", + "version": "22.10.0", "license": "MIT", "dependencies": { "@babel/runtime": "^7.20.1", diff --git a/package.json b/package.json index 125929c0..f6c50540 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "pipedrive", - "version": "22.9.0", + "version": "22.10.0", "description": "Pipedrive REST client for NodeJS", "license": "MIT", "main": "dist/index.js",