pipedrive 31.1.0 → 31.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/esm/versions/v2/api/deals-api.d.ts +8 -8
- package/dist/esm/versions/v2/api/deals-api.js +8 -8
- package/dist/esm/versions/v2/api/leads-api.d.ts +8 -8
- package/dist/esm/versions/v2/api/leads-api.js +8 -8
- package/dist/esm/versions/v2/api.d.ts +0 -1
- package/dist/esm/versions/v2/api.js +0 -1
- package/dist/versions/v2/api/deals-api.d.ts +8 -8
- package/dist/versions/v2/api/deals-api.js +8 -8
- package/dist/versions/v2/api/leads-api.d.ts +8 -8
- package/dist/versions/v2/api/leads-api.js +8 -8
- package/dist/versions/v2/api.d.ts +0 -1
- package/dist/versions/v2/api.js +0 -1
- package/package.json +1 -1
|
@@ -87,7 +87,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
87
87
|
addManyDealProducts: (id: number, CreateManyDealProductRequest?: CreateManyDealProductRequest) => Promise<RequestArgs>;
|
|
88
88
|
/**
|
|
89
89
|
* 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.
|
|
90
|
-
* @summary Convert a deal to a lead
|
|
90
|
+
* @summary Convert a deal to a lead
|
|
91
91
|
* @param {number} id The ID of the deal to convert
|
|
92
92
|
|
|
93
93
|
* @throws {RequiredError}
|
|
@@ -189,7 +189,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
189
189
|
getDeal: (id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email', custom_fields?: string) => Promise<RequestArgs>;
|
|
190
190
|
/**
|
|
191
191
|
* 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.
|
|
192
|
-
* @summary Get Deal conversion status
|
|
192
|
+
* @summary Get Deal conversion status
|
|
193
193
|
* @param {number} id The ID of a deal
|
|
194
194
|
* @param {string} conversion_id The ID of the conversion
|
|
195
195
|
|
|
@@ -391,7 +391,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
391
391
|
addManyDealProducts(id: number, CreateManyDealProductRequest?: CreateManyDealProductRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddManyDealProductResponse>>;
|
|
392
392
|
/**
|
|
393
393
|
* 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.
|
|
394
|
-
* @summary Convert a deal to a lead
|
|
394
|
+
* @summary Convert a deal to a lead
|
|
395
395
|
* @param {number} id The ID of the deal to convert
|
|
396
396
|
|
|
397
397
|
* @throws {RequiredError}
|
|
@@ -493,7 +493,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
493
493
|
getDeal(id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email', custom_fields?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertDealResponse>>;
|
|
494
494
|
/**
|
|
495
495
|
* 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.
|
|
496
|
-
* @summary Get Deal conversion status
|
|
496
|
+
* @summary Get Deal conversion status
|
|
497
497
|
* @param {number} id The ID of a deal
|
|
498
498
|
* @param {string} conversion_id The ID of the conversion
|
|
499
499
|
|
|
@@ -692,7 +692,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
692
692
|
addManyDealProducts(requestParameters: DealsApiAddManyDealProductsRequest): Promise<AddManyDealProductResponse>;
|
|
693
693
|
/**
|
|
694
694
|
* 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.
|
|
695
|
-
* @summary Convert a deal to a lead
|
|
695
|
+
* @summary Convert a deal to a lead
|
|
696
696
|
* @param {DealsApiConvertDealToLeadRequest} requestParameters Request parameters.
|
|
697
697
|
|
|
698
698
|
* @throws {RequiredError}
|
|
@@ -772,7 +772,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
772
772
|
getDeal(requestParameters: DealsApiGetDealRequest): Promise<UpsertDealResponse>;
|
|
773
773
|
/**
|
|
774
774
|
* 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.
|
|
775
|
-
* @summary Get Deal conversion status
|
|
775
|
+
* @summary Get Deal conversion status
|
|
776
776
|
* @param {DealsApiGetDealConversionStatusRequest} requestParameters Request parameters.
|
|
777
777
|
|
|
778
778
|
* @throws {RequiredError}
|
|
@@ -1736,7 +1736,7 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1736
1736
|
addManyDealProducts(requestParameters: DealsApiAddManyDealProductsRequest): Promise<AddManyDealProductResponse>;
|
|
1737
1737
|
/**
|
|
1738
1738
|
* 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.
|
|
1739
|
-
* @summary Convert a deal to a lead
|
|
1739
|
+
* @summary Convert a deal to a lead
|
|
1740
1740
|
* @param {DealsApiConvertDealToLeadRequest} requestParameters Request parameters.
|
|
1741
1741
|
|
|
1742
1742
|
* @throws {RequiredError}
|
|
@@ -1826,7 +1826,7 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1826
1826
|
getDeal(requestParameters: DealsApiGetDealRequest): Promise<UpsertDealResponse>;
|
|
1827
1827
|
/**
|
|
1828
1828
|
* 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.
|
|
1829
|
-
* @summary Get Deal conversion status
|
|
1829
|
+
* @summary Get Deal conversion status
|
|
1830
1830
|
* @param {DealsApiGetDealConversionStatusRequest} requestParameters Request parameters.
|
|
1831
1831
|
|
|
1832
1832
|
* @throws {RequiredError}
|
|
@@ -178,7 +178,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
178
178
|
}),
|
|
179
179
|
/**
|
|
180
180
|
* 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.
|
|
181
|
-
* @summary Convert a deal to a lead
|
|
181
|
+
* @summary Convert a deal to a lead
|
|
182
182
|
* @param {number} id The ID of the deal to convert
|
|
183
183
|
|
|
184
184
|
* @throws {RequiredError}
|
|
@@ -606,7 +606,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
606
606
|
}),
|
|
607
607
|
/**
|
|
608
608
|
* 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.
|
|
609
|
-
* @summary Get Deal conversion status
|
|
609
|
+
* @summary Get Deal conversion status
|
|
610
610
|
* @param {number} id The ID of a deal
|
|
611
611
|
* @param {string} conversion_id The ID of the conversion
|
|
612
612
|
|
|
@@ -1342,7 +1342,7 @@ export const DealsApiFp = function (configuration) {
|
|
|
1342
1342
|
},
|
|
1343
1343
|
/**
|
|
1344
1344
|
* 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.
|
|
1345
|
-
* @summary Convert a deal to a lead
|
|
1345
|
+
* @summary Convert a deal to a lead
|
|
1346
1346
|
* @param {number} id The ID of the deal to convert
|
|
1347
1347
|
|
|
1348
1348
|
* @throws {RequiredError}
|
|
@@ -1494,7 +1494,7 @@ export const DealsApiFp = function (configuration) {
|
|
|
1494
1494
|
},
|
|
1495
1495
|
/**
|
|
1496
1496
|
* 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.
|
|
1497
|
-
* @summary Get Deal conversion status
|
|
1497
|
+
* @summary Get Deal conversion status
|
|
1498
1498
|
* @param {number} id The ID of a deal
|
|
1499
1499
|
* @param {string} conversion_id The ID of the conversion
|
|
1500
1500
|
|
|
@@ -1774,7 +1774,7 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1774
1774
|
},
|
|
1775
1775
|
/**
|
|
1776
1776
|
* 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.
|
|
1777
|
-
* @summary Convert a deal to a lead
|
|
1777
|
+
* @summary Convert a deal to a lead
|
|
1778
1778
|
* @param {DealsApiConvertDealToLeadRequest} requestParameters Request parameters.
|
|
1779
1779
|
|
|
1780
1780
|
* @throws {RequiredError}
|
|
@@ -1874,7 +1874,7 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1874
1874
|
},
|
|
1875
1875
|
/**
|
|
1876
1876
|
* 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.
|
|
1877
|
-
* @summary Get Deal conversion status
|
|
1877
|
+
* @summary Get Deal conversion status
|
|
1878
1878
|
* @param {DealsApiGetDealConversionStatusRequest} requestParameters Request parameters.
|
|
1879
1879
|
|
|
1880
1880
|
* @throws {RequiredError}
|
|
@@ -2067,7 +2067,7 @@ export class DealsApi extends BaseAPI {
|
|
|
2067
2067
|
}
|
|
2068
2068
|
/**
|
|
2069
2069
|
* 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.
|
|
2070
|
-
* @summary Convert a deal to a lead
|
|
2070
|
+
* @summary Convert a deal to a lead
|
|
2071
2071
|
* @param {DealsApiConvertDealToLeadRequest} requestParameters Request parameters.
|
|
2072
2072
|
|
|
2073
2073
|
* @throws {RequiredError}
|
|
@@ -2177,7 +2177,7 @@ export class DealsApi extends BaseAPI {
|
|
|
2177
2177
|
}
|
|
2178
2178
|
/**
|
|
2179
2179
|
* 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.
|
|
2180
|
-
* @summary Get Deal conversion status
|
|
2180
|
+
* @summary Get Deal conversion status
|
|
2181
2181
|
* @param {DealsApiGetDealConversionStatusRequest} requestParameters Request parameters.
|
|
2182
2182
|
|
|
2183
2183
|
* @throws {RequiredError}
|
|
@@ -23,7 +23,7 @@ import { GetLeadSearchResponse } from '../models';
|
|
|
23
23
|
export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
24
|
/**
|
|
25
25
|
* 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.
|
|
26
|
-
* @summary Convert a lead to a deal
|
|
26
|
+
* @summary Convert a lead to a deal
|
|
27
27
|
* @param {string} id The ID of the lead to convert
|
|
28
28
|
* @param {ConvertLeadToDealRequest} [ConvertLeadToDealRequest]
|
|
29
29
|
|
|
@@ -32,7 +32,7 @@ export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
32
32
|
convertLeadToDeal: (id: string, ConvertLeadToDealRequest?: ConvertLeadToDealRequest) => Promise<RequestArgs>;
|
|
33
33
|
/**
|
|
34
34
|
* 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.
|
|
35
|
-
* @summary Get Lead conversion status
|
|
35
|
+
* @summary Get Lead conversion status
|
|
36
36
|
* @param {string} id The ID of a lead
|
|
37
37
|
* @param {string} conversion_id The ID of the conversion
|
|
38
38
|
|
|
@@ -62,7 +62,7 @@ export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
62
62
|
export declare const LeadsApiFp: (configuration?: Configuration) => {
|
|
63
63
|
/**
|
|
64
64
|
* 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.
|
|
65
|
-
* @summary Convert a lead to a deal
|
|
65
|
+
* @summary Convert a lead to a deal
|
|
66
66
|
* @param {string} id The ID of the lead to convert
|
|
67
67
|
* @param {ConvertLeadToDealRequest} [ConvertLeadToDealRequest]
|
|
68
68
|
|
|
@@ -71,7 +71,7 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
|
|
|
71
71
|
convertLeadToDeal(id: string, ConvertLeadToDealRequest?: ConvertLeadToDealRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddConvertLeadToDealResponse>>;
|
|
72
72
|
/**
|
|
73
73
|
* 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.
|
|
74
|
-
* @summary Get Lead conversion status
|
|
74
|
+
* @summary Get Lead conversion status
|
|
75
75
|
* @param {string} id The ID of a lead
|
|
76
76
|
* @param {string} conversion_id The ID of the conversion
|
|
77
77
|
|
|
@@ -101,7 +101,7 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
|
|
|
101
101
|
export declare const LeadsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
102
102
|
/**
|
|
103
103
|
* 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.
|
|
104
|
-
* @summary Convert a lead to a deal
|
|
104
|
+
* @summary Convert a lead to a deal
|
|
105
105
|
* @param {LeadsApiConvertLeadToDealRequest} requestParameters Request parameters.
|
|
106
106
|
|
|
107
107
|
* @throws {RequiredError}
|
|
@@ -109,7 +109,7 @@ export declare const LeadsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
109
109
|
convertLeadToDeal(requestParameters: LeadsApiConvertLeadToDealRequest): Promise<AddConvertLeadToDealResponse>;
|
|
110
110
|
/**
|
|
111
111
|
* 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.
|
|
112
|
-
* @summary Get Lead conversion status
|
|
112
|
+
* @summary Get Lead conversion status
|
|
113
113
|
* @param {LeadsApiGetLeadConversionStatusRequest} requestParameters Request parameters.
|
|
114
114
|
|
|
115
115
|
* @throws {RequiredError}
|
|
@@ -226,7 +226,7 @@ export interface LeadsApiSearchLeadsRequest {
|
|
|
226
226
|
export declare class LeadsApi extends BaseAPI {
|
|
227
227
|
/**
|
|
228
228
|
* 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.
|
|
229
|
-
* @summary Convert a lead to a deal
|
|
229
|
+
* @summary Convert a lead to a deal
|
|
230
230
|
* @param {LeadsApiConvertLeadToDealRequest} requestParameters Request parameters.
|
|
231
231
|
|
|
232
232
|
* @throws {RequiredError}
|
|
@@ -235,7 +235,7 @@ export declare class LeadsApi extends BaseAPI {
|
|
|
235
235
|
convertLeadToDeal(requestParameters: LeadsApiConvertLeadToDealRequest): Promise<AddConvertLeadToDealResponse>;
|
|
236
236
|
/**
|
|
237
237
|
* 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.
|
|
238
|
-
* @summary Get Lead conversion status
|
|
238
|
+
* @summary Get Lead conversion status
|
|
239
239
|
* @param {LeadsApiGetLeadConversionStatusRequest} requestParameters Request parameters.
|
|
240
240
|
|
|
241
241
|
* @throws {RequiredError}
|
|
@@ -34,7 +34,7 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
|
|
|
34
34
|
return {
|
|
35
35
|
/**
|
|
36
36
|
* 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.
|
|
37
|
-
* @summary Convert a lead to a deal
|
|
37
|
+
* @summary Convert a lead to a deal
|
|
38
38
|
* @param {string} id The ID of the lead to convert
|
|
39
39
|
* @param {ConvertLeadToDealRequest} [ConvertLeadToDealRequest]
|
|
40
40
|
|
|
@@ -71,7 +71,7 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
|
|
|
71
71
|
}),
|
|
72
72
|
/**
|
|
73
73
|
* 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.
|
|
74
|
-
* @summary Get Lead conversion status
|
|
74
|
+
* @summary Get Lead conversion status
|
|
75
75
|
* @param {string} id The ID of a lead
|
|
76
76
|
* @param {string} conversion_id The ID of the conversion
|
|
77
77
|
|
|
@@ -182,7 +182,7 @@ export const LeadsApiFp = function (configuration) {
|
|
|
182
182
|
return {
|
|
183
183
|
/**
|
|
184
184
|
* 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.
|
|
185
|
-
* @summary Convert a lead to a deal
|
|
185
|
+
* @summary Convert a lead to a deal
|
|
186
186
|
* @param {string} id The ID of the lead to convert
|
|
187
187
|
* @param {ConvertLeadToDealRequest} [ConvertLeadToDealRequest]
|
|
188
188
|
|
|
@@ -196,7 +196,7 @@ export const LeadsApiFp = function (configuration) {
|
|
|
196
196
|
},
|
|
197
197
|
/**
|
|
198
198
|
* 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.
|
|
199
|
-
* @summary Get Lead conversion status
|
|
199
|
+
* @summary Get Lead conversion status
|
|
200
200
|
* @param {string} id The ID of a lead
|
|
201
201
|
* @param {string} conversion_id The ID of the conversion
|
|
202
202
|
|
|
@@ -239,7 +239,7 @@ export const LeadsApiFactory = function (configuration, basePath, axios) {
|
|
|
239
239
|
return {
|
|
240
240
|
/**
|
|
241
241
|
* 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.
|
|
242
|
-
* @summary Convert a lead to a deal
|
|
242
|
+
* @summary Convert a lead to a deal
|
|
243
243
|
* @param {LeadsApiConvertLeadToDealRequest} requestParameters Request parameters.
|
|
244
244
|
|
|
245
245
|
* @throws {RequiredError}
|
|
@@ -249,7 +249,7 @@ export const LeadsApiFactory = function (configuration, basePath, axios) {
|
|
|
249
249
|
},
|
|
250
250
|
/**
|
|
251
251
|
* 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.
|
|
252
|
-
* @summary Get Lead conversion status
|
|
252
|
+
* @summary Get Lead conversion status
|
|
253
253
|
* @param {LeadsApiGetLeadConversionStatusRequest} requestParameters Request parameters.
|
|
254
254
|
|
|
255
255
|
* @throws {RequiredError}
|
|
@@ -278,7 +278,7 @@ export const LeadsApiFactory = function (configuration, basePath, axios) {
|
|
|
278
278
|
export class LeadsApi extends BaseAPI {
|
|
279
279
|
/**
|
|
280
280
|
* 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.
|
|
281
|
-
* @summary Convert a lead to a deal
|
|
281
|
+
* @summary Convert a lead to a deal
|
|
282
282
|
* @param {LeadsApiConvertLeadToDealRequest} requestParameters Request parameters.
|
|
283
283
|
|
|
284
284
|
* @throws {RequiredError}
|
|
@@ -289,7 +289,7 @@ export class LeadsApi extends BaseAPI {
|
|
|
289
289
|
}
|
|
290
290
|
/**
|
|
291
291
|
* 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.
|
|
292
|
-
* @summary Get Lead conversion status
|
|
292
|
+
* @summary Get Lead conversion status
|
|
293
293
|
* @param {LeadsApiGetLeadConversionStatusRequest} requestParameters Request parameters.
|
|
294
294
|
|
|
295
295
|
* @throws {RequiredError}
|
|
@@ -87,7 +87,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
87
87
|
addManyDealProducts: (id: number, CreateManyDealProductRequest?: CreateManyDealProductRequest) => Promise<RequestArgs>;
|
|
88
88
|
/**
|
|
89
89
|
* 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.
|
|
90
|
-
* @summary Convert a deal to a lead
|
|
90
|
+
* @summary Convert a deal to a lead
|
|
91
91
|
* @param {number} id The ID of the deal to convert
|
|
92
92
|
|
|
93
93
|
* @throws {RequiredError}
|
|
@@ -189,7 +189,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
189
189
|
getDeal: (id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email', custom_fields?: string) => Promise<RequestArgs>;
|
|
190
190
|
/**
|
|
191
191
|
* 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.
|
|
192
|
-
* @summary Get Deal conversion status
|
|
192
|
+
* @summary Get Deal conversion status
|
|
193
193
|
* @param {number} id The ID of a deal
|
|
194
194
|
* @param {string} conversion_id The ID of the conversion
|
|
195
195
|
|
|
@@ -391,7 +391,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
391
391
|
addManyDealProducts(id: number, CreateManyDealProductRequest?: CreateManyDealProductRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddManyDealProductResponse>>;
|
|
392
392
|
/**
|
|
393
393
|
* 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.
|
|
394
|
-
* @summary Convert a deal to a lead
|
|
394
|
+
* @summary Convert a deal to a lead
|
|
395
395
|
* @param {number} id The ID of the deal to convert
|
|
396
396
|
|
|
397
397
|
* @throws {RequiredError}
|
|
@@ -493,7 +493,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
493
493
|
getDeal(id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email', custom_fields?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertDealResponse>>;
|
|
494
494
|
/**
|
|
495
495
|
* 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.
|
|
496
|
-
* @summary Get Deal conversion status
|
|
496
|
+
* @summary Get Deal conversion status
|
|
497
497
|
* @param {number} id The ID of a deal
|
|
498
498
|
* @param {string} conversion_id The ID of the conversion
|
|
499
499
|
|
|
@@ -692,7 +692,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
692
692
|
addManyDealProducts(requestParameters: DealsApiAddManyDealProductsRequest): Promise<AddManyDealProductResponse>;
|
|
693
693
|
/**
|
|
694
694
|
* 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.
|
|
695
|
-
* @summary Convert a deal to a lead
|
|
695
|
+
* @summary Convert a deal to a lead
|
|
696
696
|
* @param {DealsApiConvertDealToLeadRequest} requestParameters Request parameters.
|
|
697
697
|
|
|
698
698
|
* @throws {RequiredError}
|
|
@@ -772,7 +772,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
772
772
|
getDeal(requestParameters: DealsApiGetDealRequest): Promise<UpsertDealResponse>;
|
|
773
773
|
/**
|
|
774
774
|
* 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.
|
|
775
|
-
* @summary Get Deal conversion status
|
|
775
|
+
* @summary Get Deal conversion status
|
|
776
776
|
* @param {DealsApiGetDealConversionStatusRequest} requestParameters Request parameters.
|
|
777
777
|
|
|
778
778
|
* @throws {RequiredError}
|
|
@@ -1736,7 +1736,7 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1736
1736
|
addManyDealProducts(requestParameters: DealsApiAddManyDealProductsRequest): Promise<AddManyDealProductResponse>;
|
|
1737
1737
|
/**
|
|
1738
1738
|
* 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.
|
|
1739
|
-
* @summary Convert a deal to a lead
|
|
1739
|
+
* @summary Convert a deal to a lead
|
|
1740
1740
|
* @param {DealsApiConvertDealToLeadRequest} requestParameters Request parameters.
|
|
1741
1741
|
|
|
1742
1742
|
* @throws {RequiredError}
|
|
@@ -1826,7 +1826,7 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1826
1826
|
getDeal(requestParameters: DealsApiGetDealRequest): Promise<UpsertDealResponse>;
|
|
1827
1827
|
/**
|
|
1828
1828
|
* 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.
|
|
1829
|
-
* @summary Get Deal conversion status
|
|
1829
|
+
* @summary Get Deal conversion status
|
|
1830
1830
|
* @param {DealsApiGetDealConversionStatusRequest} requestParameters Request parameters.
|
|
1831
1831
|
|
|
1832
1832
|
* @throws {RequiredError}
|
|
@@ -184,7 +184,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
184
184
|
}),
|
|
185
185
|
/**
|
|
186
186
|
* 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.
|
|
187
|
-
* @summary Convert a deal to a lead
|
|
187
|
+
* @summary Convert a deal to a lead
|
|
188
188
|
* @param {number} id The ID of the deal to convert
|
|
189
189
|
|
|
190
190
|
* @throws {RequiredError}
|
|
@@ -612,7 +612,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
612
612
|
}),
|
|
613
613
|
/**
|
|
614
614
|
* 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.
|
|
615
|
-
* @summary Get Deal conversion status
|
|
615
|
+
* @summary Get Deal conversion status
|
|
616
616
|
* @param {number} id The ID of a deal
|
|
617
617
|
* @param {string} conversion_id The ID of the conversion
|
|
618
618
|
|
|
@@ -1349,7 +1349,7 @@ const DealsApiFp = function (configuration) {
|
|
|
1349
1349
|
},
|
|
1350
1350
|
/**
|
|
1351
1351
|
* 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.
|
|
1352
|
-
* @summary Convert a deal to a lead
|
|
1352
|
+
* @summary Convert a deal to a lead
|
|
1353
1353
|
* @param {number} id The ID of the deal to convert
|
|
1354
1354
|
|
|
1355
1355
|
* @throws {RequiredError}
|
|
@@ -1501,7 +1501,7 @@ const DealsApiFp = function (configuration) {
|
|
|
1501
1501
|
},
|
|
1502
1502
|
/**
|
|
1503
1503
|
* 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.
|
|
1504
|
-
* @summary Get Deal conversion status
|
|
1504
|
+
* @summary Get Deal conversion status
|
|
1505
1505
|
* @param {number} id The ID of a deal
|
|
1506
1506
|
* @param {string} conversion_id The ID of the conversion
|
|
1507
1507
|
|
|
@@ -1782,7 +1782,7 @@ const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1782
1782
|
},
|
|
1783
1783
|
/**
|
|
1784
1784
|
* 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.
|
|
1785
|
-
* @summary Convert a deal to a lead
|
|
1785
|
+
* @summary Convert a deal to a lead
|
|
1786
1786
|
* @param {DealsApiConvertDealToLeadRequest} requestParameters Request parameters.
|
|
1787
1787
|
|
|
1788
1788
|
* @throws {RequiredError}
|
|
@@ -1882,7 +1882,7 @@ const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1882
1882
|
},
|
|
1883
1883
|
/**
|
|
1884
1884
|
* 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.
|
|
1885
|
-
* @summary Get Deal conversion status
|
|
1885
|
+
* @summary Get Deal conversion status
|
|
1886
1886
|
* @param {DealsApiGetDealConversionStatusRequest} requestParameters Request parameters.
|
|
1887
1887
|
|
|
1888
1888
|
* @throws {RequiredError}
|
|
@@ -2076,7 +2076,7 @@ class DealsApi extends base_1.BaseAPI {
|
|
|
2076
2076
|
}
|
|
2077
2077
|
/**
|
|
2078
2078
|
* 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.
|
|
2079
|
-
* @summary Convert a deal to a lead
|
|
2079
|
+
* @summary Convert a deal to a lead
|
|
2080
2080
|
* @param {DealsApiConvertDealToLeadRequest} requestParameters Request parameters.
|
|
2081
2081
|
|
|
2082
2082
|
* @throws {RequiredError}
|
|
@@ -2186,7 +2186,7 @@ class DealsApi extends base_1.BaseAPI {
|
|
|
2186
2186
|
}
|
|
2187
2187
|
/**
|
|
2188
2188
|
* 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.
|
|
2189
|
-
* @summary Get Deal conversion status
|
|
2189
|
+
* @summary Get Deal conversion status
|
|
2190
2190
|
* @param {DealsApiGetDealConversionStatusRequest} requestParameters Request parameters.
|
|
2191
2191
|
|
|
2192
2192
|
* @throws {RequiredError}
|
|
@@ -23,7 +23,7 @@ import { GetLeadSearchResponse } from '../models';
|
|
|
23
23
|
export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
24
|
/**
|
|
25
25
|
* 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.
|
|
26
|
-
* @summary Convert a lead to a deal
|
|
26
|
+
* @summary Convert a lead to a deal
|
|
27
27
|
* @param {string} id The ID of the lead to convert
|
|
28
28
|
* @param {ConvertLeadToDealRequest} [ConvertLeadToDealRequest]
|
|
29
29
|
|
|
@@ -32,7 +32,7 @@ export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
32
32
|
convertLeadToDeal: (id: string, ConvertLeadToDealRequest?: ConvertLeadToDealRequest) => Promise<RequestArgs>;
|
|
33
33
|
/**
|
|
34
34
|
* 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.
|
|
35
|
-
* @summary Get Lead conversion status
|
|
35
|
+
* @summary Get Lead conversion status
|
|
36
36
|
* @param {string} id The ID of a lead
|
|
37
37
|
* @param {string} conversion_id The ID of the conversion
|
|
38
38
|
|
|
@@ -62,7 +62,7 @@ export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
62
62
|
export declare const LeadsApiFp: (configuration?: Configuration) => {
|
|
63
63
|
/**
|
|
64
64
|
* 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.
|
|
65
|
-
* @summary Convert a lead to a deal
|
|
65
|
+
* @summary Convert a lead to a deal
|
|
66
66
|
* @param {string} id The ID of the lead to convert
|
|
67
67
|
* @param {ConvertLeadToDealRequest} [ConvertLeadToDealRequest]
|
|
68
68
|
|
|
@@ -71,7 +71,7 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
|
|
|
71
71
|
convertLeadToDeal(id: string, ConvertLeadToDealRequest?: ConvertLeadToDealRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddConvertLeadToDealResponse>>;
|
|
72
72
|
/**
|
|
73
73
|
* 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.
|
|
74
|
-
* @summary Get Lead conversion status
|
|
74
|
+
* @summary Get Lead conversion status
|
|
75
75
|
* @param {string} id The ID of a lead
|
|
76
76
|
* @param {string} conversion_id The ID of the conversion
|
|
77
77
|
|
|
@@ -101,7 +101,7 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
|
|
|
101
101
|
export declare const LeadsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
102
102
|
/**
|
|
103
103
|
* 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.
|
|
104
|
-
* @summary Convert a lead to a deal
|
|
104
|
+
* @summary Convert a lead to a deal
|
|
105
105
|
* @param {LeadsApiConvertLeadToDealRequest} requestParameters Request parameters.
|
|
106
106
|
|
|
107
107
|
* @throws {RequiredError}
|
|
@@ -109,7 +109,7 @@ export declare const LeadsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
109
109
|
convertLeadToDeal(requestParameters: LeadsApiConvertLeadToDealRequest): Promise<AddConvertLeadToDealResponse>;
|
|
110
110
|
/**
|
|
111
111
|
* 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.
|
|
112
|
-
* @summary Get Lead conversion status
|
|
112
|
+
* @summary Get Lead conversion status
|
|
113
113
|
* @param {LeadsApiGetLeadConversionStatusRequest} requestParameters Request parameters.
|
|
114
114
|
|
|
115
115
|
* @throws {RequiredError}
|
|
@@ -226,7 +226,7 @@ export interface LeadsApiSearchLeadsRequest {
|
|
|
226
226
|
export declare class LeadsApi extends BaseAPI {
|
|
227
227
|
/**
|
|
228
228
|
* 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.
|
|
229
|
-
* @summary Convert a lead to a deal
|
|
229
|
+
* @summary Convert a lead to a deal
|
|
230
230
|
* @param {LeadsApiConvertLeadToDealRequest} requestParameters Request parameters.
|
|
231
231
|
|
|
232
232
|
* @throws {RequiredError}
|
|
@@ -235,7 +235,7 @@ export declare class LeadsApi extends BaseAPI {
|
|
|
235
235
|
convertLeadToDeal(requestParameters: LeadsApiConvertLeadToDealRequest): Promise<AddConvertLeadToDealResponse>;
|
|
236
236
|
/**
|
|
237
237
|
* 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.
|
|
238
|
-
* @summary Get Lead conversion status
|
|
238
|
+
* @summary Get Lead conversion status
|
|
239
239
|
* @param {LeadsApiGetLeadConversionStatusRequest} requestParameters Request parameters.
|
|
240
240
|
|
|
241
241
|
* @throws {RequiredError}
|
|
@@ -40,7 +40,7 @@ const LeadsApiAxiosParamCreator = function (configuration) {
|
|
|
40
40
|
return {
|
|
41
41
|
/**
|
|
42
42
|
* 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.
|
|
43
|
-
* @summary Convert a lead to a deal
|
|
43
|
+
* @summary Convert a lead to a deal
|
|
44
44
|
* @param {string} id The ID of the lead to convert
|
|
45
45
|
* @param {ConvertLeadToDealRequest} [ConvertLeadToDealRequest]
|
|
46
46
|
|
|
@@ -77,7 +77,7 @@ const LeadsApiAxiosParamCreator = function (configuration) {
|
|
|
77
77
|
}),
|
|
78
78
|
/**
|
|
79
79
|
* 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.
|
|
80
|
-
* @summary Get Lead conversion status
|
|
80
|
+
* @summary Get Lead conversion status
|
|
81
81
|
* @param {string} id The ID of a lead
|
|
82
82
|
* @param {string} conversion_id The ID of the conversion
|
|
83
83
|
|
|
@@ -189,7 +189,7 @@ const LeadsApiFp = function (configuration) {
|
|
|
189
189
|
return {
|
|
190
190
|
/**
|
|
191
191
|
* 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.
|
|
192
|
-
* @summary Convert a lead to a deal
|
|
192
|
+
* @summary Convert a lead to a deal
|
|
193
193
|
* @param {string} id The ID of the lead to convert
|
|
194
194
|
* @param {ConvertLeadToDealRequest} [ConvertLeadToDealRequest]
|
|
195
195
|
|
|
@@ -203,7 +203,7 @@ const LeadsApiFp = function (configuration) {
|
|
|
203
203
|
},
|
|
204
204
|
/**
|
|
205
205
|
* 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.
|
|
206
|
-
* @summary Get Lead conversion status
|
|
206
|
+
* @summary Get Lead conversion status
|
|
207
207
|
* @param {string} id The ID of a lead
|
|
208
208
|
* @param {string} conversion_id The ID of the conversion
|
|
209
209
|
|
|
@@ -247,7 +247,7 @@ const LeadsApiFactory = function (configuration, basePath, axios) {
|
|
|
247
247
|
return {
|
|
248
248
|
/**
|
|
249
249
|
* 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.
|
|
250
|
-
* @summary Convert a lead to a deal
|
|
250
|
+
* @summary Convert a lead to a deal
|
|
251
251
|
* @param {LeadsApiConvertLeadToDealRequest} requestParameters Request parameters.
|
|
252
252
|
|
|
253
253
|
* @throws {RequiredError}
|
|
@@ -257,7 +257,7 @@ const LeadsApiFactory = function (configuration, basePath, axios) {
|
|
|
257
257
|
},
|
|
258
258
|
/**
|
|
259
259
|
* 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.
|
|
260
|
-
* @summary Get Lead conversion status
|
|
260
|
+
* @summary Get Lead conversion status
|
|
261
261
|
* @param {LeadsApiGetLeadConversionStatusRequest} requestParameters Request parameters.
|
|
262
262
|
|
|
263
263
|
* @throws {RequiredError}
|
|
@@ -287,7 +287,7 @@ exports.LeadsApiFactory = LeadsApiFactory;
|
|
|
287
287
|
class LeadsApi extends base_1.BaseAPI {
|
|
288
288
|
/**
|
|
289
289
|
* 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.
|
|
290
|
-
* @summary Convert a lead to a deal
|
|
290
|
+
* @summary Convert a lead to a deal
|
|
291
291
|
* @param {LeadsApiConvertLeadToDealRequest} requestParameters Request parameters.
|
|
292
292
|
|
|
293
293
|
* @throws {RequiredError}
|
|
@@ -298,7 +298,7 @@ class LeadsApi extends base_1.BaseAPI {
|
|
|
298
298
|
}
|
|
299
299
|
/**
|
|
300
300
|
* 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.
|
|
301
|
-
* @summary Get Lead conversion status
|
|
301
|
+
* @summary Get Lead conversion status
|
|
302
302
|
* @param {LeadsApiGetLeadConversionStatusRequest} requestParameters Request parameters.
|
|
303
303
|
|
|
304
304
|
* @throws {RequiredError}
|
package/dist/versions/v2/api.js
CHANGED
|
@@ -29,7 +29,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
29
29
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
30
30
|
__exportStar(require("./api/activities-api"), exports);
|
|
31
31
|
__exportStar(require("./api/activity-fields-api"), exports);
|
|
32
|
-
__exportStar(require("./api/beta-api"), exports);
|
|
33
32
|
__exportStar(require("./api/deal-fields-api"), exports);
|
|
34
33
|
__exportStar(require("./api/deals-api"), exports);
|
|
35
34
|
__exportStar(require("./api/item-search-api"), exports);
|