pipedrive 31.0.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/v1/api/leads-api.d.ts +10 -2
- package/dist/esm/versions/v1/api/leads-api.js +10 -5
- package/dist/esm/versions/v1/api/notes-api.d.ts +10 -2
- package/dist/esm/versions/v1/api/notes-api.js +12 -5
- 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/v1/api/leads-api.d.ts +10 -2
- package/dist/versions/v1/api/leads-api.js +10 -5
- package/dist/versions/v1/api/notes-api.d.ts +10 -2
- package/dist/versions/v1/api/notes-api.js +12 -5
- 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
|
@@ -79,11 +79,12 @@ export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
79
79
|
* @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
|
|
80
80
|
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
|
81
81
|
* @param {number} [filter_id] The ID of the filter to use
|
|
82
|
+
* @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
82
83
|
* @param {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
|
83
84
|
|
|
84
85
|
* @throws {RequiredError}
|
|
85
86
|
*/
|
|
86
|
-
getLeads: (limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, sort?: 'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time') => Promise<RequestArgs>;
|
|
87
|
+
getLeads: (limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, updated_since?: string, sort?: 'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time') => Promise<RequestArgs>;
|
|
87
88
|
/**
|
|
88
89
|
* Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
|
|
89
90
|
* @summary Search leads
|
|
@@ -169,11 +170,12 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
|
|
|
169
170
|
* @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
|
|
170
171
|
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
|
171
172
|
* @param {number} [filter_id] The ID of the filter to use
|
|
173
|
+
* @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
172
174
|
* @param {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
|
173
175
|
|
|
174
176
|
* @throws {RequiredError}
|
|
175
177
|
*/
|
|
176
|
-
getLeads(limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, sort?: 'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadsResponse>>;
|
|
178
|
+
getLeads(limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, updated_since?: string, sort?: 'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadsResponse>>;
|
|
177
179
|
/**
|
|
178
180
|
* Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
|
|
179
181
|
* @summary Search leads
|
|
@@ -412,6 +414,12 @@ export interface LeadsApiGetLeadsRequest {
|
|
|
412
414
|
* @memberof LeadsApiGetLeads
|
|
413
415
|
*/
|
|
414
416
|
readonly filter_id?: number;
|
|
417
|
+
/**
|
|
418
|
+
* If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
419
|
+
* @type {string}
|
|
420
|
+
* @memberof LeadsApiGetLeads
|
|
421
|
+
*/
|
|
422
|
+
readonly updated_since?: string;
|
|
415
423
|
/**
|
|
416
424
|
* The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
|
417
425
|
* @type {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'}
|
|
@@ -234,11 +234,12 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
|
|
|
234
234
|
* @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
|
|
235
235
|
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
|
236
236
|
* @param {number} [filter_id] The ID of the filter to use
|
|
237
|
+
* @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
237
238
|
* @param {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
|
238
239
|
|
|
239
240
|
* @throws {RequiredError}
|
|
240
241
|
*/
|
|
241
|
-
getLeads: (limit, start, owner_id, person_id, organization_id, filter_id, sort) => __awaiter(this, void 0, void 0, function* () {
|
|
242
|
+
getLeads: (limit, start, owner_id, person_id, organization_id, filter_id, updated_since, sort) => __awaiter(this, void 0, void 0, function* () {
|
|
242
243
|
const localVarPath = `/leads`;
|
|
243
244
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
244
245
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -272,6 +273,9 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
|
|
|
272
273
|
if (filter_id !== undefined) {
|
|
273
274
|
localVarQueryParameter['filter_id'] = filter_id;
|
|
274
275
|
}
|
|
276
|
+
if (updated_since !== undefined) {
|
|
277
|
+
localVarQueryParameter['updated_since'] = updated_since;
|
|
278
|
+
}
|
|
275
279
|
if (sort !== undefined) {
|
|
276
280
|
localVarQueryParameter['sort'] = sort;
|
|
277
281
|
}
|
|
@@ -473,13 +477,14 @@ export const LeadsApiFp = function (configuration) {
|
|
|
473
477
|
* @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
|
|
474
478
|
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
|
475
479
|
* @param {number} [filter_id] The ID of the filter to use
|
|
480
|
+
* @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
476
481
|
* @param {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
|
477
482
|
|
|
478
483
|
* @throws {RequiredError}
|
|
479
484
|
*/
|
|
480
|
-
getLeads(limit, start, owner_id, person_id, organization_id, filter_id, sort) {
|
|
485
|
+
getLeads(limit, start, owner_id, person_id, organization_id, filter_id, updated_since, sort) {
|
|
481
486
|
return __awaiter(this, void 0, void 0, function* () {
|
|
482
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getLeads(limit, start, owner_id, person_id, organization_id, filter_id, sort);
|
|
487
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getLeads(limit, start, owner_id, person_id, organization_id, filter_id, updated_since, sort);
|
|
483
488
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
484
489
|
});
|
|
485
490
|
},
|
|
@@ -584,7 +589,7 @@ export const LeadsApiFactory = function (configuration, basePath, axios) {
|
|
|
584
589
|
* @throws {RequiredError}
|
|
585
590
|
*/
|
|
586
591
|
getLeads(requestParameters = {}) {
|
|
587
|
-
return localVarFp.getLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(axios, basePath));
|
|
592
|
+
return localVarFp.getLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.updated_since, requestParameters.sort).then((request) => request(axios, basePath));
|
|
588
593
|
},
|
|
589
594
|
/**
|
|
590
595
|
* Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
|
|
@@ -679,7 +684,7 @@ export class LeadsApi extends BaseAPI {
|
|
|
679
684
|
* @memberof LeadsApi
|
|
680
685
|
*/
|
|
681
686
|
getLeads(requestParameters = {}) {
|
|
682
|
-
return LeadsApiFp(this.configuration).getLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(this.axios, this.basePath));
|
|
687
|
+
return LeadsApiFp(this.configuration).getLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.updated_since, requestParameters.sort).then((request) => request(this.axios, this.basePath));
|
|
683
688
|
}
|
|
684
689
|
/**
|
|
685
690
|
* Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
|
|
@@ -101,6 +101,7 @@ export declare const NotesApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
101
101
|
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `content`, `add_time`, `update_time`.
|
|
102
102
|
* @param {string} [start_date] The date in format of YYYY-MM-DD from which notes to fetch
|
|
103
103
|
* @param {string} [end_date] The date in format of YYYY-MM-DD until which notes to fetch to
|
|
104
|
+
* @param {string} [updated_since] If set, only notes with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
104
105
|
* @param {0 | 1} [pinned_to_lead_flag] If set, the results are filtered by note to lead pinning state
|
|
105
106
|
* @param {0 | 1} [pinned_to_deal_flag] If set, the results are filtered by note to deal pinning state
|
|
106
107
|
* @param {0 | 1} [pinned_to_organization_flag] If set, the results are filtered by note to organization pinning state
|
|
@@ -109,7 +110,7 @@ export declare const NotesApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
109
110
|
|
|
110
111
|
* @throws {RequiredError}
|
|
111
112
|
*/
|
|
112
|
-
getNotes: (user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_id?: number, project_id?: number, start?: number, limit?: number, sort?: string, start_date?: string, end_date?: string, pinned_to_lead_flag?: 0 | 1, pinned_to_deal_flag?: 0 | 1, pinned_to_organization_flag?: 0 | 1, pinned_to_person_flag?: 0 | 1, pinned_to_project_flag?: 0 | 1) => Promise<RequestArgs>;
|
|
113
|
+
getNotes: (user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_id?: number, project_id?: number, start?: number, limit?: number, sort?: string, start_date?: string, end_date?: string, updated_since?: string, pinned_to_lead_flag?: 0 | 1, pinned_to_deal_flag?: 0 | 1, pinned_to_organization_flag?: 0 | 1, pinned_to_person_flag?: 0 | 1, pinned_to_project_flag?: 0 | 1) => Promise<RequestArgs>;
|
|
113
114
|
/**
|
|
114
115
|
* Updates a comment related to a note.
|
|
115
116
|
* @summary Update a comment related to a note
|
|
@@ -210,6 +211,7 @@ export declare const NotesApiFp: (configuration?: Configuration) => {
|
|
|
210
211
|
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `content`, `add_time`, `update_time`.
|
|
211
212
|
* @param {string} [start_date] The date in format of YYYY-MM-DD from which notes to fetch
|
|
212
213
|
* @param {string} [end_date] The date in format of YYYY-MM-DD until which notes to fetch to
|
|
214
|
+
* @param {string} [updated_since] If set, only notes with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
213
215
|
* @param {0 | 1} [pinned_to_lead_flag] If set, the results are filtered by note to lead pinning state
|
|
214
216
|
* @param {0 | 1} [pinned_to_deal_flag] If set, the results are filtered by note to deal pinning state
|
|
215
217
|
* @param {0 | 1} [pinned_to_organization_flag] If set, the results are filtered by note to organization pinning state
|
|
@@ -218,7 +220,7 @@ export declare const NotesApiFp: (configuration?: Configuration) => {
|
|
|
218
220
|
|
|
219
221
|
* @throws {RequiredError}
|
|
220
222
|
*/
|
|
221
|
-
getNotes(user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_id?: number, project_id?: number, start?: number, limit?: number, sort?: string, start_date?: string, end_date?: string, pinned_to_lead_flag?: 0 | 1, pinned_to_deal_flag?: 0 | 1, pinned_to_organization_flag?: 0 | 1, pinned_to_person_flag?: 0 | 1, pinned_to_project_flag?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetNotesResponse>>;
|
|
223
|
+
getNotes(user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_id?: number, project_id?: number, start?: number, limit?: number, sort?: string, start_date?: string, end_date?: string, updated_since?: string, pinned_to_lead_flag?: 0 | 1, pinned_to_deal_flag?: 0 | 1, pinned_to_organization_flag?: 0 | 1, pinned_to_person_flag?: 0 | 1, pinned_to_project_flag?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetNotesResponse>>;
|
|
222
224
|
/**
|
|
223
225
|
* Updates a comment related to a note.
|
|
224
226
|
* @summary Update a comment related to a note
|
|
@@ -518,6 +520,12 @@ export interface NotesApiGetNotesRequest {
|
|
|
518
520
|
* @memberof NotesApiGetNotes
|
|
519
521
|
*/
|
|
520
522
|
readonly end_date?: string;
|
|
523
|
+
/**
|
|
524
|
+
* If set, only notes with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
525
|
+
* @type {string}
|
|
526
|
+
* @memberof NotesApiGetNotes
|
|
527
|
+
*/
|
|
528
|
+
readonly updated_since?: string;
|
|
521
529
|
/**
|
|
522
530
|
* If set, the results are filtered by note to lead pinning state
|
|
523
531
|
* @type {0 | 1}
|
|
@@ -302,6 +302,7 @@ export const NotesApiAxiosParamCreator = function (configuration) {
|
|
|
302
302
|
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `content`, `add_time`, `update_time`.
|
|
303
303
|
* @param {string} [start_date] The date in format of YYYY-MM-DD from which notes to fetch
|
|
304
304
|
* @param {string} [end_date] The date in format of YYYY-MM-DD until which notes to fetch to
|
|
305
|
+
* @param {string} [updated_since] If set, only notes with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
305
306
|
* @param {0 | 1} [pinned_to_lead_flag] If set, the results are filtered by note to lead pinning state
|
|
306
307
|
* @param {0 | 1} [pinned_to_deal_flag] If set, the results are filtered by note to deal pinning state
|
|
307
308
|
* @param {0 | 1} [pinned_to_organization_flag] If set, the results are filtered by note to organization pinning state
|
|
@@ -310,7 +311,7 @@ export const NotesApiAxiosParamCreator = function (configuration) {
|
|
|
310
311
|
|
|
311
312
|
* @throws {RequiredError}
|
|
312
313
|
*/
|
|
313
|
-
getNotes: (user_id, lead_id, deal_id, person_id, org_id, project_id, start, limit, sort, start_date, end_date, pinned_to_lead_flag, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag, pinned_to_project_flag) => __awaiter(this, void 0, void 0, function* () {
|
|
314
|
+
getNotes: (user_id, lead_id, deal_id, person_id, org_id, project_id, start, limit, sort, start_date, end_date, updated_since, pinned_to_lead_flag, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag, pinned_to_project_flag) => __awaiter(this, void 0, void 0, function* () {
|
|
314
315
|
const localVarPath = `/notes`;
|
|
315
316
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
316
317
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -363,6 +364,11 @@ export const NotesApiAxiosParamCreator = function (configuration) {
|
|
|
363
364
|
end_date.toISOString().substr(0, 10) :
|
|
364
365
|
end_date;
|
|
365
366
|
}
|
|
367
|
+
if (updated_since !== undefined) {
|
|
368
|
+
localVarQueryParameter['updated_since'] = (updated_since instanceof Date) ?
|
|
369
|
+
updated_since.toISOString() :
|
|
370
|
+
updated_since;
|
|
371
|
+
}
|
|
366
372
|
if (pinned_to_lead_flag !== undefined) {
|
|
367
373
|
localVarQueryParameter['pinned_to_lead_flag'] = pinned_to_lead_flag;
|
|
368
374
|
}
|
|
@@ -583,6 +589,7 @@ export const NotesApiFp = function (configuration) {
|
|
|
583
589
|
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `content`, `add_time`, `update_time`.
|
|
584
590
|
* @param {string} [start_date] The date in format of YYYY-MM-DD from which notes to fetch
|
|
585
591
|
* @param {string} [end_date] The date in format of YYYY-MM-DD until which notes to fetch to
|
|
592
|
+
* @param {string} [updated_since] If set, only notes with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
586
593
|
* @param {0 | 1} [pinned_to_lead_flag] If set, the results are filtered by note to lead pinning state
|
|
587
594
|
* @param {0 | 1} [pinned_to_deal_flag] If set, the results are filtered by note to deal pinning state
|
|
588
595
|
* @param {0 | 1} [pinned_to_organization_flag] If set, the results are filtered by note to organization pinning state
|
|
@@ -591,9 +598,9 @@ export const NotesApiFp = function (configuration) {
|
|
|
591
598
|
|
|
592
599
|
* @throws {RequiredError}
|
|
593
600
|
*/
|
|
594
|
-
getNotes(user_id, lead_id, deal_id, person_id, org_id, project_id, start, limit, sort, start_date, end_date, pinned_to_lead_flag, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag, pinned_to_project_flag) {
|
|
601
|
+
getNotes(user_id, lead_id, deal_id, person_id, org_id, project_id, start, limit, sort, start_date, end_date, updated_since, pinned_to_lead_flag, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag, pinned_to_project_flag) {
|
|
595
602
|
return __awaiter(this, void 0, void 0, function* () {
|
|
596
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getNotes(user_id, lead_id, deal_id, person_id, org_id, project_id, start, limit, sort, start_date, end_date, pinned_to_lead_flag, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag, pinned_to_project_flag);
|
|
603
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getNotes(user_id, lead_id, deal_id, person_id, org_id, project_id, start, limit, sort, start_date, end_date, updated_since, pinned_to_lead_flag, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag, pinned_to_project_flag);
|
|
597
604
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
598
605
|
});
|
|
599
606
|
},
|
|
@@ -713,7 +720,7 @@ export const NotesApiFactory = function (configuration, basePath, axios) {
|
|
|
713
720
|
* @throws {RequiredError}
|
|
714
721
|
*/
|
|
715
722
|
getNotes(requestParameters = {}) {
|
|
716
|
-
return localVarFp.getNotes(requestParameters.user_id, requestParameters.lead_id, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.project_id, requestParameters.start, requestParameters.limit, requestParameters.sort, requestParameters.start_date, requestParameters.end_date, requestParameters.pinned_to_lead_flag, requestParameters.pinned_to_deal_flag, requestParameters.pinned_to_organization_flag, requestParameters.pinned_to_person_flag, requestParameters.pinned_to_project_flag).then((request) => request(axios, basePath));
|
|
723
|
+
return localVarFp.getNotes(requestParameters.user_id, requestParameters.lead_id, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.project_id, requestParameters.start, requestParameters.limit, requestParameters.sort, requestParameters.start_date, requestParameters.end_date, requestParameters.updated_since, requestParameters.pinned_to_lead_flag, requestParameters.pinned_to_deal_flag, requestParameters.pinned_to_organization_flag, requestParameters.pinned_to_person_flag, requestParameters.pinned_to_project_flag).then((request) => request(axios, basePath));
|
|
717
724
|
},
|
|
718
725
|
/**
|
|
719
726
|
* Updates a comment related to a note.
|
|
@@ -830,7 +837,7 @@ export class NotesApi extends BaseAPI {
|
|
|
830
837
|
* @memberof NotesApi
|
|
831
838
|
*/
|
|
832
839
|
getNotes(requestParameters = {}) {
|
|
833
|
-
return NotesApiFp(this.configuration).getNotes(requestParameters.user_id, requestParameters.lead_id, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.project_id, requestParameters.start, requestParameters.limit, requestParameters.sort, requestParameters.start_date, requestParameters.end_date, requestParameters.pinned_to_lead_flag, requestParameters.pinned_to_deal_flag, requestParameters.pinned_to_organization_flag, requestParameters.pinned_to_person_flag, requestParameters.pinned_to_project_flag).then((request) => request(this.axios, this.basePath));
|
|
840
|
+
return NotesApiFp(this.configuration).getNotes(requestParameters.user_id, requestParameters.lead_id, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.project_id, requestParameters.start, requestParameters.limit, requestParameters.sort, requestParameters.start_date, requestParameters.end_date, requestParameters.updated_since, requestParameters.pinned_to_lead_flag, requestParameters.pinned_to_deal_flag, requestParameters.pinned_to_organization_flag, requestParameters.pinned_to_person_flag, requestParameters.pinned_to_project_flag).then((request) => request(this.axios, this.basePath));
|
|
834
841
|
}
|
|
835
842
|
/**
|
|
836
843
|
* Updates a comment related to a note.
|
|
@@ -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}
|
|
@@ -79,11 +79,12 @@ export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
79
79
|
* @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
|
|
80
80
|
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
|
81
81
|
* @param {number} [filter_id] The ID of the filter to use
|
|
82
|
+
* @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
82
83
|
* @param {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
|
83
84
|
|
|
84
85
|
* @throws {RequiredError}
|
|
85
86
|
*/
|
|
86
|
-
getLeads: (limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, sort?: 'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time') => Promise<RequestArgs>;
|
|
87
|
+
getLeads: (limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, updated_since?: string, sort?: 'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time') => Promise<RequestArgs>;
|
|
87
88
|
/**
|
|
88
89
|
* Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
|
|
89
90
|
* @summary Search leads
|
|
@@ -169,11 +170,12 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
|
|
|
169
170
|
* @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
|
|
170
171
|
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
|
171
172
|
* @param {number} [filter_id] The ID of the filter to use
|
|
173
|
+
* @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
172
174
|
* @param {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
|
173
175
|
|
|
174
176
|
* @throws {RequiredError}
|
|
175
177
|
*/
|
|
176
|
-
getLeads(limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, sort?: 'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadsResponse>>;
|
|
178
|
+
getLeads(limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, updated_since?: string, sort?: 'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadsResponse>>;
|
|
177
179
|
/**
|
|
178
180
|
* Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
|
|
179
181
|
* @summary Search leads
|
|
@@ -412,6 +414,12 @@ export interface LeadsApiGetLeadsRequest {
|
|
|
412
414
|
* @memberof LeadsApiGetLeads
|
|
413
415
|
*/
|
|
414
416
|
readonly filter_id?: number;
|
|
417
|
+
/**
|
|
418
|
+
* If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
419
|
+
* @type {string}
|
|
420
|
+
* @memberof LeadsApiGetLeads
|
|
421
|
+
*/
|
|
422
|
+
readonly updated_since?: string;
|
|
415
423
|
/**
|
|
416
424
|
* The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
|
417
425
|
* @type {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'}
|
|
@@ -240,11 +240,12 @@ const LeadsApiAxiosParamCreator = function (configuration) {
|
|
|
240
240
|
* @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
|
|
241
241
|
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
|
242
242
|
* @param {number} [filter_id] The ID of the filter to use
|
|
243
|
+
* @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
243
244
|
* @param {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
|
244
245
|
|
|
245
246
|
* @throws {RequiredError}
|
|
246
247
|
*/
|
|
247
|
-
getLeads: (limit, start, owner_id, person_id, organization_id, filter_id, sort) => __awaiter(this, void 0, void 0, function* () {
|
|
248
|
+
getLeads: (limit, start, owner_id, person_id, organization_id, filter_id, updated_since, sort) => __awaiter(this, void 0, void 0, function* () {
|
|
248
249
|
const localVarPath = `/leads`;
|
|
249
250
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
250
251
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -278,6 +279,9 @@ const LeadsApiAxiosParamCreator = function (configuration) {
|
|
|
278
279
|
if (filter_id !== undefined) {
|
|
279
280
|
localVarQueryParameter['filter_id'] = filter_id;
|
|
280
281
|
}
|
|
282
|
+
if (updated_since !== undefined) {
|
|
283
|
+
localVarQueryParameter['updated_since'] = updated_since;
|
|
284
|
+
}
|
|
281
285
|
if (sort !== undefined) {
|
|
282
286
|
localVarQueryParameter['sort'] = sort;
|
|
283
287
|
}
|
|
@@ -480,13 +484,14 @@ const LeadsApiFp = function (configuration) {
|
|
|
480
484
|
* @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
|
|
481
485
|
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
|
482
486
|
* @param {number} [filter_id] The ID of the filter to use
|
|
487
|
+
* @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
483
488
|
* @param {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
|
484
489
|
|
|
485
490
|
* @throws {RequiredError}
|
|
486
491
|
*/
|
|
487
|
-
getLeads(limit, start, owner_id, person_id, organization_id, filter_id, sort) {
|
|
492
|
+
getLeads(limit, start, owner_id, person_id, organization_id, filter_id, updated_since, sort) {
|
|
488
493
|
return __awaiter(this, void 0, void 0, function* () {
|
|
489
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getLeads(limit, start, owner_id, person_id, organization_id, filter_id, sort);
|
|
494
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getLeads(limit, start, owner_id, person_id, organization_id, filter_id, updated_since, sort);
|
|
490
495
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
491
496
|
});
|
|
492
497
|
},
|
|
@@ -592,7 +597,7 @@ const LeadsApiFactory = function (configuration, basePath, axios) {
|
|
|
592
597
|
* @throws {RequiredError}
|
|
593
598
|
*/
|
|
594
599
|
getLeads(requestParameters = {}) {
|
|
595
|
-
return localVarFp.getLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(axios, basePath));
|
|
600
|
+
return localVarFp.getLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.updated_since, requestParameters.sort).then((request) => request(axios, basePath));
|
|
596
601
|
},
|
|
597
602
|
/**
|
|
598
603
|
* Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
|
|
@@ -688,7 +693,7 @@ class LeadsApi extends base_1.BaseAPI {
|
|
|
688
693
|
* @memberof LeadsApi
|
|
689
694
|
*/
|
|
690
695
|
getLeads(requestParameters = {}) {
|
|
691
|
-
return (0, exports.LeadsApiFp)(this.configuration).getLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(this.axios, this.basePath));
|
|
696
|
+
return (0, exports.LeadsApiFp)(this.configuration).getLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.updated_since, requestParameters.sort).then((request) => request(this.axios, this.basePath));
|
|
692
697
|
}
|
|
693
698
|
/**
|
|
694
699
|
* Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
|
|
@@ -101,6 +101,7 @@ export declare const NotesApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
101
101
|
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `content`, `add_time`, `update_time`.
|
|
102
102
|
* @param {string} [start_date] The date in format of YYYY-MM-DD from which notes to fetch
|
|
103
103
|
* @param {string} [end_date] The date in format of YYYY-MM-DD until which notes to fetch to
|
|
104
|
+
* @param {string} [updated_since] If set, only notes with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
104
105
|
* @param {0 | 1} [pinned_to_lead_flag] If set, the results are filtered by note to lead pinning state
|
|
105
106
|
* @param {0 | 1} [pinned_to_deal_flag] If set, the results are filtered by note to deal pinning state
|
|
106
107
|
* @param {0 | 1} [pinned_to_organization_flag] If set, the results are filtered by note to organization pinning state
|
|
@@ -109,7 +110,7 @@ export declare const NotesApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
109
110
|
|
|
110
111
|
* @throws {RequiredError}
|
|
111
112
|
*/
|
|
112
|
-
getNotes: (user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_id?: number, project_id?: number, start?: number, limit?: number, sort?: string, start_date?: string, end_date?: string, pinned_to_lead_flag?: 0 | 1, pinned_to_deal_flag?: 0 | 1, pinned_to_organization_flag?: 0 | 1, pinned_to_person_flag?: 0 | 1, pinned_to_project_flag?: 0 | 1) => Promise<RequestArgs>;
|
|
113
|
+
getNotes: (user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_id?: number, project_id?: number, start?: number, limit?: number, sort?: string, start_date?: string, end_date?: string, updated_since?: string, pinned_to_lead_flag?: 0 | 1, pinned_to_deal_flag?: 0 | 1, pinned_to_organization_flag?: 0 | 1, pinned_to_person_flag?: 0 | 1, pinned_to_project_flag?: 0 | 1) => Promise<RequestArgs>;
|
|
113
114
|
/**
|
|
114
115
|
* Updates a comment related to a note.
|
|
115
116
|
* @summary Update a comment related to a note
|
|
@@ -210,6 +211,7 @@ export declare const NotesApiFp: (configuration?: Configuration) => {
|
|
|
210
211
|
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `content`, `add_time`, `update_time`.
|
|
211
212
|
* @param {string} [start_date] The date in format of YYYY-MM-DD from which notes to fetch
|
|
212
213
|
* @param {string} [end_date] The date in format of YYYY-MM-DD until which notes to fetch to
|
|
214
|
+
* @param {string} [updated_since] If set, only notes with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
213
215
|
* @param {0 | 1} [pinned_to_lead_flag] If set, the results are filtered by note to lead pinning state
|
|
214
216
|
* @param {0 | 1} [pinned_to_deal_flag] If set, the results are filtered by note to deal pinning state
|
|
215
217
|
* @param {0 | 1} [pinned_to_organization_flag] If set, the results are filtered by note to organization pinning state
|
|
@@ -218,7 +220,7 @@ export declare const NotesApiFp: (configuration?: Configuration) => {
|
|
|
218
220
|
|
|
219
221
|
* @throws {RequiredError}
|
|
220
222
|
*/
|
|
221
|
-
getNotes(user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_id?: number, project_id?: number, start?: number, limit?: number, sort?: string, start_date?: string, end_date?: string, pinned_to_lead_flag?: 0 | 1, pinned_to_deal_flag?: 0 | 1, pinned_to_organization_flag?: 0 | 1, pinned_to_person_flag?: 0 | 1, pinned_to_project_flag?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetNotesResponse>>;
|
|
223
|
+
getNotes(user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_id?: number, project_id?: number, start?: number, limit?: number, sort?: string, start_date?: string, end_date?: string, updated_since?: string, pinned_to_lead_flag?: 0 | 1, pinned_to_deal_flag?: 0 | 1, pinned_to_organization_flag?: 0 | 1, pinned_to_person_flag?: 0 | 1, pinned_to_project_flag?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetNotesResponse>>;
|
|
222
224
|
/**
|
|
223
225
|
* Updates a comment related to a note.
|
|
224
226
|
* @summary Update a comment related to a note
|
|
@@ -518,6 +520,12 @@ export interface NotesApiGetNotesRequest {
|
|
|
518
520
|
* @memberof NotesApiGetNotes
|
|
519
521
|
*/
|
|
520
522
|
readonly end_date?: string;
|
|
523
|
+
/**
|
|
524
|
+
* If set, only notes with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
525
|
+
* @type {string}
|
|
526
|
+
* @memberof NotesApiGetNotes
|
|
527
|
+
*/
|
|
528
|
+
readonly updated_since?: string;
|
|
521
529
|
/**
|
|
522
530
|
* If set, the results are filtered by note to lead pinning state
|
|
523
531
|
* @type {0 | 1}
|
|
@@ -308,6 +308,7 @@ const NotesApiAxiosParamCreator = function (configuration) {
|
|
|
308
308
|
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `content`, `add_time`, `update_time`.
|
|
309
309
|
* @param {string} [start_date] The date in format of YYYY-MM-DD from which notes to fetch
|
|
310
310
|
* @param {string} [end_date] The date in format of YYYY-MM-DD until which notes to fetch to
|
|
311
|
+
* @param {string} [updated_since] If set, only notes with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
311
312
|
* @param {0 | 1} [pinned_to_lead_flag] If set, the results are filtered by note to lead pinning state
|
|
312
313
|
* @param {0 | 1} [pinned_to_deal_flag] If set, the results are filtered by note to deal pinning state
|
|
313
314
|
* @param {0 | 1} [pinned_to_organization_flag] If set, the results are filtered by note to organization pinning state
|
|
@@ -316,7 +317,7 @@ const NotesApiAxiosParamCreator = function (configuration) {
|
|
|
316
317
|
|
|
317
318
|
* @throws {RequiredError}
|
|
318
319
|
*/
|
|
319
|
-
getNotes: (user_id, lead_id, deal_id, person_id, org_id, project_id, start, limit, sort, start_date, end_date, pinned_to_lead_flag, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag, pinned_to_project_flag) => __awaiter(this, void 0, void 0, function* () {
|
|
320
|
+
getNotes: (user_id, lead_id, deal_id, person_id, org_id, project_id, start, limit, sort, start_date, end_date, updated_since, pinned_to_lead_flag, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag, pinned_to_project_flag) => __awaiter(this, void 0, void 0, function* () {
|
|
320
321
|
const localVarPath = `/notes`;
|
|
321
322
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
322
323
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -369,6 +370,11 @@ const NotesApiAxiosParamCreator = function (configuration) {
|
|
|
369
370
|
end_date.toISOString().substr(0, 10) :
|
|
370
371
|
end_date;
|
|
371
372
|
}
|
|
373
|
+
if (updated_since !== undefined) {
|
|
374
|
+
localVarQueryParameter['updated_since'] = (updated_since instanceof Date) ?
|
|
375
|
+
updated_since.toISOString() :
|
|
376
|
+
updated_since;
|
|
377
|
+
}
|
|
372
378
|
if (pinned_to_lead_flag !== undefined) {
|
|
373
379
|
localVarQueryParameter['pinned_to_lead_flag'] = pinned_to_lead_flag;
|
|
374
380
|
}
|
|
@@ -590,6 +596,7 @@ const NotesApiFp = function (configuration) {
|
|
|
590
596
|
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `content`, `add_time`, `update_time`.
|
|
591
597
|
* @param {string} [start_date] The date in format of YYYY-MM-DD from which notes to fetch
|
|
592
598
|
* @param {string} [end_date] The date in format of YYYY-MM-DD until which notes to fetch to
|
|
599
|
+
* @param {string} [updated_since] If set, only notes with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
593
600
|
* @param {0 | 1} [pinned_to_lead_flag] If set, the results are filtered by note to lead pinning state
|
|
594
601
|
* @param {0 | 1} [pinned_to_deal_flag] If set, the results are filtered by note to deal pinning state
|
|
595
602
|
* @param {0 | 1} [pinned_to_organization_flag] If set, the results are filtered by note to organization pinning state
|
|
@@ -598,9 +605,9 @@ const NotesApiFp = function (configuration) {
|
|
|
598
605
|
|
|
599
606
|
* @throws {RequiredError}
|
|
600
607
|
*/
|
|
601
|
-
getNotes(user_id, lead_id, deal_id, person_id, org_id, project_id, start, limit, sort, start_date, end_date, pinned_to_lead_flag, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag, pinned_to_project_flag) {
|
|
608
|
+
getNotes(user_id, lead_id, deal_id, person_id, org_id, project_id, start, limit, sort, start_date, end_date, updated_since, pinned_to_lead_flag, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag, pinned_to_project_flag) {
|
|
602
609
|
return __awaiter(this, void 0, void 0, function* () {
|
|
603
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getNotes(user_id, lead_id, deal_id, person_id, org_id, project_id, start, limit, sort, start_date, end_date, pinned_to_lead_flag, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag, pinned_to_project_flag);
|
|
610
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getNotes(user_id, lead_id, deal_id, person_id, org_id, project_id, start, limit, sort, start_date, end_date, updated_since, pinned_to_lead_flag, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag, pinned_to_project_flag);
|
|
604
611
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
605
612
|
});
|
|
606
613
|
},
|
|
@@ -721,7 +728,7 @@ const NotesApiFactory = function (configuration, basePath, axios) {
|
|
|
721
728
|
* @throws {RequiredError}
|
|
722
729
|
*/
|
|
723
730
|
getNotes(requestParameters = {}) {
|
|
724
|
-
return localVarFp.getNotes(requestParameters.user_id, requestParameters.lead_id, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.project_id, requestParameters.start, requestParameters.limit, requestParameters.sort, requestParameters.start_date, requestParameters.end_date, requestParameters.pinned_to_lead_flag, requestParameters.pinned_to_deal_flag, requestParameters.pinned_to_organization_flag, requestParameters.pinned_to_person_flag, requestParameters.pinned_to_project_flag).then((request) => request(axios, basePath));
|
|
731
|
+
return localVarFp.getNotes(requestParameters.user_id, requestParameters.lead_id, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.project_id, requestParameters.start, requestParameters.limit, requestParameters.sort, requestParameters.start_date, requestParameters.end_date, requestParameters.updated_since, requestParameters.pinned_to_lead_flag, requestParameters.pinned_to_deal_flag, requestParameters.pinned_to_organization_flag, requestParameters.pinned_to_person_flag, requestParameters.pinned_to_project_flag).then((request) => request(axios, basePath));
|
|
725
732
|
},
|
|
726
733
|
/**
|
|
727
734
|
* Updates a comment related to a note.
|
|
@@ -839,7 +846,7 @@ class NotesApi extends base_1.BaseAPI {
|
|
|
839
846
|
* @memberof NotesApi
|
|
840
847
|
*/
|
|
841
848
|
getNotes(requestParameters = {}) {
|
|
842
|
-
return (0, exports.NotesApiFp)(this.configuration).getNotes(requestParameters.user_id, requestParameters.lead_id, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.project_id, requestParameters.start, requestParameters.limit, requestParameters.sort, requestParameters.start_date, requestParameters.end_date, requestParameters.pinned_to_lead_flag, requestParameters.pinned_to_deal_flag, requestParameters.pinned_to_organization_flag, requestParameters.pinned_to_person_flag, requestParameters.pinned_to_project_flag).then((request) => request(this.axios, this.basePath));
|
|
849
|
+
return (0, exports.NotesApiFp)(this.configuration).getNotes(requestParameters.user_id, requestParameters.lead_id, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.project_id, requestParameters.start, requestParameters.limit, requestParameters.sort, requestParameters.start_date, requestParameters.end_date, requestParameters.updated_since, requestParameters.pinned_to_lead_flag, requestParameters.pinned_to_deal_flag, requestParameters.pinned_to_organization_flag, requestParameters.pinned_to_person_flag, requestParameters.pinned_to_project_flag).then((request) => request(this.axios, this.basePath));
|
|
843
850
|
}
|
|
844
851
|
/**
|
|
845
852
|
* Updates a comment related to a note.
|
|
@@ -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);
|