Skip to content

Commit

Permalink
Release v23.3.0 from PR #572
Browse files Browse the repository at this point in the history
  • Loading branch information
jenkins User committed Sep 23, 2024
2 parents 184bc95 + 2555843 commit ea4bfaa
Show file tree
Hide file tree
Showing 39 changed files with 1,921 additions and 59 deletions.
13 changes: 12 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,16 @@ For public Changelog covering all changes done to Pipedrive’s API, webhooks an

## [Unreleased]

## [23.3.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.2.6] - 2024-09-06
### Fixed
- Deleted unused file with long name
Expand Down Expand Up @@ -681,7 +691,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/v23.2.5...HEAD
[Unreleased]: https://github.com/pipedrive/api-docs/compare/v23.3.0...HEAD
[23.3.0]: https://github.com/pipedrive/api-docs/compare/v23.2.5...v23.3.0
[23.2.5]: https://github.com/pipedrive/api-docs/compare/v23.2.4...v23.2.5
[23.2.4]: https://github.com/pipedrive/api-docs/compare/v23.2.3...v23.2.4
[23.2.3]: https://github.com/pipedrive/api-docs/compare/v23.2.2...v23.2.3
Expand Down
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -973,6 +973,8 @@ Class | Method | HTTP request | Description
- [Pipedrive.GetDealsTimelineData](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetDealsTimelineData.md)
- [Pipedrive.GetDealsTimelineDataTotals](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetDealsTimelineDataTotals.md)
- [Pipedrive.GetDuplicatedDeal](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetDuplicatedDeal.md)
- [Pipedrive.GetField](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetField.md)
- [Pipedrive.GetFieldAllOf](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetFieldAllOf.md)
- [Pipedrive.GetGoalResultResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetGoalResultResponse.md)
- [Pipedrive.GetGoalsResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetGoalsResponse.md)
- [Pipedrive.GetLeadIdResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetLeadIdResponse.md)
Expand All @@ -983,6 +985,7 @@ Class | Method | HTTP request | Description
- [Pipedrive.GetLeadsSourceResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetLeadsSourceResponse.md)
- [Pipedrive.GetLeadsSourceResponseData](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetLeadsSourceResponseData.md)
- [Pipedrive.GetMergedDeal](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetMergedDeal.md)
- [Pipedrive.GetNoteField](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetNoteField.md)
- [Pipedrive.GetNotes](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetNotes.md)
- [Pipedrive.GetOneFile](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetOneFile.md)
- [Pipedrive.GetOnePipeline](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetOnePipeline.md)
Expand All @@ -992,6 +995,7 @@ Class | Method | HTTP request | Description
- [Pipedrive.GetPersonDetailsResponseAllOf](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetPersonDetailsResponseAllOf.md)
- [Pipedrive.GetPersonDetailsResponseAllOfAdditionalData](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetPersonDetailsResponseAllOfAdditionalData.md)
- [Pipedrive.GetProductAttachmentDetails](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetProductAttachmentDetails.md)
- [Pipedrive.GetProductField](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetProductField.md)
- [Pipedrive.GetProductFieldResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetProductFieldResponse.md)
- [Pipedrive.GetProjectBoardResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetProjectBoardResponse.md)
- [Pipedrive.GetProjectBoardsResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetProjectBoardsResponse.md)
Expand Down Expand Up @@ -1038,6 +1042,7 @@ Class | Method | HTTP request | Description
- [Pipedrive.InlineResponse403AdditionalData](https://github.com/pipedrive/client-nodejs/blob/master/docs/InlineResponse403AdditionalData.md)
- [Pipedrive.InlineResponse404](https://github.com/pipedrive/client-nodejs/blob/master/docs/InlineResponse404.md)
- [Pipedrive.InlineResponse404AdditionalData](https://github.com/pipedrive/client-nodejs/blob/master/docs/InlineResponse404AdditionalData.md)
- [Pipedrive.InternalFieldType](https://github.com/pipedrive/client-nodejs/blob/master/docs/InternalFieldType.md)
- [Pipedrive.ItemSearchAdditionalData](https://github.com/pipedrive/client-nodejs/blob/master/docs/ItemSearchAdditionalData.md)
- [Pipedrive.ItemSearchAdditionalDataPagination](https://github.com/pipedrive/client-nodejs/blob/master/docs/ItemSearchAdditionalDataPagination.md)
- [Pipedrive.ItemSearchFieldResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/ItemSearchFieldResponse.md)
Expand Down Expand Up @@ -1368,7 +1373,7 @@ Class | Method | HTTP request | Description
- [Pipedrive.TemplateObject](https://github.com/pipedrive/client-nodejs/blob/master/docs/TemplateObject.md)
- [Pipedrive.TemplateResponseObject](https://github.com/pipedrive/client-nodejs/blob/master/docs/TemplateResponseObject.md)
- [Pipedrive.Unauthorized](https://github.com/pipedrive/client-nodejs/blob/master/docs/Unauthorized.md)
- [Pipedrive.UpdateActivityPlanItem](https://github.com/pipedrive/client-nodejs/blob/master/docs/UpdateActivityPlanItem.md)
- [Pipedrive.UpdateActivityPlanItemResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/UpdateActivityPlanItemResponse.md)
- [Pipedrive.UpdateActivityResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/UpdateActivityResponse.md)
- [Pipedrive.UpdateDealParameters](https://github.com/pipedrive/client-nodejs/blob/master/docs/UpdateDealParameters.md)
- [Pipedrive.UpdateDealProduct](https://github.com/pipedrive/client-nodejs/blob/master/docs/UpdateDealProduct.md)
Expand All @@ -1388,7 +1393,7 @@ Class | Method | HTTP request | Description
- [Pipedrive.UpdateProjectResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/UpdateProjectResponse.md)
- [Pipedrive.UpdateStageRequest](https://github.com/pipedrive/client-nodejs/blob/master/docs/UpdateStageRequest.md)
- [Pipedrive.UpdateStageRequestAllOf](https://github.com/pipedrive/client-nodejs/blob/master/docs/UpdateStageRequestAllOf.md)
- [Pipedrive.UpdateTaskPlanItem](https://github.com/pipedrive/client-nodejs/blob/master/docs/UpdateTaskPlanItem.md)
- [Pipedrive.UpdateTaskPlanItemResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/UpdateTaskPlanItemResponse.md)
- [Pipedrive.UpdateTaskResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/UpdateTaskResponse.md)
- [Pipedrive.UpdateTeam](https://github.com/pipedrive/client-nodejs/blob/master/docs/UpdateTeam.md)
- [Pipedrive.UpdateTeamAllOf](https://github.com/pipedrive/client-nodejs/blob/master/docs/UpdateTeamAllOf.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/DealProductRequestBody.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Name | Type | Description | Notes
**comments** | **String** | A textual comment associated with this product-deal attachment | [optional]
**tax** | **Number** | The tax percentage | [optional] [default to 0]
**tax_method** | **String** | The tax option to be applied to the products. When using `inclusive`, the tax percentage will already be included in the price. When using `exclusive`, the tax will not be included in the price. When using `none`, no tax will be added. Use the `tax` field for defining the tax percentage amount | [optional]
**enabled_flag** | **Boolean** | Whether the product is enabled for a deal or not. This makes it possible to add products to a deal with a specific price and discount criteria, but keep them disabled, which refrains them from being included in the deal value calculation. When omitted, the product will be marked as enabled by default | [optional] [default to true]
**enabled_flag** | **Boolean** | Whether the product is enabled for a deal or not This makes it possible to add products to a deal with a specific price and discount criteria, but keep them disabled, which refrains them from being included in the deal value calculation. When omitted, the product will be marked as enabled by default Not possible to disable the product if the deal has installments associated and the product is the last one enabled Not possible to enable the product if the deal has installments associated and the product is recurring | [optional] [default to true]



Expand Down
2 changes: 1 addition & 1 deletion docs/DealsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,7 @@ Name | Type | Description | Notes
Delete an attached product from a deal

Deletes a product attachment from a deal, using the `product_attachment_id`.
Deletes a product attachment from a deal, using the `product_attachment_id` Not possible to delete the attached product if the deal has installments associated and the product is the last one enabled

### Example

Expand Down
2 changes: 1 addition & 1 deletion docs/FieldsResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**success** | **Boolean** | If the response is successful or not | [optional]
**data** | [**[Field]**](Field.md) | | [optional]
**data** | [**[GetField]**](GetField.md) | | [optional]
**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional]


2 changes: 1 addition & 1 deletion docs/FieldsResponseAllOf.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**[Field]**](Field.md) | | [optional]
**data** | [**[GetField]**](GetField.md) | | [optional]
**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional]


2 changes: 1 addition & 1 deletion docs/GetAllProductFieldsResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**success** | **Boolean** | If the response is successful or not | [optional]
**data** | [**[ProductField]**](ProductField.md) | Array containing data for all product fields | [optional]
**data** | [**[GetProductField]**](GetProductField.md) | Array containing data for all product fields | [optional]
**additional_data** | **Object** | Additional data for the product field, such as pagination | [optional]


32 changes: 32 additions & 0 deletions docs/GetField.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Pipedrive.GetField

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | The ID of the field. Value is `null` in case of subfields. | [optional]
**key** | **String** | The key of the field. For custom fields this is generated upon creation. | [optional]
**name** | **String** | The name of the field | [optional]
**order_nr** | **Number** | The order number of the field | [optional]
**field_type** | [**InternalFieldType**](InternalFieldType.md) | | [optional]
**add_time** | **Date** | The creation time of the field | [optional]
**update_time** | **Date** | The update time of the field | [optional]
**last_updated_by_user_id** | **Number** | The ID of the user who created or most recently updated the field, only applicable for custom fields | [optional]
**created_by_user_id** | **Number** | The ID of the user who created the field | [optional]
**active_flag** | **Boolean** | The active flag of the field | [optional]
**edit_flag** | **Boolean** | The edit flag of the field | [optional]
**index_visible_flag** | **Boolean** | Not used | [optional]
**details_visible_flag** | **Boolean** | Not used | [optional]
**add_visible_flag** | **Boolean** | Not used | [optional]
**important_flag** | **Boolean** | Not used | [optional]
**bulk_edit_allowed** | **Boolean** | Whether or not the field of an item can be edited in bulk | [optional]
**searchable_flag** | **Boolean** | Whether or not items can be searched by this field | [optional]
**filtering_allowed** | **Boolean** | Whether or not items can be filtered by this field | [optional]
**sortable_flag** | **Boolean** | Whether or not items can be sorted by this field | [optional]
**mandatory_flag** | **Boolean** | Whether or not the field is mandatory | [optional]
**options** | **[Object]** | The options of the field. When there are no options, `null` is returned. | [optional]
**options_deleted** | **[Object]** | The deleted options of the field. Only present when there is at least 1 deleted option. | [optional]
**is_subfield** | **Boolean** | Whether or not the field is a subfield of another field. Only present if field is subfield. | [optional]
**subfields** | **[Object]** | The subfields of the field. Only present when the field has subfields. | [optional]


9 changes: 9 additions & 0 deletions docs/GetFieldAllOf.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Pipedrive.GetFieldAllOf

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**field_type** | [**InternalFieldType**](InternalFieldType.md) | | [optional]


17 changes: 17 additions & 0 deletions docs/GetNoteField.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Pipedrive.GetNoteField

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | The ID of the field | [optional]
**key** | **String** | The key of the field | [optional]
**name** | **String** | The name of the field | [optional]
**field_type** | [**InternalFieldType**](InternalFieldType.md) | | [optional]
**active_flag** | **Boolean** | The active flag of the field | [optional]
**edit_flag** | **Boolean** | The edit flag of the field | [optional]
**bulk_edit_allowed** | **Boolean** | Not used | [optional]
**mandatory_flag** | **Boolean** | Whether or not the field is mandatory | [optional]
**options** | [**[NoteFieldOptions]**](NoteFieldOptions.md) | The options of the field. When there are no options, `null` is returned. | [optional]


27 changes: 27 additions & 0 deletions docs/GetProductField.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Pipedrive.GetProductField

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | The name of the field |
**options** | **[Object]** | When `field_type` is either `set` or `enum`, possible options must be supplied as a JSON-encoded sequential array, for example:</br>`[{\"label\":\"red\"}, {\"label\":\"blue\"}, {\"label\":\"lilac\"}]` | [optional]
**field_type** | [**InternalFieldType**](InternalFieldType.md) | |
**id** | **Number** | The ID of the product field | [optional]
**key** | **String** | The key of the product field | [optional]
**order_nr** | **Number** | The position (index) of the product field in the detail view | [optional]
**add_time** | **String** | The product field creation time. Format: YYYY-MM-DD HH:MM:SS | [optional]
**update_time** | **String** | The product field last update time. Format: YYYY-MM-DD HH:MM:SS | [optional]
**last_updated_by_user_id** | **Number** | The ID of the last user to update the product field | [optional]
**created_by_user_id** | **Number** | The ID of the user who created the product field | [optional]
**active_flag** | **Boolean** | Whether or not the product field is currently active | [optional]
**edit_flag** | **Boolean** | Whether or not the product field name and metadata is editable | [optional]
**add_visible_flag** | **Boolean** | Whether or not the product field is visible in the Add Product Modal | [optional]
**important_flag** | **Boolean** | Whether or not the product field is marked as important | [optional]
**bulk_edit_allowed** | **Boolean** | Whether or not the product field data can be edited | [optional]
**searchable_flag** | **Boolean** | Whether or not the product field is searchable | [optional]
**filtering_allowed** | **Boolean** | Whether or not the product field value can be used when filtering searches | [optional]
**sortable_flag** | **Boolean** | Whether or not the product field is sortable | [optional]
**mandatory_flag** | **Boolean** | Whether or not the product field is mandatory when creating products | [optional]


74 changes: 74 additions & 0 deletions docs/InternalFieldType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Pipedrive.InternalFieldType

## Enum


* `boolean` (value: `"boolean"`)

* `double` (value: `"double"`)

* `int` (value: `"int"`)

* `json` (value: `"json"`)

* `date` (value: `"date"`)

* `daterange` (value: `"daterange"`)

* `time` (value: `"time"`)

* `timerange` (value: `"timerange"`)

* `text` (value: `"text"`)

* `varchar` (value: `"varchar"`)

* `varchar_auto` (value: `"varchar_auto"`)

* `varchar_options` (value: `"varchar_options"`)

* `address` (value: `"address"`)

* `enum` (value: `"enum"`)

* `monetary` (value: `"monetary"`)

* `phone` (value: `"phone"`)

* `set` (value: `"set"`)

* `activity` (value: `"activity"`)

* `deal` (value: `"deal"`)

* `lead` (value: `"lead"`)

* `org` (value: `"org"`)

* `people` (value: `"people"`)

* `pipeline` (value: `"pipeline"`)

* `product` (value: `"product"`)

* `project` (value: `"project"`)

* `stage` (value: `"stage"`)

* `user` (value: `"user"`)

* `billing_frequency` (value: `"billing_frequency"`)

* `picture` (value: `"picture"`)

* `price_list` (value: `"price_list"`)

* `projects_board` (value: `"projects_board"`)

* `projects_phase` (value: `"projects_phase"`)

* `status` (value: `"status"`)

* `visible_to` (value: `"visible_to"`)


2 changes: 1 addition & 1 deletion docs/NewDealProduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Name | Type | Description | Notes
**comments** | **String** | A textual comment associated with this product-deal attachment | [optional]
**tax** | **Number** | The tax percentage | [optional] [default to 0]
**tax_method** | **String** | The tax option to be applied to the products. When using `inclusive`, the tax percentage will already be included in the price. When using `exclusive`, the tax will not be included in the price. When using `none`, no tax will be added. Use the `tax` field for defining the tax percentage amount | [optional]
**enabled_flag** | **Boolean** | Whether the product is enabled for a deal or not. This makes it possible to add products to a deal with a specific price and discount criteria, but keep them disabled, which refrains them from being included in the deal value calculation. When omitted, the product will be marked as enabled by default | [optional] [default to true]
**enabled_flag** | **Boolean** | Whether the product is enabled for a deal or not This makes it possible to add products to a deal with a specific price and discount criteria, but keep them disabled, which refrains them from being included in the deal value calculation. When omitted, the product will be marked as enabled by default Not possible to disable the product if the deal has installments associated and the product is the last one enabled Not possible to enable the product if the deal has installments associated and the product is recurring | [optional] [default to true]
**billing_frequency** | [**BillingFrequency**](BillingFrequency.md) | | [optional]
**billing_frequency_cycles** | **Number** | Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field must be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 312 | [optional]
**billing_start_date** | **String** | Only available in Advanced and above plans The billing start date. Must be between 15 years in the past and 15 years in the future | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/NoteFieldsResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**success** | **Boolean** | If the response is successful or not | [optional]
**data** | [**[NoteField]**](NoteField.md) | | [optional]
**data** | [**[GetNoteField]**](GetNoteField.md) | | [optional]
**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional]


Loading

0 comments on commit ea4bfaa

Please sign in to comment.