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
@@ -45,7 +45,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
45
45
|
* 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.
|
46
46
|
* @summary Add a person
|
47
47
|
* @param {AddPersonRequest} [AddPersonRequest]
|
48
|
-
|
48
|
+
* @deprecated
|
49
49
|
* @throws {RequiredError}
|
50
50
|
*/
|
51
51
|
addPerson: (AddPersonRequest?: AddPersonRequest) => Promise<RequestArgs>;
|
@@ -75,7 +75,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
75
75
|
* Marks a person as deleted. After 30 days, the person will be permanently deleted.
|
76
76
|
* @summary Delete a person
|
77
77
|
* @param {number} id The ID of the person
|
78
|
-
|
78
|
+
* @deprecated
|
79
79
|
* @throws {RequiredError}
|
80
80
|
*/
|
81
81
|
deletePerson: (id: number) => Promise<RequestArgs>;
|
@@ -97,10 +97,10 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
97
97
|
*/
|
98
98
|
deletePersonPicture: (id: number) => Promise<RequestArgs>;
|
99
99
|
/**
|
100
|
-
* Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
|
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
101
|
* @summary Delete multiple persons in bulk
|
102
102
|
* @param {string} ids The comma-separated IDs that will be deleted
|
103
|
-
|
103
|
+
* @deprecated
|
104
104
|
* @throws {RequiredError}
|
105
105
|
*/
|
106
106
|
deletePersons: (ids: string) => Promise<RequestArgs>;
|
@@ -108,19 +108,19 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
108
108
|
* 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
109
|
* @summary Get details of a person
|
110
110
|
* @param {number} id The ID of the person
|
111
|
-
|
111
|
+
* @deprecated
|
112
112
|
* @throws {RequiredError}
|
113
113
|
*/
|
114
114
|
getPerson: (id: number) => Promise<RequestArgs>;
|
115
115
|
/**
|
116
|
-
* Lists activities associated with a person.
|
116
|
+
* 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.
|
117
117
|
* @summary List activities associated with a person
|
118
118
|
* @param {number} id The ID of the person
|
119
119
|
* @param {number} [start] Pagination start
|
120
120
|
* @param {number} [limit] Items shown per page
|
121
121
|
* @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.
|
122
122
|
* @param {string} [exclude] A comma-separated string of activity IDs to exclude from result
|
123
|
-
|
123
|
+
* @deprecated
|
124
124
|
* @throws {RequiredError}
|
125
125
|
*/
|
126
126
|
getPersonActivities: (id: number, start?: number, limit?: number, done?: 0 | 1, exclude?: string) => Promise<RequestArgs>;
|
@@ -135,14 +135,14 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
135
135
|
*/
|
136
136
|
getPersonChangelog: (id: number, cursor?: string, limit?: number) => Promise<RequestArgs>;
|
137
137
|
/**
|
138
|
-
* Lists deals associated with a person.
|
138
|
+
* 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.
|
139
139
|
* @summary List deals associated with a person
|
140
140
|
* @param {number} id The ID of the person
|
141
141
|
* @param {number} [start] Pagination start
|
142
142
|
* @param {number} [limit] Items shown per page
|
143
143
|
* @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.
|
144
144
|
* @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).
|
145
|
-
|
145
|
+
* @deprecated
|
146
146
|
* @throws {RequiredError}
|
147
147
|
*/
|
148
148
|
getPersonDeals: (id: number, start?: number, limit?: number, status?: 'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted', sort?: string) => Promise<RequestArgs>;
|
@@ -214,20 +214,20 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
214
214
|
* @param {number} [start] Pagination start
|
215
215
|
* @param {number} [limit] Items shown per page
|
216
216
|
* @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).
|
217
|
-
|
217
|
+
* @deprecated
|
218
218
|
* @throws {RequiredError}
|
219
219
|
*/
|
220
220
|
getPersons: (user_id?: number, filter_id?: number, first_char?: string, start?: number, limit?: number, sort?: string) => Promise<RequestArgs>;
|
221
221
|
/**
|
222
|
-
* Returns all persons.
|
223
|
-
* @summary Get all persons
|
222
|
+
* 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.
|
223
|
+
* @summary Get all persons collection
|
224
224
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
225
225
|
* @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.
|
226
226
|
* @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.
|
227
227
|
* @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.
|
228
228
|
* @param {number} [owner_id] If supplied, only persons owned by the given user will be returned
|
229
229
|
* @param {string} [first_char] If supplied, only persons whose name starts with the specified letter will be returned (case-insensitive)
|
230
|
-
|
230
|
+
* @deprecated
|
231
231
|
* @throws {RequiredError}
|
232
232
|
*/
|
233
233
|
getPersonsCollection: (cursor?: string, limit?: number, since?: string, until?: string, owner_id?: number, first_char?: string) => Promise<RequestArgs>;
|
@@ -250,7 +250,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
250
250
|
* @param {'person.picture'} [include_fields] Supports including optional fields in the results which are not provided by default
|
251
251
|
* @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.
|
252
252
|
* @param {number} [limit] Items shown per page
|
253
|
-
|
253
|
+
* @deprecated
|
254
254
|
* @throws {RequiredError}
|
255
255
|
*/
|
256
256
|
searchPersons: (term: string, fields?: 'custom_fields' | 'email' | 'notes' | 'phone' | 'name', exact_match?: boolean, organization_id?: number, include_fields?: 'person.picture', start?: number, limit?: number) => Promise<RequestArgs>;
|
@@ -273,7 +273,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
273
273
|
* 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.
|
274
274
|
* @summary Add a person
|
275
275
|
* @param {AddPersonRequest} [AddPersonRequest]
|
276
|
-
|
276
|
+
* @deprecated
|
277
277
|
* @throws {RequiredError}
|
278
278
|
*/
|
279
279
|
addPerson(AddPersonRequest?: AddPersonRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddPersonResponse>>;
|
@@ -303,7 +303,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
303
303
|
* Marks a person as deleted. After 30 days, the person will be permanently deleted.
|
304
304
|
* @summary Delete a person
|
305
305
|
* @param {number} id The ID of the person
|
306
|
-
|
306
|
+
* @deprecated
|
307
307
|
* @throws {RequiredError}
|
308
308
|
*/
|
309
309
|
deletePerson(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeletePersonResponse>>;
|
@@ -325,10 +325,10 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
325
325
|
*/
|
326
326
|
deletePersonPicture(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeletePersonResponse>>;
|
327
327
|
/**
|
328
|
-
* Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
|
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
329
|
* @summary Delete multiple persons in bulk
|
330
330
|
* @param {string} ids The comma-separated IDs that will be deleted
|
331
|
-
|
331
|
+
* @deprecated
|
332
332
|
* @throws {RequiredError}
|
333
333
|
*/
|
334
334
|
deletePersons(ids: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeletePersonsResponse>>;
|
@@ -336,19 +336,19 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
336
336
|
* 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
337
|
* @summary Get details of a person
|
338
338
|
* @param {number} id The ID of the person
|
339
|
-
|
339
|
+
* @deprecated
|
340
340
|
* @throws {RequiredError}
|
341
341
|
*/
|
342
342
|
getPerson(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonDetailsResponse>>;
|
343
343
|
/**
|
344
|
-
* Lists activities associated with a person.
|
344
|
+
* 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.
|
345
345
|
* @summary List activities associated with a person
|
346
346
|
* @param {number} id The ID of the person
|
347
347
|
* @param {number} [start] Pagination start
|
348
348
|
* @param {number} [limit] Items shown per page
|
349
349
|
* @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.
|
350
350
|
* @param {string} [exclude] A comma-separated string of activity IDs to exclude from result
|
351
|
-
|
351
|
+
* @deprecated
|
352
352
|
* @throws {RequiredError}
|
353
353
|
*/
|
354
354
|
getPersonActivities(id: number, start?: number, limit?: number, done?: 0 | 1, exclude?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedActivitiesResponse>>;
|
@@ -363,14 +363,14 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
363
363
|
*/
|
364
364
|
getPersonChangelog(id: number, cursor?: string, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetChangelogResponse>>;
|
365
365
|
/**
|
366
|
-
* Lists deals associated with a person.
|
366
|
+
* 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.
|
367
367
|
* @summary List deals associated with a person
|
368
368
|
* @param {number} id The ID of the person
|
369
369
|
* @param {number} [start] Pagination start
|
370
370
|
* @param {number} [limit] Items shown per page
|
371
371
|
* @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.
|
372
372
|
* @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).
|
373
|
-
|
373
|
+
* @deprecated
|
374
374
|
* @throws {RequiredError}
|
375
375
|
*/
|
376
376
|
getPersonDeals(id: number, start?: number, limit?: number, status?: 'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted', sort?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedDealsResponse>>;
|
@@ -442,20 +442,20 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
442
442
|
* @param {number} [start] Pagination start
|
443
443
|
* @param {number} [limit] Items shown per page
|
444
444
|
* @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).
|
445
|
-
|
445
|
+
* @deprecated
|
446
446
|
* @throws {RequiredError}
|
447
447
|
*/
|
448
448
|
getPersons(user_id?: number, filter_id?: number, first_char?: string, start?: number, limit?: number, sort?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonsResponse1>>;
|
449
449
|
/**
|
450
|
-
* Returns all persons.
|
451
|
-
* @summary Get all persons
|
450
|
+
* 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.
|
451
|
+
* @summary Get all persons collection
|
452
452
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
453
453
|
* @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.
|
454
454
|
* @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.
|
455
455
|
* @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.
|
456
456
|
* @param {number} [owner_id] If supplied, only persons owned by the given user will be returned
|
457
457
|
* @param {string} [first_char] If supplied, only persons whose name starts with the specified letter will be returned (case-insensitive)
|
458
|
-
|
458
|
+
* @deprecated
|
459
459
|
* @throws {RequiredError}
|
460
460
|
*/
|
461
461
|
getPersonsCollection(cursor?: string, limit?: number, since?: string, until?: string, owner_id?: number, first_char?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonsCollection200Response>>;
|
@@ -478,7 +478,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
478
478
|
* @param {'person.picture'} [include_fields] Supports including optional fields in the results which are not provided by default
|
479
479
|
* @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.
|
480
480
|
* @param {number} [limit] Items shown per page
|
481
|
-
|
481
|
+
* @deprecated
|
482
482
|
* @throws {RequiredError}
|
483
483
|
*/
|
484
484
|
searchPersons(term: string, fields?: 'custom_fields' | 'email' | 'notes' | 'phone' | 'name', exact_match?: boolean, organization_id?: number, include_fields?: 'person.picture', start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonSearchResponse>>;
|
@@ -501,7 +501,7 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
|
|
501
501
|
* 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.
|
502
502
|
* @summary Add a person
|
503
503
|
* @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
|
504
|
-
|
504
|
+
* @deprecated
|
505
505
|
* @throws {RequiredError}
|
506
506
|
*/
|
507
507
|
addPerson(requestParameters?: PersonsApiAddPersonRequest): Promise<AddPersonResponse>;
|
@@ -525,7 +525,7 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
|
|
525
525
|
* Marks a person as deleted. After 30 days, the person will be permanently deleted.
|
526
526
|
* @summary Delete a person
|
527
527
|
* @param {PersonsApiDeletePersonRequest} requestParameters Request parameters.
|
528
|
-
|
528
|
+
* @deprecated
|
529
529
|
* @throws {RequiredError}
|
530
530
|
*/
|
531
531
|
deletePerson(requestParameters: PersonsApiDeletePersonRequest): Promise<DeletePersonResponse>;
|
@@ -546,10 +546,10 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
|
|
546
546
|
*/
|
547
547
|
deletePersonPicture(requestParameters: PersonsApiDeletePersonPictureRequest): Promise<DeletePersonResponse>;
|
548
548
|
/**
|
549
|
-
* Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
|
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
550
|
* @summary Delete multiple persons in bulk
|
551
551
|
* @param {PersonsApiDeletePersonsRequest} requestParameters Request parameters.
|
552
|
-
|
552
|
+
* @deprecated
|
553
553
|
* @throws {RequiredError}
|
554
554
|
*/
|
555
555
|
deletePersons(requestParameters: PersonsApiDeletePersonsRequest): Promise<DeletePersonsResponse>;
|
@@ -557,15 +557,15 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
|
|
557
557
|
* 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
558
|
* @summary Get details of a person
|
559
559
|
* @param {PersonsApiGetPersonRequest} requestParameters Request parameters.
|
560
|
-
|
560
|
+
* @deprecated
|
561
561
|
* @throws {RequiredError}
|
562
562
|
*/
|
563
563
|
getPerson(requestParameters: PersonsApiGetPersonRequest): Promise<GetPersonDetailsResponse>;
|
564
564
|
/**
|
565
|
-
* Lists activities associated with a person.
|
565
|
+
* 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.
|
566
566
|
* @summary List activities associated with a person
|
567
567
|
* @param {PersonsApiGetPersonActivitiesRequest} requestParameters Request parameters.
|
568
|
-
|
568
|
+
* @deprecated
|
569
569
|
* @throws {RequiredError}
|
570
570
|
*/
|
571
571
|
getPersonActivities(requestParameters: PersonsApiGetPersonActivitiesRequest): Promise<GetAssociatedActivitiesResponse>;
|
@@ -578,10 +578,10 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
|
|
578
578
|
*/
|
579
579
|
getPersonChangelog(requestParameters: PersonsApiGetPersonChangelogRequest): Promise<GetChangelogResponse>;
|
580
580
|
/**
|
581
|
-
* Lists deals associated with a person.
|
581
|
+
* 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.
|
582
582
|
* @summary List deals associated with a person
|
583
583
|
* @param {PersonsApiGetPersonDealsRequest} requestParameters Request parameters.
|
584
|
-
|
584
|
+
* @deprecated
|
585
585
|
* @throws {RequiredError}
|
586
586
|
*/
|
587
587
|
getPersonDeals(requestParameters: PersonsApiGetPersonDealsRequest): Promise<GetAssociatedDealsResponse>;
|
@@ -637,15 +637,15 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
|
|
637
637
|
* Returns all persons.
|
638
638
|
* @summary Get all persons
|
639
639
|
* @param {PersonsApiGetPersonsRequest} requestParameters Request parameters.
|
640
|
-
|
640
|
+
* @deprecated
|
641
641
|
* @throws {RequiredError}
|
642
642
|
*/
|
643
643
|
getPersons(requestParameters?: PersonsApiGetPersonsRequest): Promise<GetPersonsResponse1>;
|
644
644
|
/**
|
645
|
-
* Returns all persons.
|
646
|
-
* @summary Get all persons
|
645
|
+
* 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.
|
646
|
+
* @summary Get all persons collection
|
647
647
|
* @param {PersonsApiGetPersonsCollectionRequest} requestParameters Request parameters.
|
648
|
-
|
648
|
+
* @deprecated
|
649
649
|
* @throws {RequiredError}
|
650
650
|
*/
|
651
651
|
getPersonsCollection(requestParameters?: PersonsApiGetPersonsCollectionRequest): Promise<GetPersonsCollection200Response>;
|
@@ -661,7 +661,7 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
|
|
661
661
|
* 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.
|
662
662
|
* @summary Search persons
|
663
663
|
* @param {PersonsApiSearchPersonsRequest} requestParameters Request parameters.
|
664
|
-
|
664
|
+
* @deprecated
|
665
665
|
* @throws {RequiredError}
|
666
666
|
*/
|
667
667
|
searchPersons(requestParameters: PersonsApiSearchPersonsRequest): Promise<GetPersonSearchResponse>;
|
@@ -1247,7 +1247,7 @@ export declare class PersonsApi extends BaseAPI {
|
|
1247
1247
|
* 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.
|
1248
1248
|
* @summary Add a person
|
1249
1249
|
* @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
|
1250
|
-
|
1250
|
+
* @deprecated
|
1251
1251
|
* @throws {RequiredError}
|
1252
1252
|
* @memberof PersonsApi
|
1253
1253
|
*/
|
@@ -1274,7 +1274,7 @@ export declare class PersonsApi extends BaseAPI {
|
|
1274
1274
|
* Marks a person as deleted. After 30 days, the person will be permanently deleted.
|
1275
1275
|
* @summary Delete a person
|
1276
1276
|
* @param {PersonsApiDeletePersonRequest} requestParameters Request parameters.
|
1277
|
-
|
1277
|
+
* @deprecated
|
1278
1278
|
* @throws {RequiredError}
|
1279
1279
|
* @memberof PersonsApi
|
1280
1280
|
*/
|
@@ -1298,10 +1298,10 @@ export declare class PersonsApi extends BaseAPI {
|
|
1298
1298
|
*/
|
1299
1299
|
deletePersonPicture(requestParameters: PersonsApiDeletePersonPictureRequest): Promise<DeletePersonResponse>;
|
1300
1300
|
/**
|
1301
|
-
* Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
|
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
1302
|
* @summary Delete multiple persons in bulk
|
1303
1303
|
* @param {PersonsApiDeletePersonsRequest} requestParameters Request parameters.
|
1304
|
-
|
1304
|
+
* @deprecated
|
1305
1305
|
* @throws {RequiredError}
|
1306
1306
|
* @memberof PersonsApi
|
1307
1307
|
*/
|
@@ -1310,16 +1310,16 @@ export declare class PersonsApi extends BaseAPI {
|
|
1310
1310
|
* 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
1311
|
* @summary Get details of a person
|
1312
1312
|
* @param {PersonsApiGetPersonRequest} requestParameters Request parameters.
|
1313
|
-
|
1313
|
+
* @deprecated
|
1314
1314
|
* @throws {RequiredError}
|
1315
1315
|
* @memberof PersonsApi
|
1316
1316
|
*/
|
1317
1317
|
getPerson(requestParameters: PersonsApiGetPersonRequest): Promise<GetPersonDetailsResponse>;
|
1318
1318
|
/**
|
1319
|
-
* Lists activities associated with a person.
|
1319
|
+
* 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.
|
1320
1320
|
* @summary List activities associated with a person
|
1321
1321
|
* @param {PersonsApiGetPersonActivitiesRequest} requestParameters Request parameters.
|
1322
|
-
|
1322
|
+
* @deprecated
|
1323
1323
|
* @throws {RequiredError}
|
1324
1324
|
* @memberof PersonsApi
|
1325
1325
|
*/
|
@@ -1334,10 +1334,10 @@ export declare class PersonsApi extends BaseAPI {
|
|
1334
1334
|
*/
|
1335
1335
|
getPersonChangelog(requestParameters: PersonsApiGetPersonChangelogRequest): Promise<GetChangelogResponse>;
|
1336
1336
|
/**
|
1337
|
-
* Lists deals associated with a person.
|
1337
|
+
* 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.
|
1338
1338
|
* @summary List deals associated with a person
|
1339
1339
|
* @param {PersonsApiGetPersonDealsRequest} requestParameters Request parameters.
|
1340
|
-
|
1340
|
+
* @deprecated
|
1341
1341
|
* @throws {RequiredError}
|
1342
1342
|
* @memberof PersonsApi
|
1343
1343
|
*/
|
@@ -1400,16 +1400,16 @@ export declare class PersonsApi extends BaseAPI {
|
|
1400
1400
|
* Returns all persons.
|
1401
1401
|
* @summary Get all persons
|
1402
1402
|
* @param {PersonsApiGetPersonsRequest} requestParameters Request parameters.
|
1403
|
-
|
1403
|
+
* @deprecated
|
1404
1404
|
* @throws {RequiredError}
|
1405
1405
|
* @memberof PersonsApi
|
1406
1406
|
*/
|
1407
1407
|
getPersons(requestParameters?: PersonsApiGetPersonsRequest): Promise<GetPersonsResponse1>;
|
1408
1408
|
/**
|
1409
|
-
* Returns all persons.
|
1410
|
-
* @summary Get all persons
|
1409
|
+
* 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.
|
1410
|
+
* @summary Get all persons collection
|
1411
1411
|
* @param {PersonsApiGetPersonsCollectionRequest} requestParameters Request parameters.
|
1412
|
-
|
1412
|
+
* @deprecated
|
1413
1413
|
* @throws {RequiredError}
|
1414
1414
|
* @memberof PersonsApi
|
1415
1415
|
*/
|
@@ -1427,7 +1427,7 @@ export declare class PersonsApi extends BaseAPI {
|
|
1427
1427
|
* 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.
|
1428
1428
|
* @summary Search persons
|
1429
1429
|
* @param {PersonsApiSearchPersonsRequest} requestParameters Request parameters.
|
1430
|
-
|
1430
|
+
* @deprecated
|
1431
1431
|
* @throws {RequiredError}
|
1432
1432
|
* @memberof PersonsApi
|
1433
1433
|
*/
|