Build 265 - version-minor

CHANGELOG.md

@@ -7,6 +7,12 @@ 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
+- Add documentation for product images functionality:
+  - `GET` `/api/v2/products/{id}/images` endpoint
+  - `POST` `/api/v2/products/{id}/images` endpoint
+  - `PUT` `/api/v2/products/{id}/images` endpoint
+  - `DELETE` `/api/v2/products/{id}/images` endpoint
 
 ## [29.0.0] - 2025-09-03
 ### Removed

docs/v2.md

@@ -12,11 +12,15 @@ ActivitiesApi | updateActivity | **PATCH** /activities/{id} | Update an activity
 BetaApi | convertDealToLead | **POST** /deals/{id}/convert/lead | Convert a deal to a lead (BETA)
 BetaApi | convertLeadToDeal | **POST** /leads/{id}/convert/deal | Convert a lead to a deal (BETA)
 BetaApi | deleteInstallment | **DELETE** /deals/{id}/installments/{installment_id} | Delete an installment from a deal
+BetaApi | deleteProductImage | **DELETE** /products/{id}/images | Delete an image of a product
 BetaApi | getDealConversionStatus | **GET** /deals/{id}/convert/status/{conversion_id} | Get Deal conversion status (BETA)
 BetaApi | getInstallments | **GET** /deals/installments | List installments added to a list of deals
 BetaApi | getLeadConversionStatus | **GET** /leads/{id}/convert/status/{conversion_id} | Get Lead conversion status (BETA)
+BetaApi | getProductImage | **GET** /products/{id}/images | Get image of a product
 BetaApi | postInstallment | **POST** /deals/{id}/installments | Add an installment to a deal
 BetaApi | updateInstallment | **PATCH** /deals/{id}/installments/{installment_id} | Update an installment added to a deal
+BetaApi | updateProductImage | **PUT** /products/{id}/images | Update an image for a product
+BetaApi | uploadProductImage | **POST** /products/{id}/images | Upload an image for a product
 DealsApi | addDeal | **POST** /deals | Add a new deal
 DealsApi | addDealFollower | **POST** /deals/{id}/followers | Add a follower to a deal
 DealsApi | addDealProduct | **POST** /deals/{id}/products | Add a product to a deal
@@ -78,15 +82,19 @@ ProductsApi | addProductFollower | **POST** /products/{id}/followers | Add a fol
 ProductsApi | addProductVariation | **POST** /products/{id}/variations | Add a product variation
 ProductsApi | deleteProduct | **DELETE** /products/{id} | Delete a product
 ProductsApi | deleteProductFollower | **DELETE** /products/{id}/followers/{follower_id} | Delete a follower from a product
+ProductsApi | deleteProductImage | **DELETE** /products/{id}/images | Delete an image of a product
 ProductsApi | deleteProductVariation | **DELETE** /products/{id}/variations/{product_variation_id} | Delete a product variation
 ProductsApi | getProduct | **GET** /products/{id} | Get one product
 ProductsApi | getProductFollowers | **GET** /products/{id}/followers | List followers of a product
 ProductsApi | getProductFollowersChangelog | **GET** /products/{id}/followers/changelog | List followers changelog of a product
+ProductsApi | getProductImage | **GET** /products/{id}/images | Get image of a product
 ProductsApi | getProductVariations | **GET** /products/{id}/variations | Get all product variations
 ProductsApi | getProducts | **GET** /products | Get all products
 ProductsApi | searchProducts | **GET** /products/search | Search products
 ProductsApi | updateProduct | **PATCH** /products/{id} | Update a product
+ProductsApi | updateProductImage | **PUT** /products/{id}/images | Update an image for a product
 ProductsApi | updateProductVariation | **PATCH** /products/{id}/variations/{product_variation_id} | Update a product variation
+ProductsApi | uploadProductImage | **POST** /products/{id}/images | Upload an image for a product
 StagesApi | addStage | **POST** /stages | Add a new stage
 StagesApi | deleteStage | **DELETE** /stages/{id} | Delete a stage
 StagesApi | getStage | **GET** /stages/{id} | Get one stage

src/versions/v1/models/add-deal-product-request-all-of.ts

@@ -21,7 +21,7 @@
 */
 export interface AddDealProductRequestAllOf {
     /**
-    * Only available in Advanced and above plans  How often a customer is billed for access to a service or product  To set `billing_frequency` different than `one-time`, the deal must not have installments associated  A deal can have up to 20 products attached with `billing_frequency` different than `one-time` 
+    * Only available in Growth and above plans  How often a customer is billed for access to a service or product  To set `billing_frequency` different than `one-time`, the deal must not have installments associated  A deal can have up to 20 products attached with `billing_frequency` different than `one-time` 
     * @type {string}
     */
     'billing_frequency'?: AddDealProductRequestAllOfBillingFrequencyConst;

src/versions/v1/models/add-deal-product-request-all-of1.ts

@@ -21,7 +21,7 @@
 */
 export interface AddDealProductRequestAllOf1 {
     /**
-    * 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 
+    * Only available in Growth 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 
     * @type {number}
     */
     'billing_frequency_cycles'?: number | null;

src/versions/v1/models/add-deal-product-request-all-of2.ts

@@ -21,7 +21,7 @@
 */
 export interface AddDealProductRequestAllOf2 {
     /**
-    * 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 
+    * Only available in Growth and above plans  The billing start date. Must be between 10 years in the past and 10 years in the future 
     * @type {string}
     */
     'billing_start_date'?: string | null;

src/versions/v1/models/add-or-update-role-setting-request.ts

@@ -26,7 +26,7 @@ export interface AddOrUpdateRoleSettingRequest {
     */
     'setting_key': AddOrUpdateRoleSettingRequestSettingKeyConst;
     /**
-    * Possible values for the `default_visibility` setting depending on the subscription plan:<br> <table class=\'role-setting\'> <caption><b>Essential / Advanced plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner & Followers</td></tr> <tr><td>`3`</td><td>Entire company</td></tr> </table> <br> <table class=\'role-setting\'> <caption><b>Professional / Enterprise plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner only</td></tr> <tr><td>`3`</td><td>Owner&#39;s visibility group</td></tr> <tr><td>`5`</td><td>Owner&#39;s visibility group and sub-groups</td></tr> <tr><td>`7`</td><td>Entire company</td></tr> </table> <br> Read more about visibility groups <a href=\'https://support.pipedrive.com/en/article/visibility-groups\'>here</a>.
+    * Possible values for the `default_visibility` setting depending on the subscription plan:<br> <table class=\'role-setting\'> <caption><b>Light / Growth and Professional plans</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner & Followers</td></tr> <tr><td>`3`</td><td>Entire company</td></tr> </table> <br> <table class=\'role-setting\'> <caption><b>Premium / Ultimate plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner only</td></tr> <tr><td>`3`</td><td>Owner&#39;s visibility group</td></tr> <tr><td>`5`</td><td>Owner&#39;s visibility group and sub-groups</td></tr> <tr><td>`7`</td><td>Entire company</td></tr> </table> <br> Read more about visibility groups <a href=\'https://support.pipedrive.com/en/article/visibility-groups\'>here</a>.
     * @type {number}
     */
     'value': AddOrUpdateRoleSettingRequestValueConst;

src/versions/v1/models/add-product-request-all-of1.ts

@@ -21,7 +21,7 @@
 */
 export interface AddProductRequestAllOf1 {
     /**
-    * Only available in Advanced and above plans  How often a customer is billed for access to a service or product 
+    * Only available in Growth and above plans  How often a customer is billed for access to a service or product 
     * @type {string}
     */
     'billing_frequency'?: AddProductRequestAllOf1BillingFrequencyConst;

src/versions/v1/models/add-product-request-all-of2.ts

@@ -21,7 +21,7 @@
 */
 export interface AddProductRequestAllOf2 {
     /**
-    * 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 
+    * Only available in Growth 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 
     * @type {number}
     */
     'billing_frequency_cycles'?: number | null;

src/versions/v1/models/base-deal.ts

@@ -306,32 +306,32 @@ export interface BaseDeal {
     */
     'channel_id'?: string | null;
     /**
-    * Only available in Advanced and above plans  The Annual Recurring Revenue of the deal  Null if there are no products attached to the deal 
+    * Only available in Growth and above plans  The Annual Recurring Revenue of the deal  Null if there are no products attached to the deal 
     * @type {number}
     */
     'arr'?: number | null;
     /**
-    * Only available in Advanced and above plans  The Monthly Recurring Revenue of the deal  Null if there are no products attached to the deal 
+    * Only available in Growth and above plans  The Monthly Recurring Revenue of the deal  Null if there are no products attached to the deal 
     * @type {number}
     */
     'mrr'?: number | null;
     /**
-    * Only available in Advanced and above plans  The Annual Contract Value of the deal  Null if there are no products attached to the deal 
+    * Only available in Growth and above plans  The Annual Contract Value of the deal  Null if there are no products attached to the deal 
     * @type {number}
     */
     'acv'?: number | null;
     /**
-    * 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 
+    * Only available in Growth and above plans  The Currency for Annual Recurring Revenue of the deal  If the `arr` is null, this will also be null 
     * @type {string}
     */
     'arr_currency'?: string | null;
     /**
-    * 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 
+    * Only available in Growth and above plans  The Currency for Monthly Recurring Revenue of the deal  If the `mrr` is null, this will also be null 
     * @type {string}
     */
     'mrr_currency'?: string | null;
     /**
-    * 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 
+    * Only available in Growth and above plans  The Currency for Annual Contract Value of the deal  If the `acv` is null, this will also be null 
     * @type {string}
     */
     'acv_currency'?: string | null;

src/versions/v1/models/base-product.ts

@@ -66,12 +66,12 @@ export interface BaseProduct {
     */
     'owner_id'?: object;
     /**
-    * Only available in Advanced and above plans  How often a customer is billed for access to a service or product 
+    * Only available in Growth and above plans  How often a customer is billed for access to a service or product 
     * @type {string}
     */
     'billing_frequency'?: BaseProductBillingFrequencyConst;
     /**
-    * 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 
+    * Only available in Growth 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 
     * @type {number}
     */
     'billing_frequency_cycles'?: number | null;

src/versions/v1/models/update-deal-product-request-all-of.ts

@@ -21,7 +21,7 @@
 */
 export interface UpdateDealProductRequestAllOf {
     /**
-    * Only available in Advanced and above plans  How often a customer is billed for access to a service or product  To set `billing_frequency` different than `one-time`, the deal must not have installments associated  A deal can have up to 20 products attached with `billing_frequency` different than `one-time` 
+    * Only available in Growth and above plans  How often a customer is billed for access to a service or product  To set `billing_frequency` different than `one-time`, the deal must not have installments associated  A deal can have up to 20 products attached with `billing_frequency` different than `one-time` 
     * @type {string}
     */
     'billing_frequency'?: UpdateDealProductRequestAllOfBillingFrequencyConst;

src/versions/v1/models/update-product-request-all-of1.ts

@@ -21,7 +21,7 @@
 */
 export interface UpdateProductRequestAllOf1 {
     /**
-    * Only available in Advanced and above plans  How often a customer is billed for access to a service or product 
+    * Only available in Growth and above plans  How often a customer is billed for access to a service or product 
     * @type {string}
     */
     'billing_frequency'?: UpdateProductRequestAllOf1BillingFrequencyConst;