pipedrive 13.1.1 → 13.2.1
Sign up to get free protection for your applications and to get access to all the features.
- package/CHANGELOG.md +16 -0
- package/README.md +5 -5
- package/dist/ApiClient.js +13 -15
- 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/dist/model/BaseMailThread.js +1 -18
- package/dist/model/BaseMailThreadMessages.js +1 -18
- package/dist/model/CommonMailThread.js +0 -11
- package/dist/model/MailMessageData.js +0 -11
- package/dist/model/MailMessageItemForList.js +1 -18
- package/package.json +1 -1
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
|
|
@@ -153,11 +153,6 @@ var BaseMailThread = /*#__PURE__*/function () {
|
|
153
153
|
delete data['mail_link_tracking_enabled_flag'];
|
154
154
|
}
|
155
155
|
|
156
|
-
if (data.hasOwnProperty('write_flag')) {
|
157
|
-
obj['write_flag'] = _ApiClient["default"].convertToType(data['write_flag'], 'Boolean');
|
158
|
-
delete data['write_flag'];
|
159
|
-
}
|
160
|
-
|
161
156
|
if (data.hasOwnProperty('parties')) {
|
162
157
|
obj['parties'] = _BaseMailThreadAllOfParties["default"].constructFromObject(data['parties']);
|
163
158
|
delete data['parties'];
|
@@ -368,12 +363,6 @@ BaseMailThread.prototype['smart_bcc_flag'] = undefined;
|
|
368
363
|
*/
|
369
364
|
|
370
365
|
BaseMailThread.prototype['mail_link_tracking_enabled_flag'] = undefined;
|
371
|
-
/**
|
372
|
-
* We strongly advise you to avoid the use of this property. We will soon deprecate this property
|
373
|
-
* @member {Boolean} write_flag
|
374
|
-
*/
|
375
|
-
|
376
|
-
BaseMailThread.prototype['write_flag'] = undefined;
|
377
366
|
/**
|
378
367
|
* @member {module:model/BaseMailThreadAllOfParties} parties
|
379
368
|
*/
|
@@ -595,13 +584,7 @@ _CommonMailThread["default"].prototype['smart_bcc_flag'] = undefined;
|
|
595
584
|
* @member {module:model/NumberBooleanDefault0} mail_link_tracking_enabled_flag
|
596
585
|
*/
|
597
586
|
|
598
|
-
_CommonMailThread["default"].prototype['mail_link_tracking_enabled_flag'] = undefined;
|
599
|
-
/**
|
600
|
-
* We strongly advise you to avoid the use of this property. We will soon deprecate this property
|
601
|
-
* @member {Boolean} write_flag
|
602
|
-
*/
|
603
|
-
|
604
|
-
_CommonMailThread["default"].prototype['write_flag'] = undefined; // Implement BaseMailThreadAllOf interface:
|
587
|
+
_CommonMailThread["default"].prototype['mail_link_tracking_enabled_flag'] = undefined; // Implement BaseMailThreadAllOf interface:
|
605
588
|
|
606
589
|
/**
|
607
590
|
* @member {module:model/BaseMailThreadAllOfParties} parties
|
@@ -153,11 +153,6 @@ var BaseMailThreadMessages = /*#__PURE__*/function () {
|
|
153
153
|
delete data['mail_link_tracking_enabled_flag'];
|
154
154
|
}
|
155
155
|
|
156
|
-
if (data.hasOwnProperty('write_flag')) {
|
157
|
-
obj['write_flag'] = _ApiClient["default"].convertToType(data['write_flag'], 'Boolean');
|
158
|
-
delete data['write_flag'];
|
159
|
-
}
|
160
|
-
|
161
156
|
if (data.hasOwnProperty('from')) {
|
162
157
|
obj['from'] = _ApiClient["default"].convertToType(data['from'], [_MailThreadParticipant["default"]]);
|
163
158
|
delete data['from'];
|
@@ -318,12 +313,6 @@ BaseMailThreadMessages.prototype['smart_bcc_flag'] = undefined;
|
|
318
313
|
*/
|
319
314
|
|
320
315
|
BaseMailThreadMessages.prototype['mail_link_tracking_enabled_flag'] = undefined;
|
321
|
-
/**
|
322
|
-
* We strongly advise you to avoid the use of this property. We will soon deprecate this property
|
323
|
-
* @member {Boolean} write_flag
|
324
|
-
*/
|
325
|
-
|
326
|
-
BaseMailThreadMessages.prototype['write_flag'] = undefined;
|
327
316
|
/**
|
328
317
|
* Senders of the mail thread
|
329
318
|
* @member {Array.<module:model/MailThreadParticipant>} from
|
@@ -486,13 +475,7 @@ _CommonMailThread["default"].prototype['smart_bcc_flag'] = undefined;
|
|
486
475
|
* @member {module:model/NumberBooleanDefault0} mail_link_tracking_enabled_flag
|
487
476
|
*/
|
488
477
|
|
489
|
-
_CommonMailThread["default"].prototype['mail_link_tracking_enabled_flag'] = undefined;
|
490
|
-
/**
|
491
|
-
* We strongly advise you to avoid the use of this property. We will soon deprecate this property
|
492
|
-
* @member {Boolean} write_flag
|
493
|
-
*/
|
494
|
-
|
495
|
-
_CommonMailThread["default"].prototype['write_flag'] = undefined; // Implement BaseMailThreadMessagesAllOf interface:
|
478
|
+
_CommonMailThread["default"].prototype['mail_link_tracking_enabled_flag'] = undefined; // Implement BaseMailThreadMessagesAllOf interface:
|
496
479
|
|
497
480
|
/**
|
498
481
|
* Senders of the mail thread
|
@@ -136,11 +136,6 @@ var CommonMailThread = /*#__PURE__*/function () {
|
|
136
136
|
delete data['mail_link_tracking_enabled_flag'];
|
137
137
|
}
|
138
138
|
|
139
|
-
if (data.hasOwnProperty('write_flag')) {
|
140
|
-
obj['write_flag'] = _ApiClient["default"].convertToType(data['write_flag'], 'Boolean');
|
141
|
-
delete data['write_flag'];
|
142
|
-
}
|
143
|
-
|
144
139
|
if (Object.keys(data).length > 0) {
|
145
140
|
Object.assign(obj, data);
|
146
141
|
}
|
@@ -236,11 +231,5 @@ CommonMailThread.prototype['smart_bcc_flag'] = undefined;
|
|
236
231
|
*/
|
237
232
|
|
238
233
|
CommonMailThread.prototype['mail_link_tracking_enabled_flag'] = undefined;
|
239
|
-
/**
|
240
|
-
* We strongly advise you to avoid the use of this property. We will soon deprecate this property
|
241
|
-
* @member {Boolean} write_flag
|
242
|
-
*/
|
243
|
-
|
244
|
-
CommonMailThread.prototype['write_flag'] = undefined;
|
245
234
|
var _default = CommonMailThread;
|
246
235
|
exports["default"] = _default;
|