pipedrive 31.0.0 → 31.1.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/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/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.
|
|
@@ -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.
|