Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
### Changed
- Reduce maximum `limit` query param to 100 for the following endpoints
- GET v1/files
- GET v1/deals/{id}/files
- GET v1/organizations/{id}/files
- GET v1/persons/{id}/files
- GET /v1/products/{id}/files

## [23.4.3] - 2024-11-22
### Added
Expand Down
1,726 changes: 854 additions & 872 deletions README.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/AddProductAttachmentDetails.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Name | Type | Description | Notes
**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. By default, the user setting value for tax options will be used. Changing this in one product affects the rest of the products attached to the deal | [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]
**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]
**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` When `billing_frequency` is set to `weekly`, this field cannot 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 208 | [optional]
**billing_start_date** | **String** | Only available in Advanced and above plans The billing start date. Must be between 10 years in the past and 10 years in the future | [optional]
**id** | **Number** | The ID of the deal-product (the ID of the product attached to the deal) | [optional]
**company_id** | **Number** | The ID of the company | [optional]
**deal_id** | **Number** | The ID of the deal | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/AddProductRequestBody.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ Name | Type | Description | Notes
**owner_id** | **Number** | The ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used | [optional]
**prices** | **[Object]** | An array of objects, each containing: `currency` (string), `price` (number), `cost` (number, optional), `overhead_cost` (number, optional), `notes` (string, optional). Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and a default currency based on the company's currency will be assigned. | [optional]
**billing_frequency** | [**BillingFrequency1**](BillingFrequency1.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_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 208 | [optional]


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

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**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 208 | [optional]


2 changes: 1 addition & 1 deletion docs/AddWebhookRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Name | Type | Description | Notes
**user_id** | **Number** | The ID of the user that this webhook will be authorized with. You have the option to use a different user's `user_id`. If it is not set, the current user's `user_id` will be used. As each webhook event is checked against a user's permissions, the webhook will only be sent if the user has access to the specified object(s). If you want to receive notifications for all events, please use a top-level admin user’s `user_id`. | [optional]
**http_auth_user** | **String** | The HTTP basic auth username of the subscription URL endpoint (if required) | [optional]
**http_auth_password** | **String** | The HTTP basic auth password of the subscription URL endpoint (if required) | [optional]
**version** | **String** | The webhook's version | [optional] [default to '1.0']
**version** | **String** | The webhook's version. NB! Webhooks v2 will become the default from March 17th, 2025. See <a href=\"https://developers.pipedrive.com/changelog/post/breaking-change-webhooks-v2-will-become-the-new-default-version\" target=\"_blank\" rel=\"noopener noreferrer\">this Changelog post</a> for more details. | [optional] [default to '1.0']



Expand Down
2 changes: 1 addition & 1 deletion docs/BaseProduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Name | Type | Description | Notes
**visible_to** | [**VisibleTo**](VisibleTo.md) | Visibility of the product | [optional]
**owner_id** | **Object** | Information about the Pipedrive user who owns the product | [optional]
**billing_frequency** | **String** | Only available in Advanced and above plans How often a customer is billed for access to a service or product | [optional] [default to 'one-time']
**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 is always `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_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 is always `null` When `billing_frequency` is set to `weekly`, this field cannot 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 208 | [optional]



Expand Down
4 changes: 2 additions & 2 deletions docs/BasicDealProduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Name | Type | Description | Notes
**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. By default, the user setting value for tax options will be used. Changing this in one product affects the rest of the products attached to the deal | [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]
**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]
**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` When `billing_frequency` is set to `weekly`, this field cannot 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 208 | [optional]
**billing_start_date** | **String** | Only available in Advanced and above plans The billing start date. Must be between 10 years in the past and 10 years in the future | [optional]



Expand Down
8 changes: 4 additions & 4 deletions docs/DealsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -791,8 +791,8 @@ let id = 56; // Number | The ID of the deal
// snake_case as well as camelCase is supported for naming opts properties
let opts = {
'start': 0, // Number | Pagination start
'limit': 56, // Number | Items shown per page
'sort': "sort_example" // String | The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `product_id`, `add_time`, `update_time`, `file_name`, `file_type`, `file_size`, `comment`.
'limit': 56, // Number | Items shown per page. Please note that a maximum value of 100 is allowed.
'sort': "sort_example" // String | Supported fields: `id`, `update_time`
};
apiInstance.getDealFiles(id, opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
Expand All @@ -809,8 +809,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **Number**| The ID of the deal |
**start** | **Number**| Pagination start | [optional] [default to 0]
**limit** | **Number**| Items shown per page | [optional]
**sort** | **String**| The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `product_id`, `add_time`, `update_time`, `file_name`, `file_type`, `file_size`, `comment`. | [optional]
**limit** | **Number**| Items shown per page. Please note that a maximum value of 100 is allowed. | [optional]
**sort** | **String**| Supported fields: `id`, `update_time` | [optional]

### Return type

Expand Down
8 changes: 4 additions & 4 deletions docs/FilesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -329,8 +329,8 @@ let apiInstance = new Pipedrive.FilesApi(apiClient);
// snake_case as well as camelCase is supported for naming opts properties
let opts = {
'start': 0, // Number | Pagination start
'limit': 56, // Number | Items shown per page
'sort': "sort_example" // String | The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `product_id`, `add_time`, `update_time`, `file_name`, `file_type`, `file_size`, `comment`.
'limit': 56, // Number | Items shown per page. Please note that a maximum value of 100 is allowed.
'sort': "sort_example" // String | Supported fields: `id`, `update_time`
};
apiInstance.getFiles(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
Expand All @@ -346,8 +346,8 @@ apiInstance.getFiles(opts).then((data) => {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**start** | **Number**| Pagination start | [optional] [default to 0]
**limit** | **Number**| Items shown per page | [optional]
**sort** | **String**| The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `product_id`, `add_time`, `update_time`, `file_name`, `file_type`, `file_size`, `comment`. | [optional]
**limit** | **Number**| Items shown per page. Please note that a maximum value of 100 is allowed. | [optional]
**sort** | **String**| Supported fields: `id`, `update_time` | [optional]

### Return type

Expand Down
4 changes: 2 additions & 2 deletions docs/NewDealProduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Name | Type | Description | Notes
**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 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]
**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` When `billing_frequency` is set to `weekly`, this field cannot 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 208 | [optional]
**billing_start_date** | **String** | Only available in Advanced and above plans The billing start date. Must be between 10 years in the past and 10 years in the future | [optional]



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

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**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_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` When `billing_frequency` is set to `weekly`, this field cannot 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 208 | [optional]


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

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**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]
**billing_start_date** | **String** | Only available in Advanced and above plans The billing start date. Must be between 10 years in the past and 10 years in the future | [optional]


Loading
Loading