pipedrive 13.1.1 → 13.1.2
Sign up to get free protection for your applications and to get access to all the features.
- package/CHANGELOG.md +4 -0
- package/README.md +5 -5
- package/dist/api/ActivitiesApi.js +2 -2
- package/dist/api/ActivityTypesApi.js +36 -36
- package/dist/api/DealFieldsApi.js +8 -8
- package/dist/api/DealsApi.js +12 -12
- package/dist/api/FilesApi.js +8 -8
- package/dist/api/FiltersApi.js +4 -4
- package/dist/api/LeadSourcesApi.js +2 -2
- package/dist/api/LeadsApi.js +2 -2
- package/dist/api/MailboxApi.js +2 -2
- package/dist/api/OrganizationFieldsApi.js +6 -6
- package/dist/api/OrganizationsApi.js +6 -6
- package/dist/api/PersonFieldsApi.js +6 -6
- package/dist/api/PersonsApi.js +6 -6
- package/dist/api/ProductFieldsApi.js +6 -6
- package/dist/api/ProductsApi.js +4 -4
- package/dist/api/WebhooksApi.js +2 -2
- package/dist/model/ActivityTypeBulkDeleteResponseAllOfData.js +1 -1
- package/dist/model/ActivityTypeListResponse.js +2 -2
- package/dist/model/ActivityTypeListResponseAllOf.js +1 -1
- package/dist/model/ActivityTypeObjectResponse.js +9 -9
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
@@ -8,6 +8,10 @@ For public Changelog covering all changes done to Pipedrive’s API, webhooks an
|
|
8
8
|
|
9
9
|
## [Unreleased]
|
10
10
|
|
11
|
+
## 13.1.2
|
12
|
+
### Fixed
|
13
|
+
- Styling fixes: capitalization, tutorial links' texts, code-highlighting in descriptions
|
14
|
+
|
11
15
|
## 13.1.1
|
12
16
|
### Changed
|
13
17
|
- Changed person-related endpoints to include `marketing_status` body parameter: `POST /v1/persons`, `PUT /v1/persons/{id}`
|
package/README.md
CHANGED
@@ -271,11 +271,11 @@ Class | Method | HTTP request | Description
|
|
271
271
|
*Pipedrive.ActivitiesApi* | [**getActivity**](docs/ActivitiesApi.md#getActivity) | **GET** /activities/{id} | Get details of an activity
|
272
272
|
*Pipedrive.ActivitiesApi* | [**updateActivity**](docs/ActivitiesApi.md#updateActivity) | **PUT** /activities/{id} | Update an activity
|
273
273
|
*Pipedrive.ActivityFieldsApi* | [**getActivityFields**](docs/ActivityFieldsApi.md#getActivityFields) | **GET** /activityFields | Get all activity fields
|
274
|
-
*Pipedrive.ActivityTypesApi* | [**addActivityType**](docs/ActivityTypesApi.md#addActivityType) | **POST** /activityTypes | Add new
|
275
|
-
*Pipedrive.ActivityTypesApi* | [**deleteActivityType**](docs/ActivityTypesApi.md#deleteActivityType) | **DELETE** /activityTypes/{id} | Delete an
|
276
|
-
*Pipedrive.ActivityTypesApi* | [**deleteActivityTypes**](docs/ActivityTypesApi.md#deleteActivityTypes) | **DELETE** /activityTypes | Delete multiple
|
277
|
-
*Pipedrive.ActivityTypesApi* | [**getActivityTypes**](docs/ActivityTypesApi.md#getActivityTypes) | **GET** /activityTypes | Get all
|
278
|
-
*Pipedrive.ActivityTypesApi* | [**updateActivityType**](docs/ActivityTypesApi.md#updateActivityType) | **PUT** /activityTypes/{id} | Update an
|
274
|
+
*Pipedrive.ActivityTypesApi* | [**addActivityType**](docs/ActivityTypesApi.md#addActivityType) | **POST** /activityTypes | Add new activity type
|
275
|
+
*Pipedrive.ActivityTypesApi* | [**deleteActivityType**](docs/ActivityTypesApi.md#deleteActivityType) | **DELETE** /activityTypes/{id} | Delete an activity type
|
276
|
+
*Pipedrive.ActivityTypesApi* | [**deleteActivityTypes**](docs/ActivityTypesApi.md#deleteActivityTypes) | **DELETE** /activityTypes | Delete multiple activity types in bulk
|
277
|
+
*Pipedrive.ActivityTypesApi* | [**getActivityTypes**](docs/ActivityTypesApi.md#getActivityTypes) | **GET** /activityTypes | Get all activity types
|
278
|
+
*Pipedrive.ActivityTypesApi* | [**updateActivityType**](docs/ActivityTypesApi.md#updateActivityType) | **PUT** /activityTypes/{id} | Update an activity type
|
279
279
|
*Pipedrive.CallLogsApi* | [**addCallLog**](docs/CallLogsApi.md#addCallLog) | **POST** /callLogs | Add a call log
|
280
280
|
*Pipedrive.CallLogsApi* | [**addCallLogAudioFile**](docs/CallLogsApi.md#addCallLogAudioFile) | **POST** /callLogs/{id}/recordings | Attach an audio file to the call log
|
281
281
|
*Pipedrive.CallLogsApi* | [**deleteCallLog**](docs/CallLogsApi.md#deleteCallLog) | **DELETE** /callLogs/{id} | Delete a call log
|
@@ -56,7 +56,7 @@ var ActivitiesApi = /*#__PURE__*/function () {
|
|
56
56
|
}
|
57
57
|
/**
|
58
58
|
* Add an activity
|
59
|
-
* Adds a new activity. Includes `more_activities_scheduled_in_context` property in response's `additional_data` which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data). For more information
|
59
|
+
* Adds a new activity. Includes `more_activities_scheduled_in_context` property in response's `additional_data` which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data). For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-an-activity\" target=\"_blank\" rel=\"noopener noreferrer\">adding an activity</a>.
|
60
60
|
* @param {Object} opts Optional parameters
|
61
61
|
* @param {module:model/ActivityPostObject} opts.activityPostObject
|
62
62
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddActivityResponse200} and HTTP response
|
@@ -94,7 +94,7 @@ var ActivitiesApi = /*#__PURE__*/function () {
|
|
94
94
|
}
|
95
95
|
/**
|
96
96
|
* Add an activity
|
97
|
-
* Adds a new activity. Includes `more_activities_scheduled_in_context` property in response's `additional_data` which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data). For more information
|
97
|
+
* Adds a new activity. Includes `more_activities_scheduled_in_context` property in response's `additional_data` which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data). For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-an-activity\" target=\"_blank\" rel=\"noopener noreferrer\">adding an activity</a>.
|
98
98
|
* @param {Object} opts Optional parameters
|
99
99
|
* @param {module:model/ActivityPostObject} opts.activityPostObject
|
100
100
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddActivityResponse200}
|
@@ -45,12 +45,12 @@ var ActivityTypesApi = /*#__PURE__*/function () {
|
|
45
45
|
this.apiClient = apiClient || _ApiClient["default"].instance;
|
46
46
|
}
|
47
47
|
/**
|
48
|
-
* Add new
|
49
|
-
* Adds a new
|
50
|
-
* @param {String} name The name of the
|
48
|
+
* Add new activity type
|
49
|
+
* Adds a new activity type.
|
50
|
+
* @param {String} name The name of the activity type
|
51
51
|
* @param {module:model/IconKey} iconKey
|
52
52
|
* @param {Object} opts Optional parameters
|
53
|
-
* @param {String} opts.color A designated color for the
|
53
|
+
* @param {String} opts.color A designated color for the activity type in 6-character HEX format (e.g. `FFFFFF` for white, `000000` for black)
|
54
54
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ActivityTypeCreateUpdateDeleteResponse} and HTTP response
|
55
55
|
*/
|
56
56
|
|
@@ -99,12 +99,12 @@ var ActivityTypesApi = /*#__PURE__*/function () {
|
|
99
99
|
return this.apiClient.callApi('/activityTypes', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
100
100
|
}
|
101
101
|
/**
|
102
|
-
* Add new
|
103
|
-
* Adds a new
|
104
|
-
* @param {String} name The name of the
|
102
|
+
* Add new activity type
|
103
|
+
* Adds a new activity type.
|
104
|
+
* @param {String} name The name of the activity type
|
105
105
|
* @param {module:model/IconKey} iconKey
|
106
106
|
* @param {Object} opts Optional parameters
|
107
|
-
* @param {String} opts.color A designated color for the
|
107
|
+
* @param {String} opts.color A designated color for the activity type in 6-character HEX format (e.g. `FFFFFF` for white, `000000` for black)
|
108
108
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ActivityTypeCreateUpdateDeleteResponse}
|
109
109
|
*/
|
110
110
|
|
@@ -116,9 +116,9 @@ var ActivityTypesApi = /*#__PURE__*/function () {
|
|
116
116
|
});
|
117
117
|
}
|
118
118
|
/**
|
119
|
-
* Delete an
|
120
|
-
* Marks an
|
121
|
-
* @param {Number} id The ID of the
|
119
|
+
* Delete an activity type
|
120
|
+
* Marks an activity type as deleted.
|
121
|
+
* @param {Number} id The ID of the activity type
|
122
122
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ActivityTypeCreateUpdateDeleteResponse} and HTTP response
|
123
123
|
*/
|
124
124
|
|
@@ -159,9 +159,9 @@ var ActivityTypesApi = /*#__PURE__*/function () {
|
|
159
159
|
return this.apiClient.callApi('/activityTypes/{id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
160
160
|
}
|
161
161
|
/**
|
162
|
-
* Delete an
|
163
|
-
* Marks an
|
164
|
-
* @param {Number} id The ID of the
|
162
|
+
* Delete an activity type
|
163
|
+
* Marks an activity type as deleted.
|
164
|
+
* @param {Number} id The ID of the activity type
|
165
165
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ActivityTypeCreateUpdateDeleteResponse}
|
166
166
|
*/
|
167
167
|
|
@@ -173,9 +173,9 @@ var ActivityTypesApi = /*#__PURE__*/function () {
|
|
173
173
|
});
|
174
174
|
}
|
175
175
|
/**
|
176
|
-
* Delete multiple
|
177
|
-
* Marks multiple
|
178
|
-
* @param {String} ids The comma-separated
|
176
|
+
* Delete multiple activity types in bulk
|
177
|
+
* Marks multiple activity types as deleted.
|
178
|
+
* @param {String} ids The comma-separated activity type IDs
|
179
179
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ActivityTypeBulkDeleteResponse} and HTTP response
|
180
180
|
*/
|
181
181
|
|
@@ -216,9 +216,9 @@ var ActivityTypesApi = /*#__PURE__*/function () {
|
|
216
216
|
return this.apiClient.callApi('/activityTypes', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
217
217
|
}
|
218
218
|
/**
|
219
|
-
* Delete multiple
|
220
|
-
* Marks multiple
|
221
|
-
* @param {String} ids The comma-separated
|
219
|
+
* Delete multiple activity types in bulk
|
220
|
+
* Marks multiple activity types as deleted.
|
221
|
+
* @param {String} ids The comma-separated activity type IDs
|
222
222
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ActivityTypeBulkDeleteResponse}
|
223
223
|
*/
|
224
224
|
|
@@ -230,8 +230,8 @@ var ActivityTypesApi = /*#__PURE__*/function () {
|
|
230
230
|
});
|
231
231
|
}
|
232
232
|
/**
|
233
|
-
* Get all
|
234
|
-
* Returns all
|
233
|
+
* Get all activity types
|
234
|
+
* Returns all activity types.
|
235
235
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ActivityTypeListResponse} and HTTP response
|
236
236
|
*/
|
237
237
|
|
@@ -265,8 +265,8 @@ var ActivityTypesApi = /*#__PURE__*/function () {
|
|
265
265
|
return this.apiClient.callApi('/activityTypes', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
266
266
|
}
|
267
267
|
/**
|
268
|
-
* Get all
|
269
|
-
* Returns all
|
268
|
+
* Get all activity types
|
269
|
+
* Returns all activity types.
|
270
270
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ActivityTypeListResponse}
|
271
271
|
*/
|
272
272
|
|
@@ -278,14 +278,14 @@ var ActivityTypesApi = /*#__PURE__*/function () {
|
|
278
278
|
});
|
279
279
|
}
|
280
280
|
/**
|
281
|
-
* Update an
|
282
|
-
* Updates an
|
283
|
-
* @param {Number} id The ID of the
|
281
|
+
* Update an activity type
|
282
|
+
* Updates an activity type.
|
283
|
+
* @param {Number} id The ID of the activity type
|
284
284
|
* @param {Object} opts Optional parameters
|
285
|
-
* @param {String} opts.name The name of the
|
285
|
+
* @param {String} opts.name The name of the activity type
|
286
286
|
* @param {module:model/IconKey} opts.iconKey
|
287
|
-
* @param {String} opts.color A designated color for the
|
288
|
-
* @param {Number} opts.orderNr An order number for this
|
287
|
+
* @param {String} opts.color A designated color for the activity type in 6-character HEX format (e.g. `FFFFFF` for white, `000000` for black)
|
288
|
+
* @param {Number} opts.orderNr An order number for this activity type. Order numbers should be used to order the types in the activity type selections.
|
289
289
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ActivityTypeCreateUpdateDeleteResponse} and HTTP response
|
290
290
|
*/
|
291
291
|
|
@@ -331,14 +331,14 @@ var ActivityTypesApi = /*#__PURE__*/function () {
|
|
331
331
|
return this.apiClient.callApi('/activityTypes/{id}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
332
332
|
}
|
333
333
|
/**
|
334
|
-
* Update an
|
335
|
-
* Updates an
|
336
|
-
* @param {Number} id The ID of the
|
334
|
+
* Update an activity type
|
335
|
+
* Updates an activity type.
|
336
|
+
* @param {Number} id The ID of the activity type
|
337
337
|
* @param {Object} opts Optional parameters
|
338
|
-
* @param {String} opts.name The name of the
|
338
|
+
* @param {String} opts.name The name of the activity type
|
339
339
|
* @param {module:model/IconKey} opts.iconKey
|
340
|
-
* @param {String} opts.color A designated color for the
|
341
|
-
* @param {Number} opts.orderNr An order number for this
|
340
|
+
* @param {String} opts.color A designated color for the activity type in 6-character HEX format (e.g. `FFFFFF` for white, `000000` for black)
|
341
|
+
* @param {Number} opts.orderNr An order number for this activity type. Order numbers should be used to order the types in the activity type selections.
|
342
342
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ActivityTypeCreateUpdateDeleteResponse}
|
343
343
|
*/
|
344
344
|
|
@@ -50,7 +50,7 @@ var DealFieldsApi = /*#__PURE__*/function () {
|
|
50
50
|
}
|
51
51
|
/**
|
52
52
|
* Add a new deal field
|
53
|
-
* Adds a new deal field. For more information
|
53
|
+
* Adds a new deal field. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-new-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">adding a new custom field</a>.
|
54
54
|
* @param {Object} opts Optional parameters
|
55
55
|
* @param {module:model/FieldCreateRequest} opts.fieldCreateRequest
|
56
56
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/FieldResponse} and HTTP response
|
@@ -88,7 +88,7 @@ var DealFieldsApi = /*#__PURE__*/function () {
|
|
88
88
|
}
|
89
89
|
/**
|
90
90
|
* Add a new deal field
|
91
|
-
* Adds a new deal field. For more information
|
91
|
+
* Adds a new deal field. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-new-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">adding a new custom field</a>.
|
92
92
|
* @param {Object} opts Optional parameters
|
93
93
|
* @param {module:model/FieldCreateRequest} opts.fieldCreateRequest
|
94
94
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/FieldResponse}
|
@@ -103,7 +103,7 @@ var DealFieldsApi = /*#__PURE__*/function () {
|
|
103
103
|
}
|
104
104
|
/**
|
105
105
|
* Delete a deal field
|
106
|
-
* Marks a field as deleted. For more information
|
106
|
+
* Marks a field as deleted. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/deleting-a-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">deleting a custom field</a>.
|
107
107
|
* @param {Number} id The ID of the field
|
108
108
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteResponse} and HTTP response
|
109
109
|
*/
|
@@ -146,7 +146,7 @@ var DealFieldsApi = /*#__PURE__*/function () {
|
|
146
146
|
}
|
147
147
|
/**
|
148
148
|
* Delete a deal field
|
149
|
-
* Marks a field as deleted. For more information
|
149
|
+
* Marks a field as deleted. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/deleting-a-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">deleting a custom field</a>.
|
150
150
|
* @param {Number} id The ID of the field
|
151
151
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteResponse}
|
152
152
|
*/
|
@@ -160,7 +160,7 @@ var DealFieldsApi = /*#__PURE__*/function () {
|
|
160
160
|
}
|
161
161
|
/**
|
162
162
|
* Delete multiple deal fields in bulk
|
163
|
-
* Marks multiple fields as deleted.
|
163
|
+
* Marks multiple deal fields as deleted.
|
164
164
|
* @param {String} ids The comma-separated field IDs to delete
|
165
165
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/BulkDeleteResponse} and HTTP response
|
166
166
|
*/
|
@@ -203,7 +203,7 @@ var DealFieldsApi = /*#__PURE__*/function () {
|
|
203
203
|
}
|
204
204
|
/**
|
205
205
|
* Delete multiple deal fields in bulk
|
206
|
-
* Marks multiple fields as deleted.
|
206
|
+
* Marks multiple deal fields as deleted.
|
207
207
|
* @param {String} ids The comma-separated field IDs to delete
|
208
208
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/BulkDeleteResponse}
|
209
209
|
*/
|
@@ -331,7 +331,7 @@ var DealFieldsApi = /*#__PURE__*/function () {
|
|
331
331
|
}
|
332
332
|
/**
|
333
333
|
* Update a deal field
|
334
|
-
* Updates a deal field.
|
334
|
+
* Updates a deal field. For more information, see the tutorial for <a href=\" https://pipedrive.readme.io/docs/updating-custom-field-value \" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields' values</a>.
|
335
335
|
* @param {Number} id The ID of the field
|
336
336
|
* @param {Object} opts Optional parameters
|
337
337
|
* @param {module:model/FieldUpdateRequest} opts.fieldUpdateRequest
|
@@ -376,7 +376,7 @@ var DealFieldsApi = /*#__PURE__*/function () {
|
|
376
376
|
}
|
377
377
|
/**
|
378
378
|
* Update a deal field
|
379
|
-
* Updates a deal field.
|
379
|
+
* Updates a deal field. For more information, see the tutorial for <a href=\" https://pipedrive.readme.io/docs/updating-custom-field-value \" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields' values</a>.
|
380
380
|
* @param {Number} id The ID of the field
|
381
381
|
* @param {Object} opts Optional parameters
|
382
382
|
* @param {module:model/FieldUpdateRequest} opts.fieldUpdateRequest
|
package/dist/api/DealsApi.js
CHANGED
@@ -106,7 +106,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
106
106
|
}
|
107
107
|
/**
|
108
108
|
* Add a deal
|
109
|
-
* Adds a new deal. 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 dealFields and look for `key` values. For more information
|
109
|
+
* Adds a new deal. 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 dealFields and look for `key` values. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/creating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">adding a deal</a>.
|
110
110
|
* @param {Object} opts Optional parameters
|
111
111
|
* @param {module:model/NewDeal} opts.newDeal
|
112
112
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetAddedDeal} and HTTP response
|
@@ -144,7 +144,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
144
144
|
}
|
145
145
|
/**
|
146
146
|
* Add a deal
|
147
|
-
* Adds a new deal. 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 dealFields and look for `key` values. For more information
|
147
|
+
* Adds a new deal. 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 dealFields and look for `key` values. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/creating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">adding a deal</a>.
|
148
148
|
* @param {Object} opts Optional parameters
|
149
149
|
* @param {module:model/NewDeal} opts.newDeal
|
150
150
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetAddedDeal}
|
@@ -716,7 +716,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
716
716
|
}
|
717
717
|
/**
|
718
718
|
* Get details of a deal
|
719
|
-
* Returns the details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of dealFields. For more information
|
719
|
+
* Returns the details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of dealFields. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-details-of-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">getting details of a deal</a>.
|
720
720
|
* @param {Number} id The ID of the deal
|
721
721
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetDeal} and HTTP response
|
722
722
|
*/
|
@@ -759,7 +759,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
759
759
|
}
|
760
760
|
/**
|
761
761
|
* Get details of a deal
|
762
|
-
* Returns the details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of dealFields. For more information
|
762
|
+
* Returns the details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of dealFields. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-details-of-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">getting details of a deal</a>.
|
763
763
|
* @param {Number} id The ID of the deal
|
764
764
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetDeal}
|
765
765
|
*/
|
@@ -851,7 +851,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
851
851
|
* @param {Number} opts.start Pagination start (default to 0)
|
852
852
|
* @param {Number} opts.limit Items shown per page
|
853
853
|
* @param {module:model/NumberBoolean} opts.includeDeletedFiles When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.
|
854
|
-
* @param {String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id
|
854
|
+
* @param {String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `product_id`, `add_time`, `update_time`, `file_name`, `file_type`, `file_size`, `comment`.
|
855
855
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListFilesResponse} and HTTP response
|
856
856
|
*/
|
857
857
|
|
@@ -904,7 +904,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
904
904
|
* @param {Number} opts.start Pagination start (default to 0)
|
905
905
|
* @param {Number} opts.limit Items shown per page
|
906
906
|
* @param {module:model/NumberBoolean} opts.includeDeletedFiles When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.
|
907
|
-
* @param {String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id
|
907
|
+
* @param {String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `product_id`, `add_time`, `update_time`, `file_name`, `file_type`, `file_size`, `comment`.
|
908
908
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListFilesResponse}
|
909
909
|
*/
|
910
910
|
|
@@ -1370,7 +1370,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1370
1370
|
}
|
1371
1371
|
/**
|
1372
1372
|
* Get all deals
|
1373
|
-
* Returns all deals. For more information
|
1373
|
+
* Returns all deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
|
1374
1374
|
* @param {Object} opts Optional parameters
|
1375
1375
|
* @param {Number} opts.userId If supplied, only deals matching the given user will be returned. However, `filter_id` and `owned_by_you` takes precedence over `user_id` when supplied.
|
1376
1376
|
* @param {Number} opts.filterId The ID of the filter to use
|
@@ -1423,7 +1423,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1423
1423
|
}
|
1424
1424
|
/**
|
1425
1425
|
* Get all deals
|
1426
|
-
* Returns all deals. For more information
|
1426
|
+
* Returns all deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
|
1427
1427
|
* @param {Object} opts Optional parameters
|
1428
1428
|
* @param {Number} opts.userId If supplied, only deals matching the given user will be returned. However, `filter_id` and `owned_by_you` takes precedence over `user_id` when supplied.
|
1429
1429
|
* @param {Number} opts.filterId The ID of the filter to use
|
@@ -1606,7 +1606,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1606
1606
|
}
|
1607
1607
|
/**
|
1608
1608
|
* Merge two deals
|
1609
|
-
* Merges a deal with another deal. For more information
|
1609
|
+
* Merges a deal with another deal. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/merging-two-deals\" target=\"_blank\" rel=\"noopener noreferrer\">merging two deals</a>.
|
1610
1610
|
* @param {Number} id The ID of the deal
|
1611
1611
|
* @param {Object} opts Optional parameters
|
1612
1612
|
* @param {module:model/MergeDealsRequest} opts.mergeDealsRequest
|
@@ -1655,7 +1655,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1655
1655
|
}
|
1656
1656
|
/**
|
1657
1657
|
* Merge two deals
|
1658
|
-
* Merges a deal with another deal. For more information
|
1658
|
+
* Merges a deal with another deal. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/merging-two-deals\" target=\"_blank\" rel=\"noopener noreferrer\">merging two deals</a>.
|
1659
1659
|
* @param {Number} id The ID of the deal
|
1660
1660
|
* @param {Object} opts Optional parameters
|
1661
1661
|
* @param {module:model/MergeDealsRequest} opts.mergeDealsRequest
|
@@ -1754,7 +1754,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1754
1754
|
}
|
1755
1755
|
/**
|
1756
1756
|
* Update a deal
|
1757
|
-
* Updates the properties of a deal. For more information
|
1757
|
+
* Updates the properties of a deal. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/updating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">updating a deal</a>.
|
1758
1758
|
* @param {Number} id The ID of the deal
|
1759
1759
|
* @param {Object} opts Optional parameters
|
1760
1760
|
* @param {module:model/UpdateDealRequest} opts.updateDealRequest
|
@@ -1799,7 +1799,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1799
1799
|
}
|
1800
1800
|
/**
|
1801
1801
|
* Update a deal
|
1802
|
-
* Updates the properties of a deal. For more information
|
1802
|
+
* Updates the properties of a deal. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/updating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">updating a deal</a>.
|
1803
1803
|
* @param {Number} id The ID of the deal
|
1804
1804
|
* @param {Object} opts Optional parameters
|
1805
1805
|
* @param {module:model/UpdateDealRequest} opts.updateDealRequest
|
package/dist/api/FilesApi.js
CHANGED
@@ -54,7 +54,7 @@ var FilesApi = /*#__PURE__*/function () {
|
|
54
54
|
}
|
55
55
|
/**
|
56
56
|
* Add file
|
57
|
-
* Lets you upload a file and associate it with deal, person, organization, activity or product. For more information
|
57
|
+
* Lets you upload a file and associate it with a deal, person, organization, activity or product. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-file\" target=\"_blank\" rel=\"noopener noreferrer\">adding a file</a>.
|
58
58
|
* @param {File} file A single file, supplied in the multipart/form-data encoding and contained within the given boundaries
|
59
59
|
* @param {Object} opts Optional parameters
|
60
60
|
* @param {Number} opts.dealId The ID of the deal to associate file(s) with
|
@@ -109,7 +109,7 @@ var FilesApi = /*#__PURE__*/function () {
|
|
109
109
|
}
|
110
110
|
/**
|
111
111
|
* Add file
|
112
|
-
* Lets you upload a file and associate it with deal, person, organization, activity or product. For more information
|
112
|
+
* Lets you upload a file and associate it with a deal, person, organization, activity or product. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-file\" target=\"_blank\" rel=\"noopener noreferrer\">adding a file</a>.
|
113
113
|
* @param {File} file A single file, supplied in the multipart/form-data encoding and contained within the given boundaries
|
114
114
|
* @param {Object} opts Optional parameters
|
115
115
|
* @param {Number} opts.dealId The ID of the deal to associate file(s) with
|
@@ -129,7 +129,7 @@ var FilesApi = /*#__PURE__*/function () {
|
|
129
129
|
}
|
130
130
|
/**
|
131
131
|
* Create a remote file and link it to an item
|
132
|
-
* Creates a new empty file in the remote location (`googledrive`) that will be linked to the item you supply. For more information
|
132
|
+
* Creates a new empty file in the remote location (`googledrive`) that will be linked to the item you supply. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-remote-file\" target=\"_blank\" rel=\"noopener noreferrer\">adding a remote file</a>.
|
133
133
|
* @param {module:model/String} fileType The file type
|
134
134
|
* @param {String} title The title of the file
|
135
135
|
* @param {module:model/String} itemType The item type
|
@@ -200,7 +200,7 @@ var FilesApi = /*#__PURE__*/function () {
|
|
200
200
|
}
|
201
201
|
/**
|
202
202
|
* Create a remote file and link it to an item
|
203
|
-
* Creates a new empty file in the remote location (`googledrive`) that will be linked to the item you supply. For more information
|
203
|
+
* Creates a new empty file in the remote location (`googledrive`) that will be linked to the item you supply. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-remote-file\" target=\"_blank\" rel=\"noopener noreferrer\">adding a remote file</a>.
|
204
204
|
* @param {module:model/String} fileType The file type
|
205
205
|
* @param {String} title The title of the file
|
206
206
|
* @param {module:model/String} itemType The item type
|
@@ -394,7 +394,7 @@ var FilesApi = /*#__PURE__*/function () {
|
|
394
394
|
* @param {Number} opts.start Pagination start (default to 0)
|
395
395
|
* @param {Number} opts.limit Items shown per page
|
396
396
|
* @param {module:model/NumberBoolean} opts.includeDeletedFiles When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.
|
397
|
-
* @param {String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id
|
397
|
+
* @param {String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `product_id`, `add_time`, `update_time`, `file_name`, `file_type`, `file_size`, `comment`.
|
398
398
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetAllFiles} and HTTP response
|
399
399
|
*/
|
400
400
|
|
@@ -439,7 +439,7 @@ var FilesApi = /*#__PURE__*/function () {
|
|
439
439
|
* @param {Number} opts.start Pagination start (default to 0)
|
440
440
|
* @param {Number} opts.limit Items shown per page
|
441
441
|
* @param {module:model/NumberBoolean} opts.includeDeletedFiles When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.
|
442
|
-
* @param {String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id
|
442
|
+
* @param {String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `product_id`, `add_time`, `update_time`, `file_name`, `file_type`, `file_size`, `comment`.
|
443
443
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetAllFiles}
|
444
444
|
*/
|
445
445
|
|
@@ -452,7 +452,7 @@ var FilesApi = /*#__PURE__*/function () {
|
|
452
452
|
}
|
453
453
|
/**
|
454
454
|
* Link a remote file to an item
|
455
|
-
* Links an existing remote file (`googledrive`) to the item you supply. For more information
|
455
|
+
* Links an existing remote file (`googledrive`) to the item you supply. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-remote-file\" target=\"_blank\" rel=\"noopener noreferrer\">adding a remote file</a>.
|
456
456
|
* @param {module:model/String} itemType The item type
|
457
457
|
* @param {Number} itemId The ID of the item to associate the file with
|
458
458
|
* @param {String} remoteId The remote item ID
|
@@ -516,7 +516,7 @@ var FilesApi = /*#__PURE__*/function () {
|
|
516
516
|
}
|
517
517
|
/**
|
518
518
|
* Link a remote file to an item
|
519
|
-
* Links an existing remote file (`googledrive`) to the item you supply. For more information
|
519
|
+
* Links an existing remote file (`googledrive`) to the item you supply. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-remote-file\" target=\"_blank\" rel=\"noopener noreferrer\">adding a remote file</a>.
|
520
520
|
* @param {module:model/String} itemType The item type
|
521
521
|
* @param {Number} itemId The ID of the item to associate the file with
|
522
522
|
* @param {String} remoteId The remote item ID
|
package/dist/api/FiltersApi.js
CHANGED
@@ -54,7 +54,7 @@ var FiltersApi = /*#__PURE__*/function () {
|
|
54
54
|
}
|
55
55
|
/**
|
56
56
|
* Add a new filter
|
57
|
-
* Adds a new filter, returns the ID upon success. Note that in the conditions JSON object only one first-level condition group is supported, and it must be glued with 'AND', and only two second level condition groups are supported of which one must be glued with 'AND' and the second with 'OR'. Other combinations do not work (yet) but the syntax supports introducing them in future. For more information
|
57
|
+
* Adds a new filter, returns the ID upon success. Note that in the conditions JSON object only one first-level condition group is supported, and it must be glued with 'AND', and only two second level condition groups are supported of which one must be glued with 'AND' and the second with 'OR'. Other combinations do not work (yet) but the syntax supports introducing them in future. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
|
58
58
|
* @param {Object} opts Optional parameters
|
59
59
|
* @param {module:model/AddFilterRequest} opts.addFilterRequest
|
60
60
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/FiltersPostResponse} and HTTP response
|
@@ -105,7 +105,7 @@ var FiltersApi = /*#__PURE__*/function () {
|
|
105
105
|
}
|
106
106
|
/**
|
107
107
|
* Add a new filter
|
108
|
-
* Adds a new filter, returns the ID upon success. Note that in the conditions JSON object only one first-level condition group is supported, and it must be glued with 'AND', and only two second level condition groups are supported of which one must be glued with 'AND' and the second with 'OR'. Other combinations do not work (yet) but the syntax supports introducing them in future. For more information
|
108
|
+
* Adds a new filter, returns the ID upon success. Note that in the conditions JSON object only one first-level condition group is supported, and it must be glued with 'AND', and only two second level condition groups are supported of which one must be glued with 'AND' and the second with 'OR'. Other combinations do not work (yet) but the syntax supports introducing them in future. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
|
109
109
|
* @param {Object} opts Optional parameters
|
110
110
|
* @param {module:model/AddFilterRequest} opts.addFilterRequest
|
111
111
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/FiltersPostResponse}
|
@@ -291,7 +291,7 @@ var FiltersApi = /*#__PURE__*/function () {
|
|
291
291
|
}
|
292
292
|
/**
|
293
293
|
* Get all filter helpers
|
294
|
-
* Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to <a href=\"/docs/api/v1/Filters#addFilter\">add</a> or <a href=\"/docs/api/v1/Filters#updateFilter\">update</a> filters. For more information
|
294
|
+
* Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to <a href=\"/docs/api/v1/Filters#addFilter\">add</a> or <a href=\"/docs/api/v1/Filters#updateFilter\">update</a> filters. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
|
295
295
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
|
296
296
|
*/
|
297
297
|
|
@@ -326,7 +326,7 @@ var FiltersApi = /*#__PURE__*/function () {
|
|
326
326
|
}
|
327
327
|
/**
|
328
328
|
* Get all filter helpers
|
329
|
-
* Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to <a href=\"/docs/api/v1/Filters#addFilter\">add</a> or <a href=\"/docs/api/v1/Filters#updateFilter\">update</a> filters. For more information
|
329
|
+
* Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to <a href=\"/docs/api/v1/Filters#addFilter\">add</a> or <a href=\"/docs/api/v1/Filters#updateFilter\">update</a> filters. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
|
330
330
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
|
331
331
|
*/
|
332
332
|
|
@@ -40,7 +40,7 @@ var LeadSourcesApi = /*#__PURE__*/function () {
|
|
40
40
|
}
|
41
41
|
/**
|
42
42
|
* Get all lead sources
|
43
|
-
* Returns all lead sources. Please note that the list of lead sources is fixed, it cannot be modified. All leads created through the
|
43
|
+
* Returns all lead sources. Please note that the list of lead sources is fixed, it cannot be modified. All leads created through the Pipedrive API will have a lead source `API` assigned.
|
44
44
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetLeadSourcesResponse200} and HTTP response
|
45
45
|
*/
|
46
46
|
|
@@ -76,7 +76,7 @@ var LeadSourcesApi = /*#__PURE__*/function () {
|
|
76
76
|
}
|
77
77
|
/**
|
78
78
|
* Get all lead sources
|
79
|
-
* Returns all lead sources. Please note that the list of lead sources is fixed, it cannot be modified. All leads created through the
|
79
|
+
* Returns all lead sources. Please note that the list of lead sources is fixed, it cannot be modified. All leads created through the Pipedrive API will have a lead source `API` assigned.
|
80
80
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetLeadSourcesResponse200}
|
81
81
|
*/
|
82
82
|
|
package/dist/api/LeadsApi.js
CHANGED
@@ -282,7 +282,7 @@ var LeadsApi = /*#__PURE__*/function () {
|
|
282
282
|
}
|
283
283
|
/**
|
284
284
|
* Update a lead
|
285
|
-
* Updates one or more properties of a lead. Only properties included in the request will be updated. Send `null` to unset a property (applicable for example for `value`, `person_id` or `organization_id`). If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals. See an example
|
285
|
+
* Updates one or more properties of a lead. Only properties included in the request will be updated. Send `null` to unset a property (applicable for example for `value`, `person_id` or `organization_id`). If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals. See an example given in the <a href=\"https://pipedrive.readme.io/docs/updating-custom-field-value\" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields’ values tutorial</a>.
|
286
286
|
* @param {String} id The ID of the lead
|
287
287
|
* @param {Object} opts Optional parameters
|
288
288
|
* @param {module:model/UpdateLeadRequest} opts.updateLeadRequest
|
@@ -327,7 +327,7 @@ var LeadsApi = /*#__PURE__*/function () {
|
|
327
327
|
}
|
328
328
|
/**
|
329
329
|
* Update a lead
|
330
|
-
* Updates one or more properties of a lead. Only properties included in the request will be updated. Send `null` to unset a property (applicable for example for `value`, `person_id` or `organization_id`). If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals. See an example
|
330
|
+
* Updates one or more properties of a lead. Only properties included in the request will be updated. Send `null` to unset a property (applicable for example for `value`, `person_id` or `organization_id`). If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals. See an example given in the <a href=\"https://pipedrive.readme.io/docs/updating-custom-field-value\" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields’ values tutorial</a>.
|
331
331
|
* @param {String} id The ID of the lead
|
332
332
|
* @param {Object} opts Optional parameters
|
333
333
|
* @param {module:model/UpdateLeadRequest} opts.updateLeadRequest
|
package/dist/api/MailboxApi.js
CHANGED
@@ -232,7 +232,7 @@ var MailboxApi = /*#__PURE__*/function () {
|
|
232
232
|
}
|
233
233
|
/**
|
234
234
|
* Get all mail messages of mail thread
|
235
|
-
*
|
235
|
+
* Returns all the mail messages inside a specified mail thread.
|
236
236
|
* @param {Number} id The ID of the mail thread
|
237
237
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/MailThreadMessages} and HTTP response
|
238
238
|
*/
|
@@ -275,7 +275,7 @@ var MailboxApi = /*#__PURE__*/function () {
|
|
275
275
|
}
|
276
276
|
/**
|
277
277
|
* Get all mail messages of mail thread
|
278
|
-
*
|
278
|
+
* Returns all the mail messages inside a specified mail thread.
|
279
279
|
* @param {Number} id The ID of the mail thread
|
280
280
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/MailThreadMessages}
|
281
281
|
*/
|
@@ -50,7 +50,7 @@ var OrganizationFieldsApi = /*#__PURE__*/function () {
|
|
50
50
|
}
|
51
51
|
/**
|
52
52
|
* Add a new organization field
|
53
|
-
* Adds a new organization field. For more information
|
53
|
+
* Adds a new organization field. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-new-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">adding a new custom field</a>.
|
54
54
|
* @param {Object} opts Optional parameters
|
55
55
|
* @param {module:model/FieldCreateRequest} opts.fieldCreateRequest
|
56
56
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/FieldResponse} and HTTP response
|
@@ -88,7 +88,7 @@ var OrganizationFieldsApi = /*#__PURE__*/function () {
|
|
88
88
|
}
|
89
89
|
/**
|
90
90
|
* Add a new organization field
|
91
|
-
* Adds a new organization field. For more information
|
91
|
+
* Adds a new organization field. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-new-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">adding a new custom field</a>.
|
92
92
|
* @param {Object} opts Optional parameters
|
93
93
|
* @param {module:model/FieldCreateRequest} opts.fieldCreateRequest
|
94
94
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/FieldResponse}
|
@@ -103,7 +103,7 @@ var OrganizationFieldsApi = /*#__PURE__*/function () {
|
|
103
103
|
}
|
104
104
|
/**
|
105
105
|
* Delete an organization field
|
106
|
-
* Marks a field as deleted. For more information
|
106
|
+
* Marks a field as deleted. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/deleting-a-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">deleting a custom field</a>.
|
107
107
|
* @param {Number} id The ID of the field
|
108
108
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteResponse} and HTTP response
|
109
109
|
*/
|
@@ -146,7 +146,7 @@ var OrganizationFieldsApi = /*#__PURE__*/function () {
|
|
146
146
|
}
|
147
147
|
/**
|
148
148
|
* Delete an organization field
|
149
|
-
* Marks a field as deleted. For more information
|
149
|
+
* Marks a field as deleted. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/deleting-a-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">deleting a custom field</a>.
|
150
150
|
* @param {Number} id The ID of the field
|
151
151
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteResponse}
|
152
152
|
*/
|
@@ -331,7 +331,7 @@ var OrganizationFieldsApi = /*#__PURE__*/function () {
|
|
331
331
|
}
|
332
332
|
/**
|
333
333
|
* Update an organization field
|
334
|
-
* Updates an organization field.
|
334
|
+
* Updates an organization field. For more information, see the tutorial for <a href=\" https://pipedrive.readme.io/docs/updating-custom-field-value \" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields' values</a>.
|
335
335
|
* @param {Number} id The ID of the field
|
336
336
|
* @param {Object} opts Optional parameters
|
337
337
|
* @param {module:model/FieldUpdateRequest} opts.fieldUpdateRequest
|
@@ -376,7 +376,7 @@ var OrganizationFieldsApi = /*#__PURE__*/function () {
|
|
376
376
|
}
|
377
377
|
/**
|
378
378
|
* Update an organization field
|
379
|
-
* Updates an organization field.
|
379
|
+
* Updates an organization field. For more information, see the tutorial for <a href=\" https://pipedrive.readme.io/docs/updating-custom-field-value \" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields' values</a>.
|
380
380
|
* @param {Number} id The ID of the field
|
381
381
|
* @param {Object} opts Optional parameters
|
382
382
|
* @param {module:model/FieldUpdateRequest} opts.fieldUpdateRequest
|
@@ -84,7 +84,7 @@ var OrganizationsApi = /*#__PURE__*/function () {
|
|
84
84
|
}
|
85
85
|
/**
|
86
86
|
* Add an organization
|
87
|
-
* Adds a new organization. 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 organizationFields and look for `key` values. For more information
|
87
|
+
* Adds a new organization. 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 organizationFields and look for `key` values. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-an-organization\" target=\"_blank\" rel=\"noopener noreferrer\">adding an organization</a>.
|
88
88
|
* @param {Object} opts Optional parameters
|
89
89
|
* @param {module:model/NewOrganization} opts.newOrganization
|
90
90
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OrganizationPostResponse} and HTTP response
|
@@ -122,7 +122,7 @@ var OrganizationsApi = /*#__PURE__*/function () {
|
|
122
122
|
}
|
123
123
|
/**
|
124
124
|
* Add an organization
|
125
|
-
* Adds a new organization. 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 organizationFields and look for `key` values. For more information
|
125
|
+
* Adds a new organization. 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 organizationFields and look for `key` values. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-an-organization\" target=\"_blank\" rel=\"noopener noreferrer\">adding an organization</a>.
|
126
126
|
* @param {Object} opts Optional parameters
|
127
127
|
* @param {module:model/NewOrganization} opts.newOrganization
|
128
128
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OrganizationPostResponse}
|
@@ -591,7 +591,7 @@ var OrganizationsApi = /*#__PURE__*/function () {
|
|
591
591
|
* @param {Number} opts.start Pagination start (default to 0)
|
592
592
|
* @param {Number} opts.limit Items shown per page
|
593
593
|
* @param {module:model/NumberBoolean} opts.includeDeletedFiles When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.
|
594
|
-
* @param {String} opts.sort The field names and sorting mode separated by a comma (field_name_1 ASC
|
594
|
+
* @param {String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `product_id`, `add_time`, `update_time`, `file_name`, `file_type`, `file_size`, `comment`.
|
595
595
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListFilesResponse} and HTTP response
|
596
596
|
*/
|
597
597
|
|
@@ -644,7 +644,7 @@ var OrganizationsApi = /*#__PURE__*/function () {
|
|
644
644
|
* @param {Number} opts.start Pagination start (default to 0)
|
645
645
|
* @param {Number} opts.limit Items shown per page
|
646
646
|
* @param {module:model/NumberBoolean} opts.includeDeletedFiles When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.
|
647
|
-
* @param {String} opts.sort The field names and sorting mode separated by a comma (field_name_1 ASC
|
647
|
+
* @param {String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `product_id`, `add_time`, `update_time`, `file_name`, `file_type`, `file_size`, `comment`.
|
648
648
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListFilesResponse}
|
649
649
|
*/
|
650
650
|
|
@@ -1044,7 +1044,7 @@ var OrganizationsApi = /*#__PURE__*/function () {
|
|
1044
1044
|
}
|
1045
1045
|
/**
|
1046
1046
|
* Merge two organizations
|
1047
|
-
* Merges an organization with another organization. For more information
|
1047
|
+
* Merges an organization with another organization. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/merging-two-organizations\" target=\"_blank\" rel=\"noopener noreferrer\">merging two organizations</a>.
|
1048
1048
|
* @param {Number} id The ID of the organization
|
1049
1049
|
* @param {Object} opts Optional parameters
|
1050
1050
|
* @param {module:model/MergeOrganizationsRequest} opts.mergeOrganizationsRequest
|
@@ -1093,7 +1093,7 @@ var OrganizationsApi = /*#__PURE__*/function () {
|
|
1093
1093
|
}
|
1094
1094
|
/**
|
1095
1095
|
* Merge two organizations
|
1096
|
-
* Merges an organization with another organization. For more information
|
1096
|
+
* Merges an organization with another organization. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/merging-two-organizations\" target=\"_blank\" rel=\"noopener noreferrer\">merging two organizations</a>.
|
1097
1097
|
* @param {Number} id The ID of the organization
|
1098
1098
|
* @param {Object} opts Optional parameters
|
1099
1099
|
* @param {module:model/MergeOrganizationsRequest} opts.mergeOrganizationsRequest
|
@@ -50,7 +50,7 @@ var PersonFieldsApi = /*#__PURE__*/function () {
|
|
50
50
|
}
|
51
51
|
/**
|
52
52
|
* Add a new person field
|
53
|
-
* Adds a new person field. For more information
|
53
|
+
* Adds a new person field. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-new-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">adding a new custom field</a>.
|
54
54
|
* @param {Object} opts Optional parameters
|
55
55
|
* @param {module:model/FieldCreateRequest} opts.fieldCreateRequest
|
56
56
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/FieldResponse} and HTTP response
|
@@ -88,7 +88,7 @@ var PersonFieldsApi = /*#__PURE__*/function () {
|
|
88
88
|
}
|
89
89
|
/**
|
90
90
|
* Add a new person field
|
91
|
-
* Adds a new person field. For more information
|
91
|
+
* Adds a new person field. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-new-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">adding a new custom field</a>.
|
92
92
|
* @param {Object} opts Optional parameters
|
93
93
|
* @param {module:model/FieldCreateRequest} opts.fieldCreateRequest
|
94
94
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/FieldResponse}
|
@@ -103,7 +103,7 @@ var PersonFieldsApi = /*#__PURE__*/function () {
|
|
103
103
|
}
|
104
104
|
/**
|
105
105
|
* Delete a person field
|
106
|
-
* Marks a field as deleted. For more information
|
106
|
+
* Marks a field as deleted. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/deleting-a-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">deleting a custom field</a>.
|
107
107
|
* @param {Number} id The ID of the field
|
108
108
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteResponse} and HTTP response
|
109
109
|
*/
|
@@ -146,7 +146,7 @@ var PersonFieldsApi = /*#__PURE__*/function () {
|
|
146
146
|
}
|
147
147
|
/**
|
148
148
|
* Delete a person field
|
149
|
-
* Marks a field as deleted. For more information
|
149
|
+
* Marks a field as deleted. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/deleting-a-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">deleting a custom field</a>.
|
150
150
|
* @param {Number} id The ID of the field
|
151
151
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteResponse}
|
152
152
|
*/
|
@@ -331,7 +331,7 @@ var PersonFieldsApi = /*#__PURE__*/function () {
|
|
331
331
|
}
|
332
332
|
/**
|
333
333
|
* Update a person field
|
334
|
-
* Updates a person field.
|
334
|
+
* Updates a person field. For more information, see the tutorial for <a href=\" https://pipedrive.readme.io/docs/updating-custom-field-value \" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields' values</a>.
|
335
335
|
* @param {Number} id The ID of the field
|
336
336
|
* @param {Object} opts Optional parameters
|
337
337
|
* @param {module:model/FieldUpdateRequest} opts.fieldUpdateRequest
|
@@ -376,7 +376,7 @@ var PersonFieldsApi = /*#__PURE__*/function () {
|
|
376
376
|
}
|
377
377
|
/**
|
378
378
|
* Update a person field
|
379
|
-
* Updates a person field.
|
379
|
+
* Updates a person field. For more information, see the tutorial for <a href=\" https://pipedrive.readme.io/docs/updating-custom-field-value \" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields' values</a>.
|
380
380
|
* @param {Number} id The ID of the field
|
381
381
|
* @param {Object} opts Optional parameters
|
382
382
|
* @param {module:model/FieldUpdateRequest} opts.fieldUpdateRequest
|
package/dist/api/PersonsApi.js
CHANGED
@@ -722,7 +722,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
722
722
|
* @param {Number} opts.start Pagination start (default to 0)
|
723
723
|
* @param {Number} opts.limit Items shown per page
|
724
724
|
* @param {module:model/NumberBoolean} opts.includeDeletedFiles When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.
|
725
|
-
* @param {String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id
|
725
|
+
* @param {String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `product_id`, `add_time`, `update_time`, `file_name`, `file_type`, `file_size`, `comment`.
|
726
726
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListFilesResponse} and HTTP response
|
727
727
|
*/
|
728
728
|
|
@@ -775,7 +775,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
775
775
|
* @param {Number} opts.start Pagination start (default to 0)
|
776
776
|
* @param {Number} opts.limit Items shown per page
|
777
777
|
* @param {module:model/NumberBoolean} opts.includeDeletedFiles When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.
|
778
|
-
* @param {String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id
|
778
|
+
* @param {String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `product_id`, `add_time`, `update_time`, `file_name`, `file_type`, `file_size`, `comment`.
|
779
779
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListFilesResponse}
|
780
780
|
*/
|
781
781
|
|
@@ -1175,7 +1175,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1175
1175
|
}
|
1176
1176
|
/**
|
1177
1177
|
* Merge two persons
|
1178
|
-
* Merges a person with another person. For more information
|
1178
|
+
* Merges a person with another person. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/merging-two-persons\" target=\"_blank\" rel=\"noopener noreferrer\">merging two persons</a>.
|
1179
1179
|
* @param {Number} id The ID of the person
|
1180
1180
|
* @param {Object} opts Optional parameters
|
1181
1181
|
* @param {module:model/MergePersonsRequest} opts.mergePersonsRequest
|
@@ -1224,7 +1224,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1224
1224
|
}
|
1225
1225
|
/**
|
1226
1226
|
* Merge two persons
|
1227
|
-
* Merges a person with another person. For more information
|
1227
|
+
* Merges a person with another person. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/merging-two-persons\" target=\"_blank\" rel=\"noopener noreferrer\">merging two persons</a>.
|
1228
1228
|
* @param {Number} id The ID of the person
|
1229
1229
|
* @param {Object} opts Optional parameters
|
1230
1230
|
* @param {module:model/MergePersonsRequest} opts.mergePersonsRequest
|
@@ -1317,7 +1317,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1317
1317
|
}
|
1318
1318
|
/**
|
1319
1319
|
* Update a person
|
1320
|
-
* Updates the properties of a person. For more information
|
1320
|
+
* Updates the properties of a person. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/updating-a-person\" target=\"_blank\" rel=\"noopener noreferrer\">updating a person</a>.<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.
|
1321
1321
|
* @param {Number} id The ID of the person
|
1322
1322
|
* @param {Object} opts Optional parameters
|
1323
1323
|
* @param {module:model/BasicPerson} opts.basicPerson
|
@@ -1362,7 +1362,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1362
1362
|
}
|
1363
1363
|
/**
|
1364
1364
|
* Update a person
|
1365
|
-
* Updates the properties of a person. For more information
|
1365
|
+
* Updates the properties of a person. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/updating-a-person\" target=\"_blank\" rel=\"noopener noreferrer\">updating a person</a>.<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.
|
1366
1366
|
* @param {Number} id The ID of the person
|
1367
1367
|
* @param {Object} opts Optional parameters
|
1368
1368
|
* @param {module:model/BasicPerson} opts.basicPerson
|
@@ -52,7 +52,7 @@ var ProductFieldsApi = /*#__PURE__*/function () {
|
|
52
52
|
}
|
53
53
|
/**
|
54
54
|
* Add a new product field
|
55
|
-
* Adds a new product field. For more information
|
55
|
+
* Adds a new product field. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-new-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">adding a new custom field</a>.
|
56
56
|
* @param {Object} opts Optional parameters
|
57
57
|
* @param {module:model/NewProductField} opts.newProductField
|
58
58
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetProductFieldResponse} and HTTP response
|
@@ -99,7 +99,7 @@ var ProductFieldsApi = /*#__PURE__*/function () {
|
|
99
99
|
}
|
100
100
|
/**
|
101
101
|
* Add a new product field
|
102
|
-
* Adds a new product field. For more information
|
102
|
+
* Adds a new product field. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-new-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">adding a new custom field</a>.
|
103
103
|
* @param {Object} opts Optional parameters
|
104
104
|
* @param {module:model/NewProductField} opts.newProductField
|
105
105
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetProductFieldResponse}
|
@@ -114,7 +114,7 @@ var ProductFieldsApi = /*#__PURE__*/function () {
|
|
114
114
|
}
|
115
115
|
/**
|
116
116
|
* Delete a product field
|
117
|
-
* Marks a field as deleted. For more information
|
117
|
+
* Marks a product field as deleted. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/deleting-a-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">deleting a custom field</a>.
|
118
118
|
* @param {Number} id The ID of the product field
|
119
119
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteProductFieldResponse} and HTTP response
|
120
120
|
*/
|
@@ -157,7 +157,7 @@ var ProductFieldsApi = /*#__PURE__*/function () {
|
|
157
157
|
}
|
158
158
|
/**
|
159
159
|
* Delete a product field
|
160
|
-
* Marks a field as deleted. For more information
|
160
|
+
* Marks a product field as deleted. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/deleting-a-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">deleting a custom field</a>.
|
161
161
|
* @param {Number} id The ID of the product field
|
162
162
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteProductFieldResponse}
|
163
163
|
*/
|
@@ -342,7 +342,7 @@ var ProductFieldsApi = /*#__PURE__*/function () {
|
|
342
342
|
}
|
343
343
|
/**
|
344
344
|
* Update a product field
|
345
|
-
* Updates a product field.
|
345
|
+
* Updates a product field. For more information, see the tutorial for <a href=\" https://pipedrive.readme.io/docs/updating-custom-field-value \" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields' values</a>.
|
346
346
|
* @param {Number} id The ID of the product field
|
347
347
|
* @param {Object} opts Optional parameters
|
348
348
|
* @param {module:model/BasicProductField} opts.basicProductField
|
@@ -391,7 +391,7 @@ var ProductFieldsApi = /*#__PURE__*/function () {
|
|
391
391
|
}
|
392
392
|
/**
|
393
393
|
* Update a product field
|
394
|
-
* Updates a product field.
|
394
|
+
* Updates a product field. For more information, see the tutorial for <a href=\" https://pipedrive.readme.io/docs/updating-custom-field-value \" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields' values</a>.
|
395
395
|
* @param {Number} id The ID of the product field
|
396
396
|
* @param {Object} opts Optional parameters
|
397
397
|
* @param {module:model/BasicProductField} opts.basicProductField
|
package/dist/api/ProductsApi.js
CHANGED
@@ -68,7 +68,7 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
68
68
|
}
|
69
69
|
/**
|
70
70
|
* Add a product
|
71
|
-
* Adds a new product to the Products inventory. For more information
|
71
|
+
* Adds a new product to the Products inventory. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-product\" target=\"_blank\" rel=\"noopener noreferrer\">adding a product</a>.
|
72
72
|
* @param {Object} opts Optional parameters
|
73
73
|
* @param {module:model/AddProductRequestBody} opts.addProductRequestBody
|
74
74
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ProductResponse} and HTTP response
|
@@ -106,7 +106,7 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
106
106
|
}
|
107
107
|
/**
|
108
108
|
* Add a product
|
109
|
-
* Adds a new product to the Products inventory. For more information
|
109
|
+
* Adds a new product to the Products inventory. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-product\" target=\"_blank\" rel=\"noopener noreferrer\">adding a product</a>.
|
110
110
|
* @param {Object} opts Optional parameters
|
111
111
|
* @param {module:model/AddProductRequestBody} opts.addProductRequestBody
|
112
112
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ProductResponse}
|
@@ -440,7 +440,7 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
440
440
|
* @param {Number} opts.start Pagination start (default to 0)
|
441
441
|
* @param {Number} opts.limit Items shown per page
|
442
442
|
* @param {module:model/NumberBoolean} opts.includeDeletedFiles When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.
|
443
|
-
* @param {String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id
|
443
|
+
* @param {String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `product_id`, `add_time`, `update_time`, `file_name`, `file_type`, `file_size`, `comment`.
|
444
444
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListFilesResponse} and HTTP response
|
445
445
|
*/
|
446
446
|
|
@@ -493,7 +493,7 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
493
493
|
* @param {Number} opts.start Pagination start (default to 0)
|
494
494
|
* @param {Number} opts.limit Items shown per page
|
495
495
|
* @param {module:model/NumberBoolean} opts.includeDeletedFiles When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.
|
496
|
-
* @param {String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id
|
496
|
+
* @param {String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `product_id`, `add_time`, `update_time`, `file_name`, `file_type`, `file_size`, `comment`.
|
497
497
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListFilesResponse}
|
498
498
|
*/
|
499
499
|
|
package/dist/api/WebhooksApi.js
CHANGED
@@ -52,7 +52,7 @@ var WebhooksApi = /*#__PURE__*/function () {
|
|
52
52
|
}
|
53
53
|
/**
|
54
54
|
* Create a new Webhook
|
55
|
-
* Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `added.deal` for any newly added deals, `deleted.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">
|
55
|
+
* Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `added.deal` for any newly added deals, `deleted.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
|
56
56
|
* @param {Object} opts Optional parameters
|
57
57
|
* @param {module:model/AddWebhookRequest} opts.addWebhookRequest
|
58
58
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Webhook} and HTTP response
|
@@ -103,7 +103,7 @@ var WebhooksApi = /*#__PURE__*/function () {
|
|
103
103
|
}
|
104
104
|
/**
|
105
105
|
* Create a new Webhook
|
106
|
-
* Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `added.deal` for any newly added deals, `deleted.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">
|
106
|
+
* Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `added.deal` for any newly added deals, `deleted.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
|
107
107
|
* @param {Object} opts Optional parameters
|
108
108
|
* @param {module:model/AddWebhookRequest} opts.addWebhookRequest
|
109
109
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Webhook}
|
@@ -80,7 +80,7 @@ var ActivityTypeBulkDeleteResponseAllOfData = /*#__PURE__*/function () {
|
|
80
80
|
return ActivityTypeBulkDeleteResponseAllOfData;
|
81
81
|
}();
|
82
82
|
/**
|
83
|
-
* The IDs of the deleted
|
83
|
+
* The IDs of the deleted activity types
|
84
84
|
* @member {Array.<Number>} id
|
85
85
|
*/
|
86
86
|
|
@@ -109,7 +109,7 @@ var ActivityTypeListResponse = /*#__PURE__*/function () {
|
|
109
109
|
|
110
110
|
ActivityTypeListResponse.prototype['success'] = undefined;
|
111
111
|
/**
|
112
|
-
* The array of
|
112
|
+
* The array of activity types
|
113
113
|
* @member {Array.<module:model/ActivityTypeObjectResponse>} data
|
114
114
|
*/
|
115
115
|
|
@@ -123,7 +123,7 @@ ActivityTypeListResponse.prototype['data'] = undefined; // Implement BaseRespons
|
|
123
123
|
_BaseResponse["default"].prototype['success'] = undefined; // Implement ActivityTypeListResponseAllOf interface:
|
124
124
|
|
125
125
|
/**
|
126
|
-
* The array of
|
126
|
+
* The array of activity types
|
127
127
|
* @member {Array.<module:model/ActivityTypeObjectResponse>} data
|
128
128
|
*/
|
129
129
|
|
@@ -82,7 +82,7 @@ var ActivityTypeListResponseAllOf = /*#__PURE__*/function () {
|
|
82
82
|
return ActivityTypeListResponseAllOf;
|
83
83
|
}();
|
84
84
|
/**
|
85
|
-
* The array of
|
85
|
+
* The array of activity types
|
86
86
|
* @member {Array.<module:model/ActivityTypeObjectResponse>} data
|
87
87
|
*/
|
88
88
|
|
@@ -127,14 +127,14 @@ var ActivityTypeObjectResponse = /*#__PURE__*/function () {
|
|
127
127
|
return ActivityTypeObjectResponse;
|
128
128
|
}();
|
129
129
|
/**
|
130
|
-
* The ID of the
|
130
|
+
* The ID of the activity type
|
131
131
|
* @member {Number} id
|
132
132
|
*/
|
133
133
|
|
134
134
|
|
135
135
|
ActivityTypeObjectResponse.prototype['id'] = undefined;
|
136
136
|
/**
|
137
|
-
* The name of the
|
137
|
+
* The name of the activity type
|
138
138
|
* @member {String} name
|
139
139
|
*/
|
140
140
|
|
@@ -145,43 +145,43 @@ ActivityTypeObjectResponse.prototype['name'] = undefined;
|
|
145
145
|
|
146
146
|
ActivityTypeObjectResponse.prototype['icon_key'] = undefined;
|
147
147
|
/**
|
148
|
-
* A designated color for the
|
148
|
+
* A designated color for the activity type in 6-character HEX format (e.g. `FFFFFF` for white, `000000` for black)
|
149
149
|
* @member {String} color
|
150
150
|
*/
|
151
151
|
|
152
152
|
ActivityTypeObjectResponse.prototype['color'] = undefined;
|
153
153
|
/**
|
154
|
-
* An order number for
|
154
|
+
* An order number for the activity type. Order numbers should be used to order the types in the activity type selections.
|
155
155
|
* @member {Number} order_nr
|
156
156
|
*/
|
157
157
|
|
158
158
|
ActivityTypeObjectResponse.prototype['order_nr'] = undefined;
|
159
159
|
/**
|
160
|
-
* A string that is generated by the API based on the given name of the
|
160
|
+
* A string that is generated by the API based on the given name of the activity type upon creation
|
161
161
|
* @member {String} key_string
|
162
162
|
*/
|
163
163
|
|
164
164
|
ActivityTypeObjectResponse.prototype['key_string'] = undefined;
|
165
165
|
/**
|
166
|
-
* The active flag of the
|
166
|
+
* The active flag of the activity type
|
167
167
|
* @member {Boolean} active_flag
|
168
168
|
*/
|
169
169
|
|
170
170
|
ActivityTypeObjectResponse.prototype['active_flag'] = undefined;
|
171
171
|
/**
|
172
|
-
* Whether the
|
172
|
+
* Whether the activity type is a custom one or not
|
173
173
|
* @member {Boolean} is_custom_flag
|
174
174
|
*/
|
175
175
|
|
176
176
|
ActivityTypeObjectResponse.prototype['is_custom_flag'] = undefined;
|
177
177
|
/**
|
178
|
-
* The creation time of the
|
178
|
+
* The creation time of the activity type
|
179
179
|
* @member {String} add_time
|
180
180
|
*/
|
181
181
|
|
182
182
|
ActivityTypeObjectResponse.prototype['add_time'] = undefined;
|
183
183
|
/**
|
184
|
-
* The update time of the
|
184
|
+
* The update time of the activity type
|
185
185
|
* @member {String} update_time
|
186
186
|
*/
|
187
187
|
|