pipedrive 25.0.0 → 27.0.0

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

@@ -13,8 +13,12 @@ import type { Configuration } from '../configuration';
 import type { AxiosInstance } from 'axios';
 import { RequestArgs, BaseAPI } from '../base';
 import { AddAInstallmentResponse } from '../models';
+import { AddConvertDealToLeadResponse } from '../models';
+import { AddConvertLeadToDealResponse } from '../models';
 import { AddInstallmentRequestBody } from '../models';
+import { ConvertLeadToDealRequest } from '../models';
 import { DeleteInstallmentResponse } from '../models';
+import { GetConvertResponse1 } from '../models';
 import { GetInstallmentsResponse } from '../models';
 import { UpdateInstallmentRequestBody } from '../models';
 import { UpdateInstallmentResponse } from '../models';
@@ -23,6 +27,23 @@ import { UpdateInstallmentResponse } from '../models';
  * @export
  */
 export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
+     * @summary Convert a deal to a lead (BETA)
+     * @param {number} id The ID of the deal to convert
+
+     * @throws {RequiredError}
+     */
+    convertDealToLead: (id: number) => Promise<RequestArgs>;
+    /**
+     * Initiates a conversion of a lead to a deal. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. If the conversion is successful, the lead is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#getLeadConversionStatus\">/api/v2/leads/{lead_id}/convert/status/{conversion_id}</a> endpoint.
+     * @summary Convert a lead to a deal (BETA)
+     * @param {string} id The ID of the lead to convert
+     * @param {ConvertLeadToDealRequest} [ConvertLeadToDealRequest]
+
+     * @throws {RequiredError}
+     */
+    convertLeadToDeal: (id: string, ConvertLeadToDealRequest?: ConvertLeadToDealRequest) => Promise<RequestArgs>;
     /**
      * Removes an installment from a deal.  Only available in Advanced and above plans.
      * @summary Delete an installment from a deal
@@ -32,6 +53,15 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
      * @throws {RequiredError}
      */
     deleteInstallment: (id: number, installment_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)
+     * @param {number} id The ID of a deal
+     * @param {string} conversion_id The ID of the conversion
+
+     * @throws {RequiredError}
+     */
+    getDealConversionStatus: (id: number, conversion_id: string) => Promise<RequestArgs>;
     /**
      * Lists installments attached to a list of deals.  Only available in Advanced and above plans.
      * @summary List installments added to a list of deals
@@ -44,6 +74,15 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
      * @throws {RequiredError}
      */
     getInstallments: (deal_ids: Array<number>, cursor?: string, limit?: number, sort_by?: 'id' | 'billing_date' | 'deal_id', sort_direction?: 'asc' | 'desc') => Promise<RequestArgs>;
+    /**
+     * Returns data about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Deal ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
+     * @summary Get Lead conversion status (BETA)
+     * @param {string} id The ID of a lead
+     * @param {string} conversion_id The ID of the conversion
+
+     * @throws {RequiredError}
+     */
+    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.
      * @summary Add an installment to a deal
@@ -69,6 +108,23 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
  * @export
  */
 export declare const BetaApiFp: (configuration?: Configuration) => {
+    /**
+     * Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
+     * @summary Convert a deal to a lead (BETA)
+     * @param {number} id The ID of the deal to convert
+
+     * @throws {RequiredError}
+     */
+    convertDealToLead(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddConvertDealToLeadResponse>>;
+    /**
+     * Initiates a conversion of a lead to a deal. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. If the conversion is successful, the lead is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#getLeadConversionStatus\">/api/v2/leads/{lead_id}/convert/status/{conversion_id}</a> endpoint.
+     * @summary Convert a lead to a deal (BETA)
+     * @param {string} id The ID of the lead to convert
+     * @param {ConvertLeadToDealRequest} [ConvertLeadToDealRequest]
+
+     * @throws {RequiredError}
+     */
+    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.
      * @summary Delete an installment from a deal
@@ -78,6 +134,15 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteInstallment(id: number, installment_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteInstallmentResponse>>;
+    /**
+     * 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)
+     * @param {number} id The ID of a deal
+     * @param {string} conversion_id The ID of the conversion
+
+     * @throws {RequiredError}
+     */
+    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.
      * @summary List installments added to a list of deals
@@ -90,6 +155,15 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getInstallments(deal_ids: Array<number>, cursor?: string, limit?: number, sort_by?: 'id' | 'billing_date' | 'deal_id', sort_direction?: 'asc' | 'desc'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetInstallmentsResponse>>;
+    /**
+     * Returns data about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Deal ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
+     * @summary Get Lead conversion status (BETA)
+     * @param {string} id The ID of a lead
+     * @param {string} conversion_id The ID of the conversion
+
+     * @throws {RequiredError}
+     */
+    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.
      * @summary Add an installment to a deal
@@ -115,6 +189,22 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const BetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
+     * @summary Convert a deal to a lead (BETA)
+     * @param {BetaApiConvertDealToLeadRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    convertDealToLead(requestParameters: BetaApiConvertDealToLeadRequest): Promise<AddConvertDealToLeadResponse>;
+    /**
+     * Initiates a conversion of a lead to a deal. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. If the conversion is successful, the lead is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#getLeadConversionStatus\">/api/v2/leads/{lead_id}/convert/status/{conversion_id}</a> endpoint.
+     * @summary Convert a lead to a deal (BETA)
+     * @param {BetaApiConvertLeadToDealRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    convertLeadToDeal(requestParameters: BetaApiConvertLeadToDealRequest): Promise<AddConvertLeadToDealResponse>;
     /**
      * Removes an installment from a deal.  Only available in Advanced and above plans.
      * @summary Delete an installment from a deal
@@ -123,6 +213,14 @@ export declare const BetaApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     deleteInstallment(requestParameters: BetaApiDeleteInstallmentRequest): Promise<DeleteInstallmentResponse>;
+    /**
+     * 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)
+     * @param {BetaApiGetDealConversionStatusRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getDealConversionStatus(requestParameters: BetaApiGetDealConversionStatusRequest): Promise<GetConvertResponse1>;
     /**
      * Lists installments attached to a list of deals.  Only available in Advanced and above plans.
      * @summary List installments added to a list of deals
@@ -131,6 +229,14 @@ export declare const BetaApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     getInstallments(requestParameters: BetaApiGetInstallmentsRequest): Promise<GetInstallmentsResponse>;
+    /**
+     * Returns data about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Deal ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
+     * @summary Get Lead conversion status (BETA)
+     * @param {BetaApiGetLeadConversionStatusRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    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.
      * @summary Add an installment to a deal
@@ -148,6 +254,38 @@ export declare const BetaApiFactory: (configuration?: Configuration, basePath?:
      */
     updateInstallment(requestParameters: BetaApiUpdateInstallmentRequest): Promise<UpdateInstallmentResponse>;
 };
+/**
+ * Request parameters for convertDealToLead operation in BetaApi.
+ * @export
+ * @interface BetaApiConvertDealToLeadRequest
+ */
+export interface BetaApiConvertDealToLeadRequest {
+    /**
+     * The ID of the deal to convert
+     * @type {number}
+     * @memberof BetaApiConvertDealToLead
+     */
+    readonly id: number;
+}
+/**
+ * Request parameters for convertLeadToDeal operation in BetaApi.
+ * @export
+ * @interface BetaApiConvertLeadToDealRequest
+ */
+export interface BetaApiConvertLeadToDealRequest {
+    /**
+     * The ID of the lead to convert
+     * @type {string}
+     * @memberof BetaApiConvertLeadToDeal
+     */
+    readonly id: string;
+    /**
+     *
+     * @type {ConvertLeadToDealRequest}
+     * @memberof BetaApiConvertLeadToDeal
+     */
+    readonly ConvertLeadToDealRequest?: ConvertLeadToDealRequest;
+}
 /**
  * Request parameters for deleteInstallment operation in BetaApi.
  * @export
@@ -167,6 +305,25 @@ export interface BetaApiDeleteInstallmentRequest {
      */
     readonly installment_id: number;
 }
+/**
+ * Request parameters for getDealConversionStatus operation in BetaApi.
+ * @export
+ * @interface BetaApiGetDealConversionStatusRequest
+ */
+export interface BetaApiGetDealConversionStatusRequest {
+    /**
+     * The ID of a deal
+     * @type {number}
+     * @memberof BetaApiGetDealConversionStatus
+     */
+    readonly id: number;
+    /**
+     * The ID of the conversion
+     * @type {string}
+     * @memberof BetaApiGetDealConversionStatus
+     */
+    readonly conversion_id: string;
+}
 /**
  * Request parameters for getInstallments operation in BetaApi.
  * @export
@@ -204,6 +361,25 @@ export interface BetaApiGetInstallmentsRequest {
      */
     readonly sort_direction?: 'asc' | 'desc';
 }
+/**
+ * Request parameters for getLeadConversionStatus operation in BetaApi.
+ * @export
+ * @interface BetaApiGetLeadConversionStatusRequest
+ */
+export interface BetaApiGetLeadConversionStatusRequest {
+    /**
+     * The ID of a lead
+     * @type {string}
+     * @memberof BetaApiGetLeadConversionStatus
+     */
+    readonly id: string;
+    /**
+     * The ID of the conversion
+     * @type {string}
+     * @memberof BetaApiGetLeadConversionStatus
+     */
+    readonly conversion_id: string;
+}
 /**
  * Request parameters for postInstallment operation in BetaApi.
  * @export
@@ -255,6 +431,24 @@ export interface BetaApiUpdateInstallmentRequest {
  * @extends {BaseAPI}
  */
 export declare class BetaApi extends BaseAPI {
+    /**
+     * Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
+     * @summary Convert a deal to a lead (BETA)
+     * @param {BetaApiConvertDealToLeadRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof BetaApi
+     */
+    convertDealToLead(requestParameters: BetaApiConvertDealToLeadRequest): Promise<AddConvertDealToLeadResponse>;
+    /**
+     * Initiates a conversion of a lead to a deal. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. If the conversion is successful, the lead is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#getLeadConversionStatus\">/api/v2/leads/{lead_id}/convert/status/{conversion_id}</a> endpoint.
+     * @summary Convert a lead to a deal (BETA)
+     * @param {BetaApiConvertLeadToDealRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof BetaApi
+     */
+    convertLeadToDeal(requestParameters: BetaApiConvertLeadToDealRequest): Promise<AddConvertLeadToDealResponse>;
     /**
      * Removes an installment from a deal.  Only available in Advanced and above plans.
      * @summary Delete an installment from a deal
@@ -264,6 +458,15 @@ export declare class BetaApi extends BaseAPI {
      * @memberof BetaApi
      */
     deleteInstallment(requestParameters: BetaApiDeleteInstallmentRequest): Promise<DeleteInstallmentResponse>;
+    /**
+     * 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)
+     * @param {BetaApiGetDealConversionStatusRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof BetaApi
+     */
+    getDealConversionStatus(requestParameters: BetaApiGetDealConversionStatusRequest): Promise<GetConvertResponse1>;
     /**
      * Lists installments attached to a list of deals.  Only available in Advanced and above plans.
      * @summary List installments added to a list of deals
@@ -273,6 +476,15 @@ export declare class BetaApi extends BaseAPI {
      * @memberof BetaApi
      */
     getInstallments(requestParameters: BetaApiGetInstallmentsRequest): Promise<GetInstallmentsResponse>;
+    /**
+     * Returns data about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Deal ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
+     * @summary Get Lead conversion status (BETA)
+     * @param {BetaApiGetLeadConversionStatusRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof BetaApi
+     */
+    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.
      * @summary Add an installment to a deal