pipedrive 30.11.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/activities-api.d.ts +0 -47
- package/dist/esm/versions/v1/api/activities-api.js +0 -70
- package/dist/esm/versions/v1/api/activity-types-api.d.ts +0 -47
- package/dist/esm/versions/v1/api/activity-types-api.js +0 -70
- package/dist/esm/versions/v1/api/deals-api.d.ts +0 -47
- package/dist/esm/versions/v1/api/deals-api.js +0 -70
- 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/v1/api/organizations-api.d.ts +0 -47
- package/dist/esm/versions/v1/api/organizations-api.js +0 -70
- package/dist/esm/versions/v1/api/persons-api.d.ts +0 -47
- package/dist/esm/versions/v1/api/persons-api.js +0 -70
- package/dist/esm/versions/v1/api/stages-api.d.ts +0 -47
- package/dist/esm/versions/v1/api/stages-api.js +0 -70
- package/dist/esm/versions/v1/models/add-deal-request.d.ts +2 -2
- package/dist/esm/versions/v1/models/add-task-request.d.ts +2 -2
- package/dist/esm/versions/v1/models/index.d.ts +2 -16
- package/dist/esm/versions/v1/models/index.js +2 -16
- package/dist/esm/versions/v1/models/required-post-project-parameters1.d.ts +28 -0
- package/dist/esm/versions/v1/models/required-post-project-parameters1.js +14 -0
- package/dist/esm/versions/v1/models/required-title-parameter.d.ts +23 -0
- package/dist/esm/versions/v1/models/required-title-parameter.js +14 -0
- package/dist/versions/v1/api/activities-api.d.ts +0 -47
- package/dist/versions/v1/api/activities-api.js +0 -70
- package/dist/versions/v1/api/activity-types-api.d.ts +0 -47
- package/dist/versions/v1/api/activity-types-api.js +0 -70
- package/dist/versions/v1/api/deals-api.d.ts +0 -47
- package/dist/versions/v1/api/deals-api.js +0 -70
- 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/v1/api/organizations-api.d.ts +0 -47
- package/dist/versions/v1/api/organizations-api.js +0 -70
- package/dist/versions/v1/api/persons-api.d.ts +0 -47
- package/dist/versions/v1/api/persons-api.js +0 -70
- package/dist/versions/v1/api/stages-api.d.ts +0 -47
- package/dist/versions/v1/api/stages-api.js +0 -70
- package/dist/versions/v1/models/add-deal-request.d.ts +2 -2
- package/dist/versions/v1/models/add-task-request.d.ts +2 -2
- package/dist/versions/v1/models/index.d.ts +2 -16
- package/dist/versions/v1/models/index.js +2 -16
- package/dist/versions/v1/models/required-post-project-parameters1.d.ts +28 -0
- package/dist/versions/v1/models/required-post-project-parameters1.js +15 -0
- package/dist/versions/v1/models/required-title-parameter.d.ts +23 -0
- package/dist/versions/v1/models/required-title-parameter.js +15 -0
- package/package.json +1 -1
|
@@ -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.
|
|
@@ -18,7 +18,6 @@ import { AddOrganizationRequest } from '../models';
|
|
|
18
18
|
import { AddOrganizationResponse } from '../models';
|
|
19
19
|
import { DeleteOrganizationFollowerResponse } from '../models';
|
|
20
20
|
import { DeleteOrganizationResponse } from '../models';
|
|
21
|
-
import { DeleteOrganizationsResponse } from '../models';
|
|
22
21
|
import { GetAssociatedActivitiesResponse } from '../models';
|
|
23
22
|
import { GetAssociatedDealsResponse } from '../models';
|
|
24
23
|
import { GetAssociatedFilesResponse } from '../models';
|
|
@@ -75,14 +74,6 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
75
74
|
* @throws {RequiredError}
|
|
76
75
|
*/
|
|
77
76
|
deleteOrganizationFollower: (id: number, follower_id: number) => Promise<RequestArgs>;
|
|
78
|
-
/**
|
|
79
|
-
* Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#deleteOrganization\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/organizations/{id}</a> instead.
|
|
80
|
-
* @summary Delete multiple organizations in bulk
|
|
81
|
-
* @param {string} ids The comma-separated IDs that will be deleted
|
|
82
|
-
* @deprecated
|
|
83
|
-
* @throws {RequiredError}
|
|
84
|
-
*/
|
|
85
|
-
deleteOrganizations: (ids: string) => Promise<RequestArgs>;
|
|
86
77
|
/**
|
|
87
78
|
* Returns the details of an organization. Note that this also returns some additional fields which are not present when asking for all organizations. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of organizationFields.
|
|
88
79
|
* @summary Get details of an organization
|
|
@@ -281,14 +272,6 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
|
281
272
|
* @throws {RequiredError}
|
|
282
273
|
*/
|
|
283
274
|
deleteOrganizationFollower(id: number, follower_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteOrganizationFollowerResponse>>;
|
|
284
|
-
/**
|
|
285
|
-
* Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#deleteOrganization\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/organizations/{id}</a> instead.
|
|
286
|
-
* @summary Delete multiple organizations in bulk
|
|
287
|
-
* @param {string} ids The comma-separated IDs that will be deleted
|
|
288
|
-
* @deprecated
|
|
289
|
-
* @throws {RequiredError}
|
|
290
|
-
*/
|
|
291
|
-
deleteOrganizations(ids: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteOrganizationsResponse>>;
|
|
292
275
|
/**
|
|
293
276
|
* Returns the details of an organization. Note that this also returns some additional fields which are not present when asking for all organizations. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of organizationFields.
|
|
294
277
|
* @summary Get details of an organization
|
|
@@ -485,14 +468,6 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
|
|
|
485
468
|
* @throws {RequiredError}
|
|
486
469
|
*/
|
|
487
470
|
deleteOrganizationFollower(requestParameters: OrganizationsApiDeleteOrganizationFollowerRequest): Promise<DeleteOrganizationFollowerResponse>;
|
|
488
|
-
/**
|
|
489
|
-
* Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#deleteOrganization\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/organizations/{id}</a> instead.
|
|
490
|
-
* @summary Delete multiple organizations in bulk
|
|
491
|
-
* @param {OrganizationsApiDeleteOrganizationsRequest} requestParameters Request parameters.
|
|
492
|
-
* @deprecated
|
|
493
|
-
* @throws {RequiredError}
|
|
494
|
-
*/
|
|
495
|
-
deleteOrganizations(requestParameters: OrganizationsApiDeleteOrganizationsRequest): Promise<DeleteOrganizationsResponse>;
|
|
496
471
|
/**
|
|
497
472
|
* Returns the details of an organization. Note that this also returns some additional fields which are not present when asking for all organizations. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of organizationFields.
|
|
498
473
|
* @summary Get details of an organization
|
|
@@ -678,19 +653,6 @@ export interface OrganizationsApiDeleteOrganizationFollowerRequest {
|
|
|
678
653
|
*/
|
|
679
654
|
readonly follower_id: number;
|
|
680
655
|
}
|
|
681
|
-
/**
|
|
682
|
-
* Request parameters for deleteOrganizations operation in OrganizationsApi.
|
|
683
|
-
* @export
|
|
684
|
-
* @interface OrganizationsApiDeleteOrganizationsRequest
|
|
685
|
-
*/
|
|
686
|
-
export interface OrganizationsApiDeleteOrganizationsRequest {
|
|
687
|
-
/**
|
|
688
|
-
* The comma-separated IDs that will be deleted
|
|
689
|
-
* @type {string}
|
|
690
|
-
* @memberof OrganizationsApiDeleteOrganizations
|
|
691
|
-
*/
|
|
692
|
-
readonly ids: string;
|
|
693
|
-
}
|
|
694
656
|
/**
|
|
695
657
|
* Request parameters for getOrganization operation in OrganizationsApi.
|
|
696
658
|
* @export
|
|
@@ -1157,15 +1119,6 @@ export declare class OrganizationsApi extends BaseAPI {
|
|
|
1157
1119
|
* @memberof OrganizationsApi
|
|
1158
1120
|
*/
|
|
1159
1121
|
deleteOrganizationFollower(requestParameters: OrganizationsApiDeleteOrganizationFollowerRequest): Promise<DeleteOrganizationFollowerResponse>;
|
|
1160
|
-
/**
|
|
1161
|
-
* Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#deleteOrganization\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/organizations/{id}</a> instead.
|
|
1162
|
-
* @summary Delete multiple organizations in bulk
|
|
1163
|
-
* @param {OrganizationsApiDeleteOrganizationsRequest} requestParameters Request parameters.
|
|
1164
|
-
* @deprecated
|
|
1165
|
-
* @throws {RequiredError}
|
|
1166
|
-
* @memberof OrganizationsApi
|
|
1167
|
-
*/
|
|
1168
|
-
deleteOrganizations(requestParameters: OrganizationsApiDeleteOrganizationsRequest): Promise<DeleteOrganizationsResponse>;
|
|
1169
1122
|
/**
|
|
1170
1123
|
* Returns the details of an organization. Note that this also returns some additional fields which are not present when asking for all organizations. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of organizationFields.
|
|
1171
1124
|
* @summary Get details of an organization
|
|
@@ -174,42 +174,6 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
174
174
|
options: localVarRequestOptions,
|
|
175
175
|
};
|
|
176
176
|
}),
|
|
177
|
-
/**
|
|
178
|
-
* Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#deleteOrganization\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/organizations/{id}</a> instead.
|
|
179
|
-
* @summary Delete multiple organizations in bulk
|
|
180
|
-
* @param {string} ids The comma-separated IDs that will be deleted
|
|
181
|
-
* @deprecated
|
|
182
|
-
* @throws {RequiredError}
|
|
183
|
-
*/
|
|
184
|
-
deleteOrganizations: (ids) => __awaiter(this, void 0, void 0, function* () {
|
|
185
|
-
// verify required parameter 'ids' is not null or undefined
|
|
186
|
-
assertParamExists('deleteOrganizations', 'ids', ids);
|
|
187
|
-
const localVarPath = `/organizations`;
|
|
188
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
189
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
190
|
-
let baseOptions;
|
|
191
|
-
if (configuration) {
|
|
192
|
-
baseOptions = configuration.baseOptions;
|
|
193
|
-
}
|
|
194
|
-
const localVarRequestOptions = Object.assign({ method: 'DELETE' }, baseOptions);
|
|
195
|
-
const localVarHeaderParameter = {};
|
|
196
|
-
const localVarQueryParameter = {};
|
|
197
|
-
// authentication api_key required
|
|
198
|
-
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
|
199
|
-
// authentication oauth2 required
|
|
200
|
-
// oauth required
|
|
201
|
-
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:full"], configuration);
|
|
202
|
-
if (ids !== undefined) {
|
|
203
|
-
localVarQueryParameter['ids'] = ids;
|
|
204
|
-
}
|
|
205
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
206
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
207
|
-
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
208
|
-
return {
|
|
209
|
-
url: toPathString(localVarUrlObj),
|
|
210
|
-
options: localVarRequestOptions,
|
|
211
|
-
};
|
|
212
|
-
}),
|
|
213
177
|
/**
|
|
214
178
|
* Returns the details of an organization. Note that this also returns some additional fields which are not present when asking for all organizations. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of organizationFields.
|
|
215
179
|
* @summary Get details of an organization
|
|
@@ -935,19 +899,6 @@ export const OrganizationsApiFp = function (configuration) {
|
|
|
935
899
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
936
900
|
});
|
|
937
901
|
},
|
|
938
|
-
/**
|
|
939
|
-
* Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#deleteOrganization\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/organizations/{id}</a> instead.
|
|
940
|
-
* @summary Delete multiple organizations in bulk
|
|
941
|
-
* @param {string} ids The comma-separated IDs that will be deleted
|
|
942
|
-
* @deprecated
|
|
943
|
-
* @throws {RequiredError}
|
|
944
|
-
*/
|
|
945
|
-
deleteOrganizations(ids) {
|
|
946
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
947
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteOrganizations(ids);
|
|
948
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
949
|
-
});
|
|
950
|
-
},
|
|
951
902
|
/**
|
|
952
903
|
* Returns the details of an organization. Note that this also returns some additional fields which are not present when asking for all organizations. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of organizationFields.
|
|
953
904
|
* @summary Get details of an organization
|
|
@@ -1230,16 +1181,6 @@ export const OrganizationsApiFactory = function (configuration, basePath, axios)
|
|
|
1230
1181
|
deleteOrganizationFollower(requestParameters) {
|
|
1231
1182
|
return localVarFp.deleteOrganizationFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(axios, basePath));
|
|
1232
1183
|
},
|
|
1233
|
-
/**
|
|
1234
|
-
* Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#deleteOrganization\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/organizations/{id}</a> instead.
|
|
1235
|
-
* @summary Delete multiple organizations in bulk
|
|
1236
|
-
* @param {OrganizationsApiDeleteOrganizationsRequest} requestParameters Request parameters.
|
|
1237
|
-
* @deprecated
|
|
1238
|
-
* @throws {RequiredError}
|
|
1239
|
-
*/
|
|
1240
|
-
deleteOrganizations(requestParameters) {
|
|
1241
|
-
return localVarFp.deleteOrganizations(requestParameters.ids).then((request) => request(axios, basePath));
|
|
1242
|
-
},
|
|
1243
1184
|
/**
|
|
1244
1185
|
* Returns the details of an organization. Note that this also returns some additional fields which are not present when asking for all organizations. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of organizationFields.
|
|
1245
1186
|
* @summary Get details of an organization
|
|
@@ -1443,17 +1384,6 @@ export class OrganizationsApi extends BaseAPI {
|
|
|
1443
1384
|
deleteOrganizationFollower(requestParameters) {
|
|
1444
1385
|
return OrganizationsApiFp(this.configuration).deleteOrganizationFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(this.axios, this.basePath));
|
|
1445
1386
|
}
|
|
1446
|
-
/**
|
|
1447
|
-
* Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#deleteOrganization\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/organizations/{id}</a> instead.
|
|
1448
|
-
* @summary Delete multiple organizations in bulk
|
|
1449
|
-
* @param {OrganizationsApiDeleteOrganizationsRequest} requestParameters Request parameters.
|
|
1450
|
-
* @deprecated
|
|
1451
|
-
* @throws {RequiredError}
|
|
1452
|
-
* @memberof OrganizationsApi
|
|
1453
|
-
*/
|
|
1454
|
-
deleteOrganizations(requestParameters) {
|
|
1455
|
-
return OrganizationsApiFp(this.configuration).deleteOrganizations(requestParameters.ids).then((request) => request(this.axios, this.basePath));
|
|
1456
|
-
}
|
|
1457
1387
|
/**
|
|
1458
1388
|
* Returns the details of an organization. Note that this also returns some additional fields which are not present when asking for all organizations. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of organizationFields.
|
|
1459
1389
|
* @summary Get details of an organization
|
|
@@ -18,7 +18,6 @@ import { AddPersonPictureResponse } from '../models';
|
|
|
18
18
|
import { AddPersonRequest } from '../models';
|
|
19
19
|
import { AddPersonResponse } from '../models';
|
|
20
20
|
import { DeletePersonResponse } from '../models';
|
|
21
|
-
import { DeletePersonsResponse } from '../models';
|
|
22
21
|
import { GetAssociatedActivitiesResponse } from '../models';
|
|
23
22
|
import { GetAssociatedDealsResponse } from '../models';
|
|
24
23
|
import { GetAssociatedFilesResponse } from '../models';
|
|
@@ -96,14 +95,6 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
96
95
|
* @throws {RequiredError}
|
|
97
96
|
*/
|
|
98
97
|
deletePersonPicture: (id: number) => Promise<RequestArgs>;
|
|
99
|
-
/**
|
|
100
|
-
* Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#deletePerson\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/persons/{id}</a> instead.
|
|
101
|
-
* @summary Delete multiple persons in bulk
|
|
102
|
-
* @param {string} ids The comma-separated IDs that will be deleted
|
|
103
|
-
* @deprecated
|
|
104
|
-
* @throws {RequiredError}
|
|
105
|
-
*/
|
|
106
|
-
deletePersons: (ids: string) => Promise<RequestArgs>;
|
|
107
98
|
/**
|
|
108
99
|
* Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
|
|
109
100
|
* @summary Get details of a person
|
|
@@ -324,14 +315,6 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
324
315
|
* @throws {RequiredError}
|
|
325
316
|
*/
|
|
326
317
|
deletePersonPicture(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeletePersonResponse>>;
|
|
327
|
-
/**
|
|
328
|
-
* Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#deletePerson\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/persons/{id}</a> instead.
|
|
329
|
-
* @summary Delete multiple persons in bulk
|
|
330
|
-
* @param {string} ids The comma-separated IDs that will be deleted
|
|
331
|
-
* @deprecated
|
|
332
|
-
* @throws {RequiredError}
|
|
333
|
-
*/
|
|
334
|
-
deletePersons(ids: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeletePersonsResponse>>;
|
|
335
318
|
/**
|
|
336
319
|
* Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
|
|
337
320
|
* @summary Get details of a person
|
|
@@ -545,14 +528,6 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
|
|
|
545
528
|
* @throws {RequiredError}
|
|
546
529
|
*/
|
|
547
530
|
deletePersonPicture(requestParameters: PersonsApiDeletePersonPictureRequest): Promise<DeletePersonResponse>;
|
|
548
|
-
/**
|
|
549
|
-
* Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#deletePerson\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/persons/{id}</a> instead.
|
|
550
|
-
* @summary Delete multiple persons in bulk
|
|
551
|
-
* @param {PersonsApiDeletePersonsRequest} requestParameters Request parameters.
|
|
552
|
-
* @deprecated
|
|
553
|
-
* @throws {RequiredError}
|
|
554
|
-
*/
|
|
555
|
-
deletePersons(requestParameters: PersonsApiDeletePersonsRequest): Promise<DeletePersonsResponse>;
|
|
556
531
|
/**
|
|
557
532
|
* Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
|
|
558
533
|
* @summary Get details of a person
|
|
@@ -794,19 +769,6 @@ export interface PersonsApiDeletePersonPictureRequest {
|
|
|
794
769
|
*/
|
|
795
770
|
readonly id: number;
|
|
796
771
|
}
|
|
797
|
-
/**
|
|
798
|
-
* Request parameters for deletePersons operation in PersonsApi.
|
|
799
|
-
* @export
|
|
800
|
-
* @interface PersonsApiDeletePersonsRequest
|
|
801
|
-
*/
|
|
802
|
-
export interface PersonsApiDeletePersonsRequest {
|
|
803
|
-
/**
|
|
804
|
-
* The comma-separated IDs that will be deleted
|
|
805
|
-
* @type {string}
|
|
806
|
-
* @memberof PersonsApiDeletePersons
|
|
807
|
-
*/
|
|
808
|
-
readonly ids: string;
|
|
809
|
-
}
|
|
810
772
|
/**
|
|
811
773
|
* Request parameters for getPerson operation in PersonsApi.
|
|
812
774
|
* @export
|
|
@@ -1297,15 +1259,6 @@ export declare class PersonsApi extends BaseAPI {
|
|
|
1297
1259
|
* @memberof PersonsApi
|
|
1298
1260
|
*/
|
|
1299
1261
|
deletePersonPicture(requestParameters: PersonsApiDeletePersonPictureRequest): Promise<DeletePersonResponse>;
|
|
1300
|
-
/**
|
|
1301
|
-
* Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#deletePerson\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/persons/{id}</a> instead.
|
|
1302
|
-
* @summary Delete multiple persons in bulk
|
|
1303
|
-
* @param {PersonsApiDeletePersonsRequest} requestParameters Request parameters.
|
|
1304
|
-
* @deprecated
|
|
1305
|
-
* @throws {RequiredError}
|
|
1306
|
-
* @memberof PersonsApi
|
|
1307
|
-
*/
|
|
1308
|
-
deletePersons(requestParameters: PersonsApiDeletePersonsRequest): Promise<DeletePersonsResponse>;
|
|
1309
1262
|
/**
|
|
1310
1263
|
* Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
|
|
1311
1264
|
* @summary Get details of a person
|
|
@@ -267,42 +267,6 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
267
267
|
options: localVarRequestOptions,
|
|
268
268
|
};
|
|
269
269
|
}),
|
|
270
|
-
/**
|
|
271
|
-
* Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#deletePerson\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/persons/{id}</a> instead.
|
|
272
|
-
* @summary Delete multiple persons in bulk
|
|
273
|
-
* @param {string} ids The comma-separated IDs that will be deleted
|
|
274
|
-
* @deprecated
|
|
275
|
-
* @throws {RequiredError}
|
|
276
|
-
*/
|
|
277
|
-
deletePersons: (ids) => __awaiter(this, void 0, void 0, function* () {
|
|
278
|
-
// verify required parameter 'ids' is not null or undefined
|
|
279
|
-
assertParamExists('deletePersons', 'ids', ids);
|
|
280
|
-
const localVarPath = `/persons`;
|
|
281
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
282
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
283
|
-
let baseOptions;
|
|
284
|
-
if (configuration) {
|
|
285
|
-
baseOptions = configuration.baseOptions;
|
|
286
|
-
}
|
|
287
|
-
const localVarRequestOptions = Object.assign({ method: 'DELETE' }, baseOptions);
|
|
288
|
-
const localVarHeaderParameter = {};
|
|
289
|
-
const localVarQueryParameter = {};
|
|
290
|
-
// authentication api_key required
|
|
291
|
-
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
|
292
|
-
// authentication oauth2 required
|
|
293
|
-
// oauth required
|
|
294
|
-
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:full"], configuration);
|
|
295
|
-
if (ids !== undefined) {
|
|
296
|
-
localVarQueryParameter['ids'] = ids;
|
|
297
|
-
}
|
|
298
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
299
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
300
|
-
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
301
|
-
return {
|
|
302
|
-
url: toPathString(localVarUrlObj),
|
|
303
|
-
options: localVarRequestOptions,
|
|
304
|
-
};
|
|
305
|
-
}),
|
|
306
270
|
/**
|
|
307
271
|
* Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
|
|
308
272
|
* @summary Get details of a person
|
|
@@ -1063,19 +1027,6 @@ export const PersonsApiFp = function (configuration) {
|
|
|
1063
1027
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1064
1028
|
});
|
|
1065
1029
|
},
|
|
1066
|
-
/**
|
|
1067
|
-
* Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#deletePerson\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/persons/{id}</a> instead.
|
|
1068
|
-
* @summary Delete multiple persons in bulk
|
|
1069
|
-
* @param {string} ids The comma-separated IDs that will be deleted
|
|
1070
|
-
* @deprecated
|
|
1071
|
-
* @throws {RequiredError}
|
|
1072
|
-
*/
|
|
1073
|
-
deletePersons(ids) {
|
|
1074
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
1075
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.deletePersons(ids);
|
|
1076
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1077
|
-
});
|
|
1078
|
-
},
|
|
1079
1030
|
/**
|
|
1080
1031
|
* Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
|
|
1081
1032
|
* @summary Get details of a person
|
|
@@ -1379,16 +1330,6 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
1379
1330
|
deletePersonPicture(requestParameters) {
|
|
1380
1331
|
return localVarFp.deletePersonPicture(requestParameters.id).then((request) => request(axios, basePath));
|
|
1381
1332
|
},
|
|
1382
|
-
/**
|
|
1383
|
-
* Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#deletePerson\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/persons/{id}</a> instead.
|
|
1384
|
-
* @summary Delete multiple persons in bulk
|
|
1385
|
-
* @param {PersonsApiDeletePersonsRequest} requestParameters Request parameters.
|
|
1386
|
-
* @deprecated
|
|
1387
|
-
* @throws {RequiredError}
|
|
1388
|
-
*/
|
|
1389
|
-
deletePersons(requestParameters) {
|
|
1390
|
-
return localVarFp.deletePersons(requestParameters.ids).then((request) => request(axios, basePath));
|
|
1391
|
-
},
|
|
1392
1333
|
/**
|
|
1393
1334
|
* Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
|
|
1394
1335
|
* @summary Get details of a person
|
|
@@ -1614,17 +1555,6 @@ export class PersonsApi extends BaseAPI {
|
|
|
1614
1555
|
deletePersonPicture(requestParameters) {
|
|
1615
1556
|
return PersonsApiFp(this.configuration).deletePersonPicture(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
1616
1557
|
}
|
|
1617
|
-
/**
|
|
1618
|
-
* Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#deletePerson\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/persons/{id}</a> instead.
|
|
1619
|
-
* @summary Delete multiple persons in bulk
|
|
1620
|
-
* @param {PersonsApiDeletePersonsRequest} requestParameters Request parameters.
|
|
1621
|
-
* @deprecated
|
|
1622
|
-
* @throws {RequiredError}
|
|
1623
|
-
* @memberof PersonsApi
|
|
1624
|
-
*/
|
|
1625
|
-
deletePersons(requestParameters) {
|
|
1626
|
-
return PersonsApiFp(this.configuration).deletePersons(requestParameters.ids).then((request) => request(this.axios, this.basePath));
|
|
1627
|
-
}
|
|
1628
1558
|
/**
|
|
1629
1559
|
* Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
|
|
1630
1560
|
* @summary Get details of a person
|