pipedrive 29.0.0 → 29.2.0

package/dist/esm/versions/v2/api/deals-api.js

@@ -322,7 +322,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Removes an installment from a deal.  Only available in Advanced and above plans.
+         * Removes an installment from a deal.  Only available in Growth and above plans.
          * @summary Delete an installment from a deal
          * @param {number} id The ID of the deal
          * @param {number} installment_id The ID of the installment
@@ -848,7 +848,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Lists installments attached to a list of deals.  Only available in Advanced and above plans.
+         * Lists installments attached to a list of deals.  Only available in Growth and above plans.
          * @summary List installments added to a list of deals
          * @param {Array<number>} deal_ids An array of integers with the IDs of the deals for which the attached installments will be returned. A maximum of 100 deal IDs can be provided.
          * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
@@ -937,7 +937,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Adds an installment to a deal.  An installment can only be added if the deal includes at least one one-time product.  If the deal contains at least one recurring product, adding installments is not allowed.  Only available in Advanced and above plans.
+         * Adds an installment to a deal.  An installment can only be added if the deal includes at least one one-time product.  If the deal contains at least one recurring product, adding installments is not allowed.  Only available in Growth and above plans.
          * @summary Add an installment to a deal
          * @param {number} id The ID of the deal
          * @param {AddInstallmentRequestBody} [AddInstallmentRequestBody]
@@ -1161,7 +1161,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Edits an installment added to a deal.  Only available in Advanced and above plans.
+         * Edits an installment added to a deal.  Only available in Growth and above plans.
          * @summary Update an installment added to a deal
          * @param {number} id The ID of the deal
          * @param {number} installment_id The ID of the installment
@@ -1320,7 +1320,7 @@ export const DealsApiFp = function (configuration) {
             });
         },
         /**
-         * Removes an installment from a deal.  Only available in Advanced and above plans.
+         * Removes an installment from a deal.  Only available in Growth and above plans.
          * @summary Delete an installment from a deal
          * @param {number} id The ID of the deal
          * @param {number} installment_id The ID of the installment
@@ -1496,7 +1496,7 @@ export const DealsApiFp = function (configuration) {
             });
         },
         /**
-         * Lists installments attached to a list of deals.  Only available in Advanced and above plans.
+         * Lists installments attached to a list of deals.  Only available in Growth and above plans.
          * @summary List installments added to a list of deals
          * @param {Array<number>} deal_ids An array of integers with the IDs of the deals for which the attached installments will be returned. A maximum of 100 deal IDs can be provided.
          * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
@@ -1527,7 +1527,7 @@ export const DealsApiFp = function (configuration) {
             });
         },
         /**
-         * Adds an installment to a deal.  An installment can only be added if the deal includes at least one one-time product.  If the deal contains at least one recurring product, adding installments is not allowed.  Only available in Advanced and above plans.
+         * Adds an installment to a deal.  An installment can only be added if the deal includes at least one one-time product.  If the deal contains at least one recurring product, adding installments is not allowed.  Only available in Growth and above plans.
          * @summary Add an installment to a deal
          * @param {number} id The ID of the deal
          * @param {AddInstallmentRequestBody} [AddInstallmentRequestBody]
@@ -1606,7 +1606,7 @@ export const DealsApiFp = function (configuration) {
             });
         },
         /**
-         * Edits an installment added to a deal.  Only available in Advanced and above plans.
+         * Edits an installment added to a deal.  Only available in Growth and above plans.
          * @summary Update an installment added to a deal
          * @param {number} id The ID of the deal
          * @param {number} installment_id The ID of the installment
@@ -1710,7 +1710,7 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.deleteDealProduct(requestParameters.id, requestParameters.product_attachment_id).then((request) => request(axios, basePath));
         },
         /**
-         * Removes an installment from a deal.  Only available in Advanced and above plans.
+         * Removes an installment from a deal.  Only available in Growth and above plans.
          * @summary Delete an installment from a deal
          * @param {DealsApiDeleteInstallmentRequest} requestParameters Request parameters.
 
@@ -1810,7 +1810,7 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getDealsProducts(requestParameters.deal_ids, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(axios, basePath));
         },
         /**
-         * Lists installments attached to a list of deals.  Only available in Advanced and above plans.
+         * Lists installments attached to a list of deals.  Only available in Growth and above plans.
          * @summary List installments added to a list of deals
          * @param {DealsApiGetInstallmentsRequest} requestParameters Request parameters.
 
@@ -1830,7 +1830,7 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.postAdditionalDiscount(requestParameters.id, requestParameters.AddAdditionalDiscountRequestBody).then((request) => request(axios, basePath));
         },
         /**
-         * Adds an installment to a deal.  An installment can only be added if the deal includes at least one one-time product.  If the deal contains at least one recurring product, adding installments is not allowed.  Only available in Advanced and above plans.
+         * Adds an installment to a deal.  An installment can only be added if the deal includes at least one one-time product.  If the deal contains at least one recurring product, adding installments is not allowed.  Only available in Growth and above plans.
          * @summary Add an installment to a deal
          * @param {DealsApiPostInstallmentRequest} requestParameters Request parameters.
 
@@ -1880,7 +1880,7 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.updateDealProduct(requestParameters.id, requestParameters.product_attachment_id, requestParameters.UpdateDealProductRequest).then((request) => request(axios, basePath));
         },
         /**
-         * Edits an installment added to a deal.  Only available in Advanced and above plans.
+         * Edits an installment added to a deal.  Only available in Growth and above plans.
          * @summary Update an installment added to a deal
          * @param {DealsApiUpdateInstallmentRequest} requestParameters Request parameters.
 
@@ -1987,7 +1987,7 @@ export class DealsApi extends BaseAPI {
         return DealsApiFp(this.configuration).deleteDealProduct(requestParameters.id, requestParameters.product_attachment_id).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Removes an installment from a deal.  Only available in Advanced and above plans.
+     * Removes an installment from a deal.  Only available in Growth and above plans.
      * @summary Delete an installment from a deal
      * @param {DealsApiDeleteInstallmentRequest} requestParameters Request parameters.
 
@@ -2097,7 +2097,7 @@ export class DealsApi extends BaseAPI {
         return DealsApiFp(this.configuration).getDealsProducts(requestParameters.deal_ids, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Lists installments attached to a list of deals.  Only available in Advanced and above plans.
+     * Lists installments attached to a list of deals.  Only available in Growth and above plans.
      * @summary List installments added to a list of deals
      * @param {DealsApiGetInstallmentsRequest} requestParameters Request parameters.
 
@@ -2119,7 +2119,7 @@ export class DealsApi extends BaseAPI {
         return DealsApiFp(this.configuration).postAdditionalDiscount(requestParameters.id, requestParameters.AddAdditionalDiscountRequestBody).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Adds an installment to a deal.  An installment can only be added if the deal includes at least one one-time product.  If the deal contains at least one recurring product, adding installments is not allowed.  Only available in Advanced and above plans.
+     * Adds an installment to a deal.  An installment can only be added if the deal includes at least one one-time product.  If the deal contains at least one recurring product, adding installments is not allowed.  Only available in Growth and above plans.
      * @summary Add an installment to a deal
      * @param {DealsApiPostInstallmentRequest} requestParameters Request parameters.
 
@@ -2174,7 +2174,7 @@ export class DealsApi extends BaseAPI {
         return DealsApiFp(this.configuration).updateDealProduct(requestParameters.id, requestParameters.product_attachment_id, requestParameters.UpdateDealProductRequest).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Edits an installment added to a deal.  Only available in Advanced and above plans.
+     * Edits an installment added to a deal.  Only available in Growth and above plans.
      * @summary Update an installment added to a deal
      * @param {DealsApiUpdateInstallmentRequest} requestParameters Request parameters.
 

package/dist/esm/versions/v2/api/products-api.d.ts

@@ -14,18 +14,22 @@ import type { AxiosInstance } from 'axios';
 import { RequestArgs, BaseAPI } from '../base';
 import { AddDealFollowerRequest } from '../models';
 import { AddFollowerResponse } from '../models';
+import { AddProductImageResponse } from '../models';
 import { AddProductRequest } from '../models';
 import { AddProductVariationRequest } from '../models';
 import { DeleteFollowerResponse } from '../models';
+import { DeleteProductImageResponse } from '../models';
 import { DeleteProductResponse } from '../models';
 import { DeleteProductVariationResponse } from '../models';
 import { GetFollowerChangelogsResponse } from '../models';
 import { GetFollowersResponse } from '../models';
+import { GetProductImageResponse } from '../models';
 import { GetProductResponse } from '../models';
 import { GetProductSearchResponse } from '../models';
 import { GetProductVariationResponse } from '../models';
 import { GetProductVariationsResponse } from '../models';
 import { GetProductsResponse } from '../models';
+import { UpdateProductImageResponse } from '../models';
 import { UpdateProductRequest } from '../models';
 import { UpdateProductResponse } from '../models';
 import { UpdateProductVariationRequest } from '../models';
@@ -77,6 +81,14 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     deleteProductFollower: (id: number, follower_id: number) => Promise<RequestArgs>;
+    /**
+     * Deletes the image of a product.
+     * @summary Delete an image of a product
+     * @param {number} id The ID of the product
+
+     * @throws {RequiredError}
+     */
+    deleteProductImage: (id: number) => Promise<RequestArgs>;
     /**
      * Deletes a product variation.
      * @summary Delete a product variation
@@ -114,6 +126,14 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getProductFollowersChangelog: (id: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
+    /**
+     * Retrieves the image of a product. The public URL has a limited lifetime of 7 days.
+     * @summary Get image of a product
+     * @param {number} id The ID of the product
+
+     * @throws {RequiredError}
+     */
+    getProductImage: (id: number) => Promise<RequestArgs>;
     /**
      * Returns data about all product variations.
      * @summary Get all product variations
@@ -161,6 +181,15 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     updateProduct: (id: number, UpdateProductRequest?: UpdateProductRequest) => Promise<RequestArgs>;
+    /**
+     * Updates the image of a product.
+     * @summary Update an image for a product
+     * @param {number} id The ID of the product
+     * @param {File} data One image supplied in the multipart/form-data encoding
+
+     * @throws {RequiredError}
+     */
+    updateProductImage: (id: number, data: File) => Promise<RequestArgs>;
     /**
      * Updates product variation data.
      * @summary Update a product variation
@@ -171,6 +200,15 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     updateProductVariation: (id: number, product_variation_id: number, UpdateProductVariationRequest?: UpdateProductVariationRequest) => Promise<RequestArgs>;
+    /**
+     * Uploads an image for a product.
+     * @summary Upload an image for a product
+     * @param {number} id The ID of the product
+     * @param {File} data One image supplied in the multipart/form-data encoding
+
+     * @throws {RequiredError}
+     */
+    uploadProductImage: (id: number, data: File) => Promise<RequestArgs>;
 };
 /**
  * ProductsApi - functional programming interface
@@ -220,6 +258,14 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteProductFollower(id: number, follower_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteFollowerResponse>>;
+    /**
+     * Deletes the image of a product.
+     * @summary Delete an image of a product
+     * @param {number} id The ID of the product
+
+     * @throws {RequiredError}
+     */
+    deleteProductImage(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteProductImageResponse>>;
     /**
      * Deletes a product variation.
      * @summary Delete a product variation
@@ -257,6 +303,14 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getProductFollowersChangelog(id: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFollowerChangelogsResponse>>;
+    /**
+     * Retrieves the image of a product. The public URL has a limited lifetime of 7 days.
+     * @summary Get image of a product
+     * @param {number} id The ID of the product
+
+     * @throws {RequiredError}
+     */
+    getProductImage(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductImageResponse>>;
     /**
      * Returns data about all product variations.
      * @summary Get all product variations
@@ -304,6 +358,15 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     updateProduct(id: number, UpdateProductRequest?: UpdateProductRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpdateProductResponse>>;
+    /**
+     * Updates the image of a product.
+     * @summary Update an image for a product
+     * @param {number} id The ID of the product
+     * @param {File} data One image supplied in the multipart/form-data encoding
+
+     * @throws {RequiredError}
+     */
+    updateProductImage(id: number, data: File): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpdateProductImageResponse>>;
     /**
      * Updates product variation data.
      * @summary Update a product variation
@@ -314,6 +377,15 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     updateProductVariation(id: number, product_variation_id: number, UpdateProductVariationRequest?: UpdateProductVariationRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductVariationResponse>>;
+    /**
+     * Uploads an image for a product.
+     * @summary Upload an image for a product
+     * @param {number} id The ID of the product
+     * @param {File} data One image supplied in the multipart/form-data encoding
+
+     * @throws {RequiredError}
+     */
+    uploadProductImage(id: number, data: File): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddProductImageResponse>>;
 };
 /**
  * ProductsApi - factory interface
@@ -360,6 +432,14 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     deleteProductFollower(requestParameters: ProductsApiDeleteProductFollowerRequest): Promise<DeleteFollowerResponse>;
+    /**
+     * Deletes the image of a product.
+     * @summary Delete an image of a product
+     * @param {ProductsApiDeleteProductImageRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    deleteProductImage(requestParameters: ProductsApiDeleteProductImageRequest): Promise<DeleteProductImageResponse>;
     /**
      * Deletes a product variation.
      * @summary Delete a product variation
@@ -392,6 +472,14 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     getProductFollowersChangelog(requestParameters: ProductsApiGetProductFollowersChangelogRequest): Promise<GetFollowerChangelogsResponse>;
+    /**
+     * Retrieves the image of a product. The public URL has a limited lifetime of 7 days.
+     * @summary Get image of a product
+     * @param {ProductsApiGetProductImageRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getProductImage(requestParameters: ProductsApiGetProductImageRequest): Promise<GetProductImageResponse>;
     /**
      * Returns data about all product variations.
      * @summary Get all product variations
@@ -424,6 +512,14 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     updateProduct(requestParameters: ProductsApiUpdateProductRequest): Promise<UpdateProductResponse>;
+    /**
+     * Updates the image of a product.
+     * @summary Update an image for a product
+     * @param {ProductsApiUpdateProductImageRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    updateProductImage(requestParameters: ProductsApiUpdateProductImageRequest): Promise<UpdateProductImageResponse>;
     /**
      * Updates product variation data.
      * @summary Update a product variation
@@ -432,6 +528,14 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     updateProductVariation(requestParameters: ProductsApiUpdateProductVariationRequest): Promise<GetProductVariationResponse>;
+    /**
+     * Uploads an image for a product.
+     * @summary Upload an image for a product
+     * @param {ProductsApiUploadProductImageRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    uploadProductImage(requestParameters: ProductsApiUploadProductImageRequest): Promise<AddProductImageResponse>;
 };
 /**
  * Request parameters for addProduct operation in ProductsApi.
@@ -516,6 +620,19 @@ export interface ProductsApiDeleteProductFollowerRequest {
      */
     readonly follower_id: number;
 }
+/**
+ * Request parameters for deleteProductImage operation in ProductsApi.
+ * @export
+ * @interface ProductsApiDeleteProductImageRequest
+ */
+export interface ProductsApiDeleteProductImageRequest {
+    /**
+     * The ID of the product
+     * @type {number}
+     * @memberof ProductsApiDeleteProductImage
+     */
+    readonly id: number;
+}
 /**
  * Request parameters for deleteProductVariation operation in ProductsApi.
  * @export
@@ -598,6 +715,19 @@ export interface ProductsApiGetProductFollowersChangelogRequest {
      */
     readonly cursor?: string;
 }
+/**
+ * Request parameters for getProductImage operation in ProductsApi.
+ * @export
+ * @interface ProductsApiGetProductImageRequest
+ */
+export interface ProductsApiGetProductImageRequest {
+    /**
+     * The ID of the product
+     * @type {number}
+     * @memberof ProductsApiGetProductImage
+     */
+    readonly id: number;
+}
 /**
  * Request parameters for getProductVariations operation in ProductsApi.
  * @export
@@ -740,6 +870,25 @@ export interface ProductsApiUpdateProductRequest {
      */
     readonly UpdateProductRequest?: UpdateProductRequest;
 }
+/**
+ * Request parameters for updateProductImage operation in ProductsApi.
+ * @export
+ * @interface ProductsApiUpdateProductImageRequest
+ */
+export interface ProductsApiUpdateProductImageRequest {
+    /**
+     * The ID of the product
+     * @type {number}
+     * @memberof ProductsApiUpdateProductImage
+     */
+    readonly id: number;
+    /**
+     * One image supplied in the multipart/form-data encoding
+     * @type {File}
+     * @memberof ProductsApiUpdateProductImage
+     */
+    readonly data: File;
+}
 /**
  * Request parameters for updateProductVariation operation in ProductsApi.
  * @export
@@ -765,6 +914,25 @@ export interface ProductsApiUpdateProductVariationRequest {
      */
     readonly UpdateProductVariationRequest?: UpdateProductVariationRequest;
 }
+/**
+ * Request parameters for uploadProductImage operation in ProductsApi.
+ * @export
+ * @interface ProductsApiUploadProductImageRequest
+ */
+export interface ProductsApiUploadProductImageRequest {
+    /**
+     * The ID of the product
+     * @type {number}
+     * @memberof ProductsApiUploadProductImage
+     */
+    readonly id: number;
+    /**
+     * One image supplied in the multipart/form-data encoding
+     * @type {File}
+     * @memberof ProductsApiUploadProductImage
+     */
+    readonly data: File;
+}
 /**
  * ProductsApi - object-oriented interface
  * @export
@@ -817,6 +985,15 @@ export declare class ProductsApi extends BaseAPI {
      * @memberof ProductsApi
      */
     deleteProductFollower(requestParameters: ProductsApiDeleteProductFollowerRequest): Promise<DeleteFollowerResponse>;
+    /**
+     * Deletes the image of a product.
+     * @summary Delete an image of a product
+     * @param {ProductsApiDeleteProductImageRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProductsApi
+     */
+    deleteProductImage(requestParameters: ProductsApiDeleteProductImageRequest): Promise<DeleteProductImageResponse>;
     /**
      * Deletes a product variation.
      * @summary Delete a product variation
@@ -853,6 +1030,15 @@ export declare class ProductsApi extends BaseAPI {
      * @memberof ProductsApi
      */
     getProductFollowersChangelog(requestParameters: ProductsApiGetProductFollowersChangelogRequest): Promise<GetFollowerChangelogsResponse>;
+    /**
+     * Retrieves the image of a product. The public URL has a limited lifetime of 7 days.
+     * @summary Get image of a product
+     * @param {ProductsApiGetProductImageRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProductsApi
+     */
+    getProductImage(requestParameters: ProductsApiGetProductImageRequest): Promise<GetProductImageResponse>;
     /**
      * Returns data about all product variations.
      * @summary Get all product variations
@@ -889,6 +1075,15 @@ export declare class ProductsApi extends BaseAPI {
      * @memberof ProductsApi
      */
     updateProduct(requestParameters: ProductsApiUpdateProductRequest): Promise<UpdateProductResponse>;
+    /**
+     * Updates the image of a product.
+     * @summary Update an image for a product
+     * @param {ProductsApiUpdateProductImageRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProductsApi
+     */
+    updateProductImage(requestParameters: ProductsApiUpdateProductImageRequest): Promise<UpdateProductImageResponse>;
     /**
      * Updates product variation data.
      * @summary Update a product variation
@@ -898,4 +1093,13 @@ export declare class ProductsApi extends BaseAPI {
      * @memberof ProductsApi
      */
     updateProductVariation(requestParameters: ProductsApiUpdateProductVariationRequest): Promise<GetProductVariationResponse>;
+    /**
+     * Uploads an image for a product.
+     * @summary Upload an image for a product
+     * @param {ProductsApiUploadProductImageRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProductsApi
+     */
+    uploadProductImage(requestParameters: ProductsApiUploadProductImageRequest): Promise<AddProductImageResponse>;
 }