pipedrive 25.0.0 → 26.0.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 +40 -40
- package/dist/esm/versions/v1/api/activities-api.js +40 -40
- package/dist/esm/versions/v1/api/deals-api.d.ts +410 -88
- package/dist/esm/versions/v1/api/deals-api.js +417 -88
- package/dist/esm/versions/v1/api/item-search-api.d.ts +8 -8
- package/dist/esm/versions/v1/api/item-search-api.js +8 -8
- package/dist/esm/versions/v1/api/leads-api.d.ts +100 -14
- package/dist/esm/versions/v1/api/leads-api.js +107 -14
- package/dist/esm/versions/v1/api/notes-api.d.ts +18 -2
- package/dist/esm/versions/v1/api/notes-api.js +15 -5
- package/dist/esm/versions/v1/api/organizations-api.d.ts +68 -68
- package/dist/esm/versions/v1/api/organizations-api.js +68 -68
- package/dist/esm/versions/v1/api/persons-api.d.ts +56 -56
- package/dist/esm/versions/v1/api/persons-api.js +56 -56
- package/dist/esm/versions/v1/api/pipelines-api.d.ts +28 -28
- package/dist/esm/versions/v1/api/pipelines-api.js +28 -28
- package/dist/esm/versions/v1/api/products-api.d.ts +24 -24
- package/dist/esm/versions/v1/api/products-api.js +24 -24
- package/dist/esm/versions/v1/api/stages-api.d.ts +36 -36
- package/dist/esm/versions/v1/api/stages-api.js +36 -36
- package/dist/esm/versions/v1/base.d.ts +2 -3
- package/dist/esm/versions/v1/configuration.d.ts +2 -2
- package/dist/esm/versions/v1/models/add-note-request-all-of.d.ts +9 -4
- package/dist/esm/versions/v1/models/add-note-request-all-of1.d.ts +10 -0
- package/dist/esm/versions/v1/models/add-note-request-all-of1.js +4 -0
- package/dist/esm/versions/v1/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -0
- package/dist/esm/versions/v1/models/index.d.ts +1 -0
- package/dist/esm/versions/v1/models/index.js +1 -0
- package/dist/esm/versions/v1/models/note-project.d.ts +23 -0
- package/dist/esm/versions/v1/models/note-project.js +14 -0
- package/dist/esm/versions/v1/models/note-request-all-of1.d.ts +5 -0
- package/dist/esm/versions/v1/models/note.d.ts +16 -0
- package/dist/esm/versions/v2/api/activities-api.d.ts +15 -7
- package/dist/esm/versions/v2/api/activities-api.js +12 -7
- package/dist/esm/versions/v2/api/beta-api.d.ts +212 -0
- package/dist/esm/versions/v2/api/beta-api.js +286 -0
- package/dist/esm/versions/v2/api/deals-api.d.ts +272 -4
- package/dist/esm/versions/v2/api/deals-api.js +288 -4
- package/dist/esm/versions/v2/api/leads-api.d.ts +111 -0
- package/dist/esm/versions/v2/api/leads-api.js +146 -1
- package/dist/esm/versions/v2/api/persons-api.d.ts +8 -8
- package/dist/esm/versions/v2/api/persons-api.js +8 -8
- package/dist/esm/versions/v2/api/products-api.js +1 -1
- package/dist/esm/versions/v2/base.d.ts +2 -3
- package/dist/esm/versions/v2/configuration.d.ts +2 -2
- package/dist/esm/versions/v2/models/activity-item.d.ts +5 -0
- package/dist/esm/versions/v2/models/activity-item1.d.ts +5 -0
- package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response-data.d.ts +23 -0
- package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response-data.js +14 -0
- package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response.d.ts +34 -0
- package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response.js +14 -0
- package/dist/esm/versions/v2/models/add-convert-lead-to-deal-response.d.ts +34 -0
- package/dist/esm/versions/v2/models/add-convert-lead-to-deal-response.js +14 -0
- package/dist/esm/versions/v2/models/add-person-request.d.ts +12 -0
- package/dist/esm/versions/v2/models/add-person-request.js +6 -1
- package/dist/esm/versions/v2/models/convert-lead-to-deal-request.d.ts +28 -0
- package/dist/esm/versions/v2/models/convert-lead-to-deal-request.js +14 -0
- package/dist/esm/versions/v2/models/deal-item.d.ts +5 -0
- package/dist/esm/versions/v2/models/deal-item1.d.ts +5 -0
- package/dist/esm/versions/v2/models/get-convert-response.d.ts +43 -0
- package/dist/esm/versions/v2/models/get-convert-response.js +14 -0
- package/dist/esm/versions/v2/models/get-convert-response1-data.d.ts +46 -0
- package/dist/esm/versions/v2/models/get-convert-response1-data.js +20 -0
- package/dist/esm/versions/v2/models/get-convert-response1.d.ts +34 -0
- package/dist/esm/versions/v2/models/get-convert-response1.js +14 -0
- package/dist/esm/versions/v2/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -0
- package/dist/esm/versions/v2/models/index.d.ts +7 -0
- package/dist/esm/versions/v2/models/index.js +7 -0
- package/dist/esm/versions/v2/models/update-person-request.d.ts +12 -0
- package/dist/esm/versions/v2/models/update-person-request.js +6 -1
- package/dist/versions/v1/api/activities-api.d.ts +40 -40
- package/dist/versions/v1/api/activities-api.js +40 -40
- package/dist/versions/v1/api/deals-api.d.ts +410 -88
- package/dist/versions/v1/api/deals-api.js +417 -88
- package/dist/versions/v1/api/item-search-api.d.ts +8 -8
- package/dist/versions/v1/api/item-search-api.js +8 -8
- package/dist/versions/v1/api/leads-api.d.ts +100 -14
- package/dist/versions/v1/api/leads-api.js +107 -14
- package/dist/versions/v1/api/notes-api.d.ts +18 -2
- package/dist/versions/v1/api/notes-api.js +15 -5
- package/dist/versions/v1/api/organizations-api.d.ts +68 -68
- package/dist/versions/v1/api/organizations-api.js +68 -68
- package/dist/versions/v1/api/persons-api.d.ts +56 -56
- package/dist/versions/v1/api/persons-api.js +56 -56
- package/dist/versions/v1/api/pipelines-api.d.ts +28 -28
- package/dist/versions/v1/api/pipelines-api.js +28 -28
- package/dist/versions/v1/api/products-api.d.ts +24 -24
- package/dist/versions/v1/api/products-api.js +24 -24
- package/dist/versions/v1/api/stages-api.d.ts +36 -36
- package/dist/versions/v1/api/stages-api.js +36 -36
- package/dist/versions/v1/base.d.ts +2 -3
- package/dist/versions/v1/configuration.d.ts +2 -2
- package/dist/versions/v1/models/add-note-request-all-of.d.ts +9 -4
- package/dist/versions/v1/models/add-note-request-all-of1.d.ts +10 -0
- package/dist/versions/v1/models/add-note-request-all-of1.js +5 -1
- package/dist/versions/v1/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -0
- package/dist/versions/v1/models/index.d.ts +1 -0
- package/dist/versions/v1/models/index.js +1 -0
- package/dist/versions/v1/models/note-project.d.ts +23 -0
- package/dist/versions/v1/models/note-project.js +15 -0
- package/dist/versions/v1/models/note-request-all-of1.d.ts +5 -0
- package/dist/versions/v1/models/note.d.ts +16 -0
- package/dist/versions/v2/api/activities-api.d.ts +15 -7
- package/dist/versions/v2/api/activities-api.js +12 -7
- package/dist/versions/v2/api/beta-api.d.ts +212 -0
- package/dist/versions/v2/api/beta-api.js +286 -0
- package/dist/versions/v2/api/deals-api.d.ts +272 -4
- package/dist/versions/v2/api/deals-api.js +288 -4
- package/dist/versions/v2/api/leads-api.d.ts +111 -0
- package/dist/versions/v2/api/leads-api.js +145 -0
- package/dist/versions/v2/api/persons-api.d.ts +8 -8
- package/dist/versions/v2/api/persons-api.js +8 -8
- package/dist/versions/v2/api/products-api.js +1 -1
- package/dist/versions/v2/base.d.ts +2 -3
- package/dist/versions/v2/configuration.d.ts +2 -2
- package/dist/versions/v2/models/activity-item.d.ts +5 -0
- package/dist/versions/v2/models/activity-item1.d.ts +5 -0
- package/dist/versions/v2/models/add-convert-deal-to-lead-response-data.d.ts +23 -0
- package/dist/versions/v2/models/add-convert-deal-to-lead-response-data.js +15 -0
- package/dist/versions/v2/models/add-convert-deal-to-lead-response.d.ts +34 -0
- package/dist/versions/v2/models/add-convert-deal-to-lead-response.js +15 -0
- package/dist/versions/v2/models/add-convert-lead-to-deal-response.d.ts +34 -0
- package/dist/versions/v2/models/add-convert-lead-to-deal-response.js +15 -0
- package/dist/versions/v2/models/add-person-request.d.ts +12 -0
- package/dist/versions/v2/models/add-person-request.js +7 -0
- package/dist/versions/v2/models/convert-lead-to-deal-request.d.ts +28 -0
- package/dist/versions/v2/models/convert-lead-to-deal-request.js +15 -0
- package/dist/versions/v2/models/deal-item.d.ts +5 -0
- package/dist/versions/v2/models/deal-item1.d.ts +5 -0
- package/dist/versions/v2/models/get-convert-response.d.ts +43 -0
- package/dist/versions/v2/models/get-convert-response.js +15 -0
- package/dist/versions/v2/models/get-convert-response1-data.d.ts +46 -0
- package/dist/versions/v2/models/get-convert-response1-data.js +23 -0
- package/dist/versions/v2/models/get-convert-response1.d.ts +34 -0
- package/dist/versions/v2/models/get-convert-response1.js +15 -0
- package/dist/versions/v2/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -0
- package/dist/versions/v2/models/index.d.ts +7 -0
- package/dist/versions/v2/models/index.js +7 -0
- package/dist/versions/v2/models/update-person-request.d.ts +12 -0
- package/dist/versions/v2/models/update-person-request.js +7 -0
- package/package.json +1 -1
@@ -42,7 +42,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
|
|
42
42
|
* Adds a new person. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the personFields and look for `key` values.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `data.marketing_status` field.
|
43
43
|
* @summary Add a person
|
44
44
|
* @param {AddPersonRequest} [AddPersonRequest]
|
45
|
-
|
45
|
+
* @deprecated
|
46
46
|
* @throws {RequiredError}
|
47
47
|
*/
|
48
48
|
addPerson: (AddPersonRequest) => __awaiter(this, void 0, void 0, function* () {
|
@@ -171,7 +171,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
|
|
171
171
|
* Marks a person as deleted. After 30 days, the person will be permanently deleted.
|
172
172
|
* @summary Delete a person
|
173
173
|
* @param {number} id The ID of the person
|
174
|
-
|
174
|
+
* @deprecated
|
175
175
|
* @throws {RequiredError}
|
176
176
|
*/
|
177
177
|
deletePerson: (id) => __awaiter(this, void 0, void 0, function* () {
|
@@ -274,10 +274,10 @@ const PersonsApiAxiosParamCreator = function (configuration) {
|
|
274
274
|
};
|
275
275
|
}),
|
276
276
|
/**
|
277
|
-
* Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
|
277
|
+
* 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.
|
278
278
|
* @summary Delete multiple persons in bulk
|
279
279
|
* @param {string} ids The comma-separated IDs that will be deleted
|
280
|
-
|
280
|
+
* @deprecated
|
281
281
|
* @throws {RequiredError}
|
282
282
|
*/
|
283
283
|
deletePersons: (ids) => __awaiter(this, void 0, void 0, function* () {
|
@@ -313,7 +313,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
|
|
313
313
|
* 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.
|
314
314
|
* @summary Get details of a person
|
315
315
|
* @param {number} id The ID of the person
|
316
|
-
|
316
|
+
* @deprecated
|
317
317
|
* @throws {RequiredError}
|
318
318
|
*/
|
319
319
|
getPerson: (id) => __awaiter(this, void 0, void 0, function* () {
|
@@ -344,14 +344,14 @@ const PersonsApiAxiosParamCreator = function (configuration) {
|
|
344
344
|
};
|
345
345
|
}),
|
346
346
|
/**
|
347
|
-
* Lists activities associated with a person.
|
347
|
+
* Lists activities associated with a person. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivities\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/activities?person_id={id}</a> instead.
|
348
348
|
* @summary List activities associated with a person
|
349
349
|
* @param {number} id The ID of the person
|
350
350
|
* @param {number} [start] Pagination start
|
351
351
|
* @param {number} [limit] Items shown per page
|
352
352
|
* @param {0 | 1} [done] Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted, returns both Done and Not done activities.
|
353
353
|
* @param {string} [exclude] A comma-separated string of activity IDs to exclude from result
|
354
|
-
|
354
|
+
* @deprecated
|
355
355
|
* @throws {RequiredError}
|
356
356
|
*/
|
357
357
|
getPersonActivities: (id, start, limit, done, exclude) => __awaiter(this, void 0, void 0, function* () {
|
@@ -436,14 +436,14 @@ const PersonsApiAxiosParamCreator = function (configuration) {
|
|
436
436
|
};
|
437
437
|
}),
|
438
438
|
/**
|
439
|
-
* Lists deals associated with a person.
|
439
|
+
* Lists deals associated with a person. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeals\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/deals?person_id={id}</a> instead.
|
440
440
|
* @summary List deals associated with a person
|
441
441
|
* @param {number} id The ID of the person
|
442
442
|
* @param {number} [start] Pagination start
|
443
443
|
* @param {number} [limit] Items shown per page
|
444
444
|
* @param {'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted'} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included.
|
445
445
|
* @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).
|
446
|
-
|
446
|
+
* @deprecated
|
447
447
|
* @throws {RequiredError}
|
448
448
|
*/
|
449
449
|
getPersonDeals: (id, start, limit, status, sort) => __awaiter(this, void 0, void 0, function* () {
|
@@ -742,7 +742,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
|
|
742
742
|
* @param {number} [start] Pagination start
|
743
743
|
* @param {number} [limit] Items shown per page
|
744
744
|
* @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).
|
745
|
-
|
745
|
+
* @deprecated
|
746
746
|
* @throws {RequiredError}
|
747
747
|
*/
|
748
748
|
getPersons: (user_id, filter_id, first_char, start, limit, sort) => __awaiter(this, void 0, void 0, function* () {
|
@@ -788,15 +788,15 @@ const PersonsApiAxiosParamCreator = function (configuration) {
|
|
788
788
|
};
|
789
789
|
}),
|
790
790
|
/**
|
791
|
-
* Returns all persons.
|
792
|
-
* @summary Get all persons
|
791
|
+
* Returns all persons. Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersons\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/persons</a> instead.
|
792
|
+
* @summary Get all persons collection
|
793
793
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
794
794
|
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
795
795
|
* @param {string} [since] The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
|
796
796
|
* @param {string} [until] The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
|
797
797
|
* @param {number} [owner_id] If supplied, only persons owned by the given user will be returned
|
798
798
|
* @param {string} [first_char] If supplied, only persons whose name starts with the specified letter will be returned (case-insensitive)
|
799
|
-
|
799
|
+
* @deprecated
|
800
800
|
* @throws {RequiredError}
|
801
801
|
*/
|
802
802
|
getPersonsCollection: (cursor, limit, since, until, owner_id, first_char) => __awaiter(this, void 0, void 0, function* () {
|
@@ -888,7 +888,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
|
|
888
888
|
* @param {'person.picture'} [include_fields] Supports including optional fields in the results which are not provided by default
|
889
889
|
* @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
|
890
890
|
* @param {number} [limit] Items shown per page
|
891
|
-
|
891
|
+
* @deprecated
|
892
892
|
* @throws {RequiredError}
|
893
893
|
*/
|
894
894
|
searchPersons: (term, fields, exact_match, organization_id, include_fields, start, limit) => __awaiter(this, void 0, void 0, function* () {
|
@@ -989,7 +989,7 @@ const PersonsApiFp = function (configuration) {
|
|
989
989
|
* Adds a new person. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the personFields and look for `key` values.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `data.marketing_status` field.
|
990
990
|
* @summary Add a person
|
991
991
|
* @param {AddPersonRequest} [AddPersonRequest]
|
992
|
-
|
992
|
+
* @deprecated
|
993
993
|
* @throws {RequiredError}
|
994
994
|
*/
|
995
995
|
addPerson(AddPersonRequest) {
|
@@ -1034,7 +1034,7 @@ const PersonsApiFp = function (configuration) {
|
|
1034
1034
|
* Marks a person as deleted. After 30 days, the person will be permanently deleted.
|
1035
1035
|
* @summary Delete a person
|
1036
1036
|
* @param {number} id The ID of the person
|
1037
|
-
|
1037
|
+
* @deprecated
|
1038
1038
|
* @throws {RequiredError}
|
1039
1039
|
*/
|
1040
1040
|
deletePerson(id) {
|
@@ -1071,10 +1071,10 @@ const PersonsApiFp = function (configuration) {
|
|
1071
1071
|
});
|
1072
1072
|
},
|
1073
1073
|
/**
|
1074
|
-
* Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
|
1074
|
+
* 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.
|
1075
1075
|
* @summary Delete multiple persons in bulk
|
1076
1076
|
* @param {string} ids The comma-separated IDs that will be deleted
|
1077
|
-
|
1077
|
+
* @deprecated
|
1078
1078
|
* @throws {RequiredError}
|
1079
1079
|
*/
|
1080
1080
|
deletePersons(ids) {
|
@@ -1087,7 +1087,7 @@ const PersonsApiFp = function (configuration) {
|
|
1087
1087
|
* 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.
|
1088
1088
|
* @summary Get details of a person
|
1089
1089
|
* @param {number} id The ID of the person
|
1090
|
-
|
1090
|
+
* @deprecated
|
1091
1091
|
* @throws {RequiredError}
|
1092
1092
|
*/
|
1093
1093
|
getPerson(id) {
|
@@ -1097,14 +1097,14 @@ const PersonsApiFp = function (configuration) {
|
|
1097
1097
|
});
|
1098
1098
|
},
|
1099
1099
|
/**
|
1100
|
-
* Lists activities associated with a person.
|
1100
|
+
* Lists activities associated with a person. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivities\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/activities?person_id={id}</a> instead.
|
1101
1101
|
* @summary List activities associated with a person
|
1102
1102
|
* @param {number} id The ID of the person
|
1103
1103
|
* @param {number} [start] Pagination start
|
1104
1104
|
* @param {number} [limit] Items shown per page
|
1105
1105
|
* @param {0 | 1} [done] Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted, returns both Done and Not done activities.
|
1106
1106
|
* @param {string} [exclude] A comma-separated string of activity IDs to exclude from result
|
1107
|
-
|
1107
|
+
* @deprecated
|
1108
1108
|
* @throws {RequiredError}
|
1109
1109
|
*/
|
1110
1110
|
getPersonActivities(id, start, limit, done, exclude) {
|
@@ -1129,14 +1129,14 @@ const PersonsApiFp = function (configuration) {
|
|
1129
1129
|
});
|
1130
1130
|
},
|
1131
1131
|
/**
|
1132
|
-
* Lists deals associated with a person.
|
1132
|
+
* Lists deals associated with a person. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeals\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/deals?person_id={id}</a> instead.
|
1133
1133
|
* @summary List deals associated with a person
|
1134
1134
|
* @param {number} id The ID of the person
|
1135
1135
|
* @param {number} [start] Pagination start
|
1136
1136
|
* @param {number} [limit] Items shown per page
|
1137
1137
|
* @param {'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted'} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included.
|
1138
1138
|
* @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).
|
1139
|
-
|
1139
|
+
* @deprecated
|
1140
1140
|
* @throws {RequiredError}
|
1141
1141
|
*/
|
1142
1142
|
getPersonDeals(id, start, limit, status, sort) {
|
@@ -1243,7 +1243,7 @@ const PersonsApiFp = function (configuration) {
|
|
1243
1243
|
* @param {number} [start] Pagination start
|
1244
1244
|
* @param {number} [limit] Items shown per page
|
1245
1245
|
* @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).
|
1246
|
-
|
1246
|
+
* @deprecated
|
1247
1247
|
* @throws {RequiredError}
|
1248
1248
|
*/
|
1249
1249
|
getPersons(user_id, filter_id, first_char, start, limit, sort) {
|
@@ -1253,15 +1253,15 @@ const PersonsApiFp = function (configuration) {
|
|
1253
1253
|
});
|
1254
1254
|
},
|
1255
1255
|
/**
|
1256
|
-
* Returns all persons.
|
1257
|
-
* @summary Get all persons
|
1256
|
+
* Returns all persons. Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersons\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/persons</a> instead.
|
1257
|
+
* @summary Get all persons collection
|
1258
1258
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
1259
1259
|
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
1260
1260
|
* @param {string} [since] The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
|
1261
1261
|
* @param {string} [until] The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
|
1262
1262
|
* @param {number} [owner_id] If supplied, only persons owned by the given user will be returned
|
1263
1263
|
* @param {string} [first_char] If supplied, only persons whose name starts with the specified letter will be returned (case-insensitive)
|
1264
|
-
|
1264
|
+
* @deprecated
|
1265
1265
|
* @throws {RequiredError}
|
1266
1266
|
*/
|
1267
1267
|
getPersonsCollection(cursor, limit, since, until, owner_id, first_char) {
|
@@ -1294,7 +1294,7 @@ const PersonsApiFp = function (configuration) {
|
|
1294
1294
|
* @param {'person.picture'} [include_fields] Supports including optional fields in the results which are not provided by default
|
1295
1295
|
* @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
|
1296
1296
|
* @param {number} [limit] Items shown per page
|
1297
|
-
|
1297
|
+
* @deprecated
|
1298
1298
|
* @throws {RequiredError}
|
1299
1299
|
*/
|
1300
1300
|
searchPersons(term, fields, exact_match, organization_id, include_fields, start, limit) {
|
@@ -1331,7 +1331,7 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
1331
1331
|
* Adds a new person. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the personFields and look for `key` values.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `data.marketing_status` field.
|
1332
1332
|
* @summary Add a person
|
1333
1333
|
* @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
|
1334
|
-
|
1334
|
+
* @deprecated
|
1335
1335
|
* @throws {RequiredError}
|
1336
1336
|
*/
|
1337
1337
|
addPerson(requestParameters = {}) {
|
@@ -1361,7 +1361,7 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
1361
1361
|
* Marks a person as deleted. After 30 days, the person will be permanently deleted.
|
1362
1362
|
* @summary Delete a person
|
1363
1363
|
* @param {PersonsApiDeletePersonRequest} requestParameters Request parameters.
|
1364
|
-
|
1364
|
+
* @deprecated
|
1365
1365
|
* @throws {RequiredError}
|
1366
1366
|
*/
|
1367
1367
|
deletePerson(requestParameters) {
|
@@ -1388,10 +1388,10 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
1388
1388
|
return localVarFp.deletePersonPicture(requestParameters.id).then((request) => request(axios, basePath));
|
1389
1389
|
},
|
1390
1390
|
/**
|
1391
|
-
* Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
|
1391
|
+
* 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.
|
1392
1392
|
* @summary Delete multiple persons in bulk
|
1393
1393
|
* @param {PersonsApiDeletePersonsRequest} requestParameters Request parameters.
|
1394
|
-
|
1394
|
+
* @deprecated
|
1395
1395
|
* @throws {RequiredError}
|
1396
1396
|
*/
|
1397
1397
|
deletePersons(requestParameters) {
|
@@ -1401,17 +1401,17 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
1401
1401
|
* 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.
|
1402
1402
|
* @summary Get details of a person
|
1403
1403
|
* @param {PersonsApiGetPersonRequest} requestParameters Request parameters.
|
1404
|
-
|
1404
|
+
* @deprecated
|
1405
1405
|
* @throws {RequiredError}
|
1406
1406
|
*/
|
1407
1407
|
getPerson(requestParameters) {
|
1408
1408
|
return localVarFp.getPerson(requestParameters.id).then((request) => request(axios, basePath));
|
1409
1409
|
},
|
1410
1410
|
/**
|
1411
|
-
* Lists activities associated with a person.
|
1411
|
+
* Lists activities associated with a person. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivities\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/activities?person_id={id}</a> instead.
|
1412
1412
|
* @summary List activities associated with a person
|
1413
1413
|
* @param {PersonsApiGetPersonActivitiesRequest} requestParameters Request parameters.
|
1414
|
-
|
1414
|
+
* @deprecated
|
1415
1415
|
* @throws {RequiredError}
|
1416
1416
|
*/
|
1417
1417
|
getPersonActivities(requestParameters) {
|
@@ -1428,10 +1428,10 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
1428
1428
|
return localVarFp.getPersonChangelog(requestParameters.id, requestParameters.cursor, requestParameters.limit).then((request) => request(axios, basePath));
|
1429
1429
|
},
|
1430
1430
|
/**
|
1431
|
-
* Lists deals associated with a person.
|
1431
|
+
* Lists deals associated with a person. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeals\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/deals?person_id={id}</a> instead.
|
1432
1432
|
* @summary List deals associated with a person
|
1433
1433
|
* @param {PersonsApiGetPersonDealsRequest} requestParameters Request parameters.
|
1434
|
-
|
1434
|
+
* @deprecated
|
1435
1435
|
* @throws {RequiredError}
|
1436
1436
|
*/
|
1437
1437
|
getPersonDeals(requestParameters) {
|
@@ -1501,17 +1501,17 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
1501
1501
|
* Returns all persons.
|
1502
1502
|
* @summary Get all persons
|
1503
1503
|
* @param {PersonsApiGetPersonsRequest} requestParameters Request parameters.
|
1504
|
-
|
1504
|
+
* @deprecated
|
1505
1505
|
* @throws {RequiredError}
|
1506
1506
|
*/
|
1507
1507
|
getPersons(requestParameters = {}) {
|
1508
1508
|
return localVarFp.getPersons(requestParameters.user_id, requestParameters.filter_id, requestParameters.first_char, requestParameters.start, requestParameters.limit, requestParameters.sort).then((request) => request(axios, basePath));
|
1509
1509
|
},
|
1510
1510
|
/**
|
1511
|
-
* Returns all persons.
|
1512
|
-
* @summary Get all persons
|
1511
|
+
* Returns all persons. Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersons\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/persons</a> instead.
|
1512
|
+
* @summary Get all persons collection
|
1513
1513
|
* @param {PersonsApiGetPersonsCollectionRequest} requestParameters Request parameters.
|
1514
|
-
|
1514
|
+
* @deprecated
|
1515
1515
|
* @throws {RequiredError}
|
1516
1516
|
*/
|
1517
1517
|
getPersonsCollection(requestParameters = {}) {
|
@@ -1531,7 +1531,7 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
1531
1531
|
* Searches all persons by name, email, phone, 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 persons can be filtered by organization ID.
|
1532
1532
|
* @summary Search persons
|
1533
1533
|
* @param {PersonsApiSearchPersonsRequest} requestParameters Request parameters.
|
1534
|
-
|
1534
|
+
* @deprecated
|
1535
1535
|
* @throws {RequiredError}
|
1536
1536
|
*/
|
1537
1537
|
searchPersons(requestParameters) {
|
@@ -1561,7 +1561,7 @@ class PersonsApi extends base_1.BaseAPI {
|
|
1561
1561
|
* Adds a new person. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the personFields and look for `key` values.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `data.marketing_status` field.
|
1562
1562
|
* @summary Add a person
|
1563
1563
|
* @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
|
1564
|
-
|
1564
|
+
* @deprecated
|
1565
1565
|
* @throws {RequiredError}
|
1566
1566
|
* @memberof PersonsApi
|
1567
1567
|
*/
|
@@ -1594,7 +1594,7 @@ class PersonsApi extends base_1.BaseAPI {
|
|
1594
1594
|
* Marks a person as deleted. After 30 days, the person will be permanently deleted.
|
1595
1595
|
* @summary Delete a person
|
1596
1596
|
* @param {PersonsApiDeletePersonRequest} requestParameters Request parameters.
|
1597
|
-
|
1597
|
+
* @deprecated
|
1598
1598
|
* @throws {RequiredError}
|
1599
1599
|
* @memberof PersonsApi
|
1600
1600
|
*/
|
@@ -1624,10 +1624,10 @@ class PersonsApi extends base_1.BaseAPI {
|
|
1624
1624
|
return (0, exports.PersonsApiFp)(this.configuration).deletePersonPicture(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
1625
1625
|
}
|
1626
1626
|
/**
|
1627
|
-
* Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
|
1627
|
+
* 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.
|
1628
1628
|
* @summary Delete multiple persons in bulk
|
1629
1629
|
* @param {PersonsApiDeletePersonsRequest} requestParameters Request parameters.
|
1630
|
-
|
1630
|
+
* @deprecated
|
1631
1631
|
* @throws {RequiredError}
|
1632
1632
|
* @memberof PersonsApi
|
1633
1633
|
*/
|
@@ -1638,7 +1638,7 @@ class PersonsApi extends base_1.BaseAPI {
|
|
1638
1638
|
* 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.
|
1639
1639
|
* @summary Get details of a person
|
1640
1640
|
* @param {PersonsApiGetPersonRequest} requestParameters Request parameters.
|
1641
|
-
|
1641
|
+
* @deprecated
|
1642
1642
|
* @throws {RequiredError}
|
1643
1643
|
* @memberof PersonsApi
|
1644
1644
|
*/
|
@@ -1646,10 +1646,10 @@ class PersonsApi extends base_1.BaseAPI {
|
|
1646
1646
|
return (0, exports.PersonsApiFp)(this.configuration).getPerson(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
1647
1647
|
}
|
1648
1648
|
/**
|
1649
|
-
* Lists activities associated with a person.
|
1649
|
+
* Lists activities associated with a person. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivities\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/activities?person_id={id}</a> instead.
|
1650
1650
|
* @summary List activities associated with a person
|
1651
1651
|
* @param {PersonsApiGetPersonActivitiesRequest} requestParameters Request parameters.
|
1652
|
-
|
1652
|
+
* @deprecated
|
1653
1653
|
* @throws {RequiredError}
|
1654
1654
|
* @memberof PersonsApi
|
1655
1655
|
*/
|
@@ -1668,10 +1668,10 @@ class PersonsApi extends base_1.BaseAPI {
|
|
1668
1668
|
return (0, exports.PersonsApiFp)(this.configuration).getPersonChangelog(requestParameters.id, requestParameters.cursor, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
1669
1669
|
}
|
1670
1670
|
/**
|
1671
|
-
* Lists deals associated with a person.
|
1671
|
+
* Lists deals associated with a person. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeals\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/deals?person_id={id}</a> instead.
|
1672
1672
|
* @summary List deals associated with a person
|
1673
1673
|
* @param {PersonsApiGetPersonDealsRequest} requestParameters Request parameters.
|
1674
|
-
|
1674
|
+
* @deprecated
|
1675
1675
|
* @throws {RequiredError}
|
1676
1676
|
* @memberof PersonsApi
|
1677
1677
|
*/
|
@@ -1748,7 +1748,7 @@ class PersonsApi extends base_1.BaseAPI {
|
|
1748
1748
|
* Returns all persons.
|
1749
1749
|
* @summary Get all persons
|
1750
1750
|
* @param {PersonsApiGetPersonsRequest} requestParameters Request parameters.
|
1751
|
-
|
1751
|
+
* @deprecated
|
1752
1752
|
* @throws {RequiredError}
|
1753
1753
|
* @memberof PersonsApi
|
1754
1754
|
*/
|
@@ -1756,10 +1756,10 @@ class PersonsApi extends base_1.BaseAPI {
|
|
1756
1756
|
return (0, exports.PersonsApiFp)(this.configuration).getPersons(requestParameters.user_id, requestParameters.filter_id, requestParameters.first_char, requestParameters.start, requestParameters.limit, requestParameters.sort).then((request) => request(this.axios, this.basePath));
|
1757
1757
|
}
|
1758
1758
|
/**
|
1759
|
-
* Returns all persons.
|
1760
|
-
* @summary Get all persons
|
1759
|
+
* Returns all persons. Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersons\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/persons</a> instead.
|
1760
|
+
* @summary Get all persons collection
|
1761
1761
|
* @param {PersonsApiGetPersonsCollectionRequest} requestParameters Request parameters.
|
1762
|
-
|
1762
|
+
* @deprecated
|
1763
1763
|
* @throws {RequiredError}
|
1764
1764
|
* @memberof PersonsApi
|
1765
1765
|
*/
|
@@ -1781,7 +1781,7 @@ class PersonsApi extends base_1.BaseAPI {
|
|
1781
1781
|
* Searches all persons by name, email, phone, 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 persons can be filtered by organization ID.
|
1782
1782
|
* @summary Search persons
|
1783
1783
|
* @param {PersonsApiSearchPersonsRequest} requestParameters Request parameters.
|
1784
|
-
|
1784
|
+
* @deprecated
|
1785
1785
|
* @throws {RequiredError}
|
1786
1786
|
* @memberof PersonsApi
|
1787
1787
|
*/
|