pipedrive 29.0.0 → 29.1.0

package/dist/versions/v2/api/beta-api.d.ts

@@ -16,12 +16,16 @@ import { AddAInstallmentResponse } from '../models';
 import { AddConvertDealToLeadResponse } from '../models';
 import { AddConvertLeadToDealResponse } from '../models';
 import { AddInstallmentRequestBody } from '../models';
+import { AddProductImageResponse } from '../models';
 import { ConvertLeadToDealRequest } from '../models';
 import { DeleteInstallmentResponse } from '../models';
+import { DeleteProductImageResponse } from '../models';
 import { GetConvertResponse1 } from '../models';
 import { GetInstallmentsResponse } from '../models';
+import { GetProductImageResponse } from '../models';
 import { UpdateInstallmentRequestBody } from '../models';
 import { UpdateInstallmentResponse } from '../models';
+import { UpdateProductImageResponse } from '../models';
 /**
  * BetaApi - axios parameter creator
  * @export
@@ -45,7 +49,7 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
      */
     convertLeadToDeal: (id: string, ConvertLeadToDealRequest?: ConvertLeadToDealRequest) => Promise<RequestArgs>;
     /**
-     * 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
@@ -53,6 +57,14 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
      * @throws {RequiredError}
      */
     deleteInstallment: (id: number, installment_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>;
     /**
      * Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
      * @summary Get Deal conversion status (BETA)
@@ -63,7 +75,7 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
      */
     getDealConversionStatus: (id: number, conversion_id: string) => Promise<RequestArgs>;
     /**
-     * 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
@@ -84,7 +96,15 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
      */
     getLeadConversionStatus: (id: string, conversion_id: string) => Promise<RequestArgs>;
     /**
-     * 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.
+     * 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>;
+    /**
+     * 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]
@@ -93,7 +113,7 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
      */
     postInstallment: (id: number, AddInstallmentRequestBody?: AddInstallmentRequestBody) => Promise<RequestArgs>;
     /**
-     * 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
@@ -102,6 +122,24 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
      * @throws {RequiredError}
      */
     updateInstallment: (id: number, installment_id: number, UpdateInstallmentRequestBody?: UpdateInstallmentRequestBody) => 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>;
+    /**
+     * 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>;
 };
 /**
  * BetaApi - functional programming interface
@@ -126,7 +164,7 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
      */
     convertLeadToDeal(id: string, ConvertLeadToDealRequest?: ConvertLeadToDealRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddConvertLeadToDealResponse>>;
     /**
-     * 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
@@ -134,6 +172,14 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteInstallment(id: number, installment_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteInstallmentResponse>>;
+    /**
+     * 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>>;
     /**
      * Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
      * @summary Get Deal conversion status (BETA)
@@ -144,7 +190,7 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
      */
     getDealConversionStatus(id: number, conversion_id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetConvertResponse1>>;
     /**
-     * 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
@@ -165,7 +211,15 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
      */
     getLeadConversionStatus(id: string, conversion_id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetConvertResponse1>>;
     /**
-     * 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.
+     * 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>>;
+    /**
+     * 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]
@@ -174,7 +228,7 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
      */
     postInstallment(id: number, AddInstallmentRequestBody?: AddInstallmentRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddAInstallmentResponse>>;
     /**
-     * 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
@@ -183,6 +237,24 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     updateInstallment(id: number, installment_id: number, UpdateInstallmentRequestBody?: UpdateInstallmentRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpdateInstallmentResponse>>;
+    /**
+     * 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>>;
+    /**
+     * 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>>;
 };
 /**
  * BetaApi - factory interface
@@ -206,13 +278,21 @@ export declare const BetaApiFactory: (configuration?: Configuration, basePath?:
      */
     convertLeadToDeal(requestParameters: BetaApiConvertLeadToDealRequest): Promise<AddConvertLeadToDealResponse>;
     /**
-     * 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 {BetaApiDeleteInstallmentRequest} requestParameters Request parameters.
 
      * @throws {RequiredError}
      */
     deleteInstallment(requestParameters: BetaApiDeleteInstallmentRequest): Promise<DeleteInstallmentResponse>;
+    /**
+     * Deletes the image of a product.
+     * @summary Delete an image of a product
+     * @param {BetaApiDeleteProductImageRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    deleteProductImage(requestParameters: BetaApiDeleteProductImageRequest): Promise<DeleteProductImageResponse>;
     /**
      * Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
      * @summary Get Deal conversion status (BETA)
@@ -222,7 +302,7 @@ export declare const BetaApiFactory: (configuration?: Configuration, basePath?:
      */
     getDealConversionStatus(requestParameters: BetaApiGetDealConversionStatusRequest): Promise<GetConvertResponse1>;
     /**
-     * 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 {BetaApiGetInstallmentsRequest} requestParameters Request parameters.
 
@@ -238,7 +318,15 @@ export declare const BetaApiFactory: (configuration?: Configuration, basePath?:
      */
     getLeadConversionStatus(requestParameters: BetaApiGetLeadConversionStatusRequest): Promise<GetConvertResponse1>;
     /**
-     * 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.
+     * Retrieves the image of a product. The public URL has a limited lifetime of 7 days.
+     * @summary Get image of a product
+     * @param {BetaApiGetProductImageRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getProductImage(requestParameters: BetaApiGetProductImageRequest): Promise<GetProductImageResponse>;
+    /**
+     * 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 {BetaApiPostInstallmentRequest} requestParameters Request parameters.
 
@@ -246,13 +334,29 @@ export declare const BetaApiFactory: (configuration?: Configuration, basePath?:
      */
     postInstallment(requestParameters: BetaApiPostInstallmentRequest): Promise<AddAInstallmentResponse>;
     /**
-     * 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 {BetaApiUpdateInstallmentRequest} requestParameters Request parameters.
 
      * @throws {RequiredError}
      */
     updateInstallment(requestParameters: BetaApiUpdateInstallmentRequest): Promise<UpdateInstallmentResponse>;
+    /**
+     * Updates the image of a product.
+     * @summary Update an image for a product
+     * @param {BetaApiUpdateProductImageRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    updateProductImage(requestParameters: BetaApiUpdateProductImageRequest): Promise<UpdateProductImageResponse>;
+    /**
+     * Uploads an image for a product.
+     * @summary Upload an image for a product
+     * @param {BetaApiUploadProductImageRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    uploadProductImage(requestParameters: BetaApiUploadProductImageRequest): Promise<AddProductImageResponse>;
 };
 /**
  * Request parameters for convertDealToLead operation in BetaApi.
@@ -305,6 +409,19 @@ export interface BetaApiDeleteInstallmentRequest {
      */
     readonly installment_id: number;
 }
+/**
+ * Request parameters for deleteProductImage operation in BetaApi.
+ * @export
+ * @interface BetaApiDeleteProductImageRequest
+ */
+export interface BetaApiDeleteProductImageRequest {
+    /**
+     * The ID of the product
+     * @type {number}
+     * @memberof BetaApiDeleteProductImage
+     */
+    readonly id: number;
+}
 /**
  * Request parameters for getDealConversionStatus operation in BetaApi.
  * @export
@@ -380,6 +497,19 @@ export interface BetaApiGetLeadConversionStatusRequest {
      */
     readonly conversion_id: string;
 }
+/**
+ * Request parameters for getProductImage operation in BetaApi.
+ * @export
+ * @interface BetaApiGetProductImageRequest
+ */
+export interface BetaApiGetProductImageRequest {
+    /**
+     * The ID of the product
+     * @type {number}
+     * @memberof BetaApiGetProductImage
+     */
+    readonly id: number;
+}
 /**
  * Request parameters for postInstallment operation in BetaApi.
  * @export
@@ -424,6 +554,44 @@ export interface BetaApiUpdateInstallmentRequest {
      */
     readonly UpdateInstallmentRequestBody?: UpdateInstallmentRequestBody;
 }
+/**
+ * Request parameters for updateProductImage operation in BetaApi.
+ * @export
+ * @interface BetaApiUpdateProductImageRequest
+ */
+export interface BetaApiUpdateProductImageRequest {
+    /**
+     * The ID of the product
+     * @type {number}
+     * @memberof BetaApiUpdateProductImage
+     */
+    readonly id: number;
+    /**
+     * One image supplied in the multipart/form-data encoding
+     * @type {File}
+     * @memberof BetaApiUpdateProductImage
+     */
+    readonly data: File;
+}
+/**
+ * Request parameters for uploadProductImage operation in BetaApi.
+ * @export
+ * @interface BetaApiUploadProductImageRequest
+ */
+export interface BetaApiUploadProductImageRequest {
+    /**
+     * The ID of the product
+     * @type {number}
+     * @memberof BetaApiUploadProductImage
+     */
+    readonly id: number;
+    /**
+     * One image supplied in the multipart/form-data encoding
+     * @type {File}
+     * @memberof BetaApiUploadProductImage
+     */
+    readonly data: File;
+}
 /**
  * BetaApi - object-oriented interface
  * @export
@@ -450,7 +618,7 @@ export declare class BetaApi extends BaseAPI {
      */
     convertLeadToDeal(requestParameters: BetaApiConvertLeadToDealRequest): Promise<AddConvertLeadToDealResponse>;
     /**
-     * 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 {BetaApiDeleteInstallmentRequest} requestParameters Request parameters.
 
@@ -458,6 +626,15 @@ export declare class BetaApi extends BaseAPI {
      * @memberof BetaApi
      */
     deleteInstallment(requestParameters: BetaApiDeleteInstallmentRequest): Promise<DeleteInstallmentResponse>;
+    /**
+     * Deletes the image of a product.
+     * @summary Delete an image of a product
+     * @param {BetaApiDeleteProductImageRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof BetaApi
+     */
+    deleteProductImage(requestParameters: BetaApiDeleteProductImageRequest): Promise<DeleteProductImageResponse>;
     /**
      * Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
      * @summary Get Deal conversion status (BETA)
@@ -468,7 +645,7 @@ export declare class BetaApi extends BaseAPI {
      */
     getDealConversionStatus(requestParameters: BetaApiGetDealConversionStatusRequest): Promise<GetConvertResponse1>;
     /**
-     * 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 {BetaApiGetInstallmentsRequest} requestParameters Request parameters.
 
@@ -486,7 +663,16 @@ export declare class BetaApi extends BaseAPI {
      */
     getLeadConversionStatus(requestParameters: BetaApiGetLeadConversionStatusRequest): Promise<GetConvertResponse1>;
     /**
-     * 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.
+     * Retrieves the image of a product. The public URL has a limited lifetime of 7 days.
+     * @summary Get image of a product
+     * @param {BetaApiGetProductImageRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof BetaApi
+     */
+    getProductImage(requestParameters: BetaApiGetProductImageRequest): Promise<GetProductImageResponse>;
+    /**
+     * 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 {BetaApiPostInstallmentRequest} requestParameters Request parameters.
 
@@ -495,7 +681,7 @@ export declare class BetaApi extends BaseAPI {
      */
     postInstallment(requestParameters: BetaApiPostInstallmentRequest): Promise<AddAInstallmentResponse>;
     /**
-     * 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 {BetaApiUpdateInstallmentRequest} requestParameters Request parameters.
 
@@ -503,4 +689,22 @@ export declare class BetaApi extends BaseAPI {
      * @memberof BetaApi
      */
     updateInstallment(requestParameters: BetaApiUpdateInstallmentRequest): Promise<UpdateInstallmentResponse>;
+    /**
+     * Updates the image of a product.
+     * @summary Update an image for a product
+     * @param {BetaApiUpdateProductImageRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof BetaApi
+     */
+    updateProductImage(requestParameters: BetaApiUpdateProductImageRequest): Promise<UpdateProductImageResponse>;
+    /**
+     * Uploads an image for a product.
+     * @summary Upload an image for a product
+     * @param {BetaApiUploadProductImageRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof BetaApi
+     */
+    uploadProductImage(requestParameters: BetaApiUploadProductImageRequest): Promise<AddProductImageResponse>;
 }