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
@@ -36,7 +36,7 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
36
36
|
* 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.
|
37
37
|
* @summary Add a person
|
38
38
|
* @param {AddPersonRequest} [AddPersonRequest]
|
39
|
-
|
39
|
+
* @deprecated
|
40
40
|
* @throws {RequiredError}
|
41
41
|
*/
|
42
42
|
addPerson: (AddPersonRequest) => __awaiter(this, void 0, void 0, function* () {
|
@@ -165,7 +165,7 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
165
165
|
* Marks a person as deleted. After 30 days, the person will be permanently deleted.
|
166
166
|
* @summary Delete a person
|
167
167
|
* @param {number} id The ID of the person
|
168
|
-
|
168
|
+
* @deprecated
|
169
169
|
* @throws {RequiredError}
|
170
170
|
*/
|
171
171
|
deletePerson: (id) => __awaiter(this, void 0, void 0, function* () {
|
@@ -268,10 +268,10 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
268
268
|
};
|
269
269
|
}),
|
270
270
|
/**
|
271
|
-
* Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
|
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
272
|
* @summary Delete multiple persons in bulk
|
273
273
|
* @param {string} ids The comma-separated IDs that will be deleted
|
274
|
-
|
274
|
+
* @deprecated
|
275
275
|
* @throws {RequiredError}
|
276
276
|
*/
|
277
277
|
deletePersons: (ids) => __awaiter(this, void 0, void 0, function* () {
|
@@ -307,7 +307,7 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
307
307
|
* 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
308
|
* @summary Get details of a person
|
309
309
|
* @param {number} id The ID of the person
|
310
|
-
|
310
|
+
* @deprecated
|
311
311
|
* @throws {RequiredError}
|
312
312
|
*/
|
313
313
|
getPerson: (id) => __awaiter(this, void 0, void 0, function* () {
|
@@ -338,14 +338,14 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
338
338
|
};
|
339
339
|
}),
|
340
340
|
/**
|
341
|
-
* Lists activities associated with a person.
|
341
|
+
* 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.
|
342
342
|
* @summary List activities associated with a person
|
343
343
|
* @param {number} id The ID of the person
|
344
344
|
* @param {number} [start] Pagination start
|
345
345
|
* @param {number} [limit] Items shown per page
|
346
346
|
* @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.
|
347
347
|
* @param {string} [exclude] A comma-separated string of activity IDs to exclude from result
|
348
|
-
|
348
|
+
* @deprecated
|
349
349
|
* @throws {RequiredError}
|
350
350
|
*/
|
351
351
|
getPersonActivities: (id, start, limit, done, exclude) => __awaiter(this, void 0, void 0, function* () {
|
@@ -430,14 +430,14 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
430
430
|
};
|
431
431
|
}),
|
432
432
|
/**
|
433
|
-
* Lists deals associated with a person.
|
433
|
+
* 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.
|
434
434
|
* @summary List deals associated with a person
|
435
435
|
* @param {number} id The ID of the person
|
436
436
|
* @param {number} [start] Pagination start
|
437
437
|
* @param {number} [limit] Items shown per page
|
438
438
|
* @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.
|
439
439
|
* @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).
|
440
|
-
|
440
|
+
* @deprecated
|
441
441
|
* @throws {RequiredError}
|
442
442
|
*/
|
443
443
|
getPersonDeals: (id, start, limit, status, sort) => __awaiter(this, void 0, void 0, function* () {
|
@@ -736,7 +736,7 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
736
736
|
* @param {number} [start] Pagination start
|
737
737
|
* @param {number} [limit] Items shown per page
|
738
738
|
* @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).
|
739
|
-
|
739
|
+
* @deprecated
|
740
740
|
* @throws {RequiredError}
|
741
741
|
*/
|
742
742
|
getPersons: (user_id, filter_id, first_char, start, limit, sort) => __awaiter(this, void 0, void 0, function* () {
|
@@ -782,15 +782,15 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
782
782
|
};
|
783
783
|
}),
|
784
784
|
/**
|
785
|
-
* Returns all persons.
|
786
|
-
* @summary Get all persons
|
785
|
+
* 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.
|
786
|
+
* @summary Get all persons collection
|
787
787
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
788
788
|
* @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.
|
789
789
|
* @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.
|
790
790
|
* @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.
|
791
791
|
* @param {number} [owner_id] If supplied, only persons owned by the given user will be returned
|
792
792
|
* @param {string} [first_char] If supplied, only persons whose name starts with the specified letter will be returned (case-insensitive)
|
793
|
-
|
793
|
+
* @deprecated
|
794
794
|
* @throws {RequiredError}
|
795
795
|
*/
|
796
796
|
getPersonsCollection: (cursor, limit, since, until, owner_id, first_char) => __awaiter(this, void 0, void 0, function* () {
|
@@ -882,7 +882,7 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
882
882
|
* @param {'person.picture'} [include_fields] Supports including optional fields in the results which are not provided by default
|
883
883
|
* @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.
|
884
884
|
* @param {number} [limit] Items shown per page
|
885
|
-
|
885
|
+
* @deprecated
|
886
886
|
* @throws {RequiredError}
|
887
887
|
*/
|
888
888
|
searchPersons: (term, fields, exact_match, organization_id, include_fields, start, limit) => __awaiter(this, void 0, void 0, function* () {
|
@@ -982,7 +982,7 @@ export const PersonsApiFp = function (configuration) {
|
|
982
982
|
* 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.
|
983
983
|
* @summary Add a person
|
984
984
|
* @param {AddPersonRequest} [AddPersonRequest]
|
985
|
-
|
985
|
+
* @deprecated
|
986
986
|
* @throws {RequiredError}
|
987
987
|
*/
|
988
988
|
addPerson(AddPersonRequest) {
|
@@ -1027,7 +1027,7 @@ export const PersonsApiFp = function (configuration) {
|
|
1027
1027
|
* Marks a person as deleted. After 30 days, the person will be permanently deleted.
|
1028
1028
|
* @summary Delete a person
|
1029
1029
|
* @param {number} id The ID of the person
|
1030
|
-
|
1030
|
+
* @deprecated
|
1031
1031
|
* @throws {RequiredError}
|
1032
1032
|
*/
|
1033
1033
|
deletePerson(id) {
|
@@ -1064,10 +1064,10 @@ export const PersonsApiFp = function (configuration) {
|
|
1064
1064
|
});
|
1065
1065
|
},
|
1066
1066
|
/**
|
1067
|
-
* Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
|
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
1068
|
* @summary Delete multiple persons in bulk
|
1069
1069
|
* @param {string} ids The comma-separated IDs that will be deleted
|
1070
|
-
|
1070
|
+
* @deprecated
|
1071
1071
|
* @throws {RequiredError}
|
1072
1072
|
*/
|
1073
1073
|
deletePersons(ids) {
|
@@ -1080,7 +1080,7 @@ export const PersonsApiFp = function (configuration) {
|
|
1080
1080
|
* 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
1081
|
* @summary Get details of a person
|
1082
1082
|
* @param {number} id The ID of the person
|
1083
|
-
|
1083
|
+
* @deprecated
|
1084
1084
|
* @throws {RequiredError}
|
1085
1085
|
*/
|
1086
1086
|
getPerson(id) {
|
@@ -1090,14 +1090,14 @@ export const PersonsApiFp = function (configuration) {
|
|
1090
1090
|
});
|
1091
1091
|
},
|
1092
1092
|
/**
|
1093
|
-
* Lists activities associated with a person.
|
1093
|
+
* 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.
|
1094
1094
|
* @summary List activities associated with a person
|
1095
1095
|
* @param {number} id The ID of the person
|
1096
1096
|
* @param {number} [start] Pagination start
|
1097
1097
|
* @param {number} [limit] Items shown per page
|
1098
1098
|
* @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.
|
1099
1099
|
* @param {string} [exclude] A comma-separated string of activity IDs to exclude from result
|
1100
|
-
|
1100
|
+
* @deprecated
|
1101
1101
|
* @throws {RequiredError}
|
1102
1102
|
*/
|
1103
1103
|
getPersonActivities(id, start, limit, done, exclude) {
|
@@ -1122,14 +1122,14 @@ export const PersonsApiFp = function (configuration) {
|
|
1122
1122
|
});
|
1123
1123
|
},
|
1124
1124
|
/**
|
1125
|
-
* Lists deals associated with a person.
|
1125
|
+
* 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.
|
1126
1126
|
* @summary List deals associated with a person
|
1127
1127
|
* @param {number} id The ID of the person
|
1128
1128
|
* @param {number} [start] Pagination start
|
1129
1129
|
* @param {number} [limit] Items shown per page
|
1130
1130
|
* @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.
|
1131
1131
|
* @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).
|
1132
|
-
|
1132
|
+
* @deprecated
|
1133
1133
|
* @throws {RequiredError}
|
1134
1134
|
*/
|
1135
1135
|
getPersonDeals(id, start, limit, status, sort) {
|
@@ -1236,7 +1236,7 @@ export const PersonsApiFp = function (configuration) {
|
|
1236
1236
|
* @param {number} [start] Pagination start
|
1237
1237
|
* @param {number} [limit] Items shown per page
|
1238
1238
|
* @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).
|
1239
|
-
|
1239
|
+
* @deprecated
|
1240
1240
|
* @throws {RequiredError}
|
1241
1241
|
*/
|
1242
1242
|
getPersons(user_id, filter_id, first_char, start, limit, sort) {
|
@@ -1246,15 +1246,15 @@ export const PersonsApiFp = function (configuration) {
|
|
1246
1246
|
});
|
1247
1247
|
},
|
1248
1248
|
/**
|
1249
|
-
* Returns all persons.
|
1250
|
-
* @summary Get all persons
|
1249
|
+
* 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.
|
1250
|
+
* @summary Get all persons collection
|
1251
1251
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
1252
1252
|
* @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.
|
1253
1253
|
* @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.
|
1254
1254
|
* @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.
|
1255
1255
|
* @param {number} [owner_id] If supplied, only persons owned by the given user will be returned
|
1256
1256
|
* @param {string} [first_char] If supplied, only persons whose name starts with the specified letter will be returned (case-insensitive)
|
1257
|
-
|
1257
|
+
* @deprecated
|
1258
1258
|
* @throws {RequiredError}
|
1259
1259
|
*/
|
1260
1260
|
getPersonsCollection(cursor, limit, since, until, owner_id, first_char) {
|
@@ -1287,7 +1287,7 @@ export const PersonsApiFp = function (configuration) {
|
|
1287
1287
|
* @param {'person.picture'} [include_fields] Supports including optional fields in the results which are not provided by default
|
1288
1288
|
* @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.
|
1289
1289
|
* @param {number} [limit] Items shown per page
|
1290
|
-
|
1290
|
+
* @deprecated
|
1291
1291
|
* @throws {RequiredError}
|
1292
1292
|
*/
|
1293
1293
|
searchPersons(term, fields, exact_match, organization_id, include_fields, start, limit) {
|
@@ -1323,7 +1323,7 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
1323
1323
|
* 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.
|
1324
1324
|
* @summary Add a person
|
1325
1325
|
* @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
|
1326
|
-
|
1326
|
+
* @deprecated
|
1327
1327
|
* @throws {RequiredError}
|
1328
1328
|
*/
|
1329
1329
|
addPerson(requestParameters = {}) {
|
@@ -1353,7 +1353,7 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
1353
1353
|
* Marks a person as deleted. After 30 days, the person will be permanently deleted.
|
1354
1354
|
* @summary Delete a person
|
1355
1355
|
* @param {PersonsApiDeletePersonRequest} requestParameters Request parameters.
|
1356
|
-
|
1356
|
+
* @deprecated
|
1357
1357
|
* @throws {RequiredError}
|
1358
1358
|
*/
|
1359
1359
|
deletePerson(requestParameters) {
|
@@ -1380,10 +1380,10 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
1380
1380
|
return localVarFp.deletePersonPicture(requestParameters.id).then((request) => request(axios, basePath));
|
1381
1381
|
},
|
1382
1382
|
/**
|
1383
|
-
* Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
|
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
1384
|
* @summary Delete multiple persons in bulk
|
1385
1385
|
* @param {PersonsApiDeletePersonsRequest} requestParameters Request parameters.
|
1386
|
-
|
1386
|
+
* @deprecated
|
1387
1387
|
* @throws {RequiredError}
|
1388
1388
|
*/
|
1389
1389
|
deletePersons(requestParameters) {
|
@@ -1393,17 +1393,17 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
1393
1393
|
* 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
1394
|
* @summary Get details of a person
|
1395
1395
|
* @param {PersonsApiGetPersonRequest} requestParameters Request parameters.
|
1396
|
-
|
1396
|
+
* @deprecated
|
1397
1397
|
* @throws {RequiredError}
|
1398
1398
|
*/
|
1399
1399
|
getPerson(requestParameters) {
|
1400
1400
|
return localVarFp.getPerson(requestParameters.id).then((request) => request(axios, basePath));
|
1401
1401
|
},
|
1402
1402
|
/**
|
1403
|
-
* Lists activities associated with a person.
|
1403
|
+
* 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.
|
1404
1404
|
* @summary List activities associated with a person
|
1405
1405
|
* @param {PersonsApiGetPersonActivitiesRequest} requestParameters Request parameters.
|
1406
|
-
|
1406
|
+
* @deprecated
|
1407
1407
|
* @throws {RequiredError}
|
1408
1408
|
*/
|
1409
1409
|
getPersonActivities(requestParameters) {
|
@@ -1420,10 +1420,10 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
1420
1420
|
return localVarFp.getPersonChangelog(requestParameters.id, requestParameters.cursor, requestParameters.limit).then((request) => request(axios, basePath));
|
1421
1421
|
},
|
1422
1422
|
/**
|
1423
|
-
* Lists deals associated with a person.
|
1423
|
+
* 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.
|
1424
1424
|
* @summary List deals associated with a person
|
1425
1425
|
* @param {PersonsApiGetPersonDealsRequest} requestParameters Request parameters.
|
1426
|
-
|
1426
|
+
* @deprecated
|
1427
1427
|
* @throws {RequiredError}
|
1428
1428
|
*/
|
1429
1429
|
getPersonDeals(requestParameters) {
|
@@ -1493,17 +1493,17 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
1493
1493
|
* Returns all persons.
|
1494
1494
|
* @summary Get all persons
|
1495
1495
|
* @param {PersonsApiGetPersonsRequest} requestParameters Request parameters.
|
1496
|
-
|
1496
|
+
* @deprecated
|
1497
1497
|
* @throws {RequiredError}
|
1498
1498
|
*/
|
1499
1499
|
getPersons(requestParameters = {}) {
|
1500
1500
|
return localVarFp.getPersons(requestParameters.user_id, requestParameters.filter_id, requestParameters.first_char, requestParameters.start, requestParameters.limit, requestParameters.sort).then((request) => request(axios, basePath));
|
1501
1501
|
},
|
1502
1502
|
/**
|
1503
|
-
* Returns all persons.
|
1504
|
-
* @summary Get all persons
|
1503
|
+
* 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.
|
1504
|
+
* @summary Get all persons collection
|
1505
1505
|
* @param {PersonsApiGetPersonsCollectionRequest} requestParameters Request parameters.
|
1506
|
-
|
1506
|
+
* @deprecated
|
1507
1507
|
* @throws {RequiredError}
|
1508
1508
|
*/
|
1509
1509
|
getPersonsCollection(requestParameters = {}) {
|
@@ -1523,7 +1523,7 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
1523
1523
|
* 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.
|
1524
1524
|
* @summary Search persons
|
1525
1525
|
* @param {PersonsApiSearchPersonsRequest} requestParameters Request parameters.
|
1526
|
-
|
1526
|
+
* @deprecated
|
1527
1527
|
* @throws {RequiredError}
|
1528
1528
|
*/
|
1529
1529
|
searchPersons(requestParameters) {
|
@@ -1552,7 +1552,7 @@ export class PersonsApi extends BaseAPI {
|
|
1552
1552
|
* 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.
|
1553
1553
|
* @summary Add a person
|
1554
1554
|
* @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
|
1555
|
-
|
1555
|
+
* @deprecated
|
1556
1556
|
* @throws {RequiredError}
|
1557
1557
|
* @memberof PersonsApi
|
1558
1558
|
*/
|
@@ -1585,7 +1585,7 @@ export class PersonsApi extends BaseAPI {
|
|
1585
1585
|
* Marks a person as deleted. After 30 days, the person will be permanently deleted.
|
1586
1586
|
* @summary Delete a person
|
1587
1587
|
* @param {PersonsApiDeletePersonRequest} requestParameters Request parameters.
|
1588
|
-
|
1588
|
+
* @deprecated
|
1589
1589
|
* @throws {RequiredError}
|
1590
1590
|
* @memberof PersonsApi
|
1591
1591
|
*/
|
@@ -1615,10 +1615,10 @@ export class PersonsApi extends BaseAPI {
|
|
1615
1615
|
return PersonsApiFp(this.configuration).deletePersonPicture(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
1616
1616
|
}
|
1617
1617
|
/**
|
1618
|
-
* Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
|
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
1619
|
* @summary Delete multiple persons in bulk
|
1620
1620
|
* @param {PersonsApiDeletePersonsRequest} requestParameters Request parameters.
|
1621
|
-
|
1621
|
+
* @deprecated
|
1622
1622
|
* @throws {RequiredError}
|
1623
1623
|
* @memberof PersonsApi
|
1624
1624
|
*/
|
@@ -1629,7 +1629,7 @@ export class PersonsApi extends BaseAPI {
|
|
1629
1629
|
* 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
1630
|
* @summary Get details of a person
|
1631
1631
|
* @param {PersonsApiGetPersonRequest} requestParameters Request parameters.
|
1632
|
-
|
1632
|
+
* @deprecated
|
1633
1633
|
* @throws {RequiredError}
|
1634
1634
|
* @memberof PersonsApi
|
1635
1635
|
*/
|
@@ -1637,10 +1637,10 @@ export class PersonsApi extends BaseAPI {
|
|
1637
1637
|
return PersonsApiFp(this.configuration).getPerson(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
1638
1638
|
}
|
1639
1639
|
/**
|
1640
|
-
* Lists activities associated with a person.
|
1640
|
+
* 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.
|
1641
1641
|
* @summary List activities associated with a person
|
1642
1642
|
* @param {PersonsApiGetPersonActivitiesRequest} requestParameters Request parameters.
|
1643
|
-
|
1643
|
+
* @deprecated
|
1644
1644
|
* @throws {RequiredError}
|
1645
1645
|
* @memberof PersonsApi
|
1646
1646
|
*/
|
@@ -1659,10 +1659,10 @@ export class PersonsApi extends BaseAPI {
|
|
1659
1659
|
return PersonsApiFp(this.configuration).getPersonChangelog(requestParameters.id, requestParameters.cursor, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
1660
1660
|
}
|
1661
1661
|
/**
|
1662
|
-
* Lists deals associated with a person.
|
1662
|
+
* 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.
|
1663
1663
|
* @summary List deals associated with a person
|
1664
1664
|
* @param {PersonsApiGetPersonDealsRequest} requestParameters Request parameters.
|
1665
|
-
|
1665
|
+
* @deprecated
|
1666
1666
|
* @throws {RequiredError}
|
1667
1667
|
* @memberof PersonsApi
|
1668
1668
|
*/
|
@@ -1739,7 +1739,7 @@ export class PersonsApi extends BaseAPI {
|
|
1739
1739
|
* Returns all persons.
|
1740
1740
|
* @summary Get all persons
|
1741
1741
|
* @param {PersonsApiGetPersonsRequest} requestParameters Request parameters.
|
1742
|
-
|
1742
|
+
* @deprecated
|
1743
1743
|
* @throws {RequiredError}
|
1744
1744
|
* @memberof PersonsApi
|
1745
1745
|
*/
|
@@ -1747,10 +1747,10 @@ export class PersonsApi extends BaseAPI {
|
|
1747
1747
|
return 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));
|
1748
1748
|
}
|
1749
1749
|
/**
|
1750
|
-
* Returns all persons.
|
1751
|
-
* @summary Get all persons
|
1750
|
+
* 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.
|
1751
|
+
* @summary Get all persons collection
|
1752
1752
|
* @param {PersonsApiGetPersonsCollectionRequest} requestParameters Request parameters.
|
1753
|
-
|
1753
|
+
* @deprecated
|
1754
1754
|
* @throws {RequiredError}
|
1755
1755
|
* @memberof PersonsApi
|
1756
1756
|
*/
|
@@ -1772,7 +1772,7 @@ export class PersonsApi extends BaseAPI {
|
|
1772
1772
|
* 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.
|
1773
1773
|
* @summary Search persons
|
1774
1774
|
* @param {PersonsApiSearchPersonsRequest} requestParameters Request parameters.
|
1775
|
-
|
1775
|
+
* @deprecated
|
1776
1776
|
* @throws {RequiredError}
|
1777
1777
|
* @memberof PersonsApi
|
1778
1778
|
*/
|