pipedrive 13.1.0 → 13.2.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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 on how to add a new filter, see <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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 on how to add a new filter, see <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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 on how filter’s helpers can be used, see <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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 on how filter’s helpers can be used, see <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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 Public Pipedrive API will have a lead source `API` assigned.
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 Public Pipedrive API will have a lead source `API` assigned.
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
 
@@ -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 of updating custom fields’ values in <a href=\"https://pipedrive.readme.io/docs/updating-custom-field-value\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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 of updating custom fields’ values in <a href=\"https://pipedrive.readme.io/docs/updating-custom-field-value\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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
@@ -232,7 +232,7 @@ var MailboxApi = /*#__PURE__*/function () {
232
232
  }
233
233
  /**
234
234
  * Get all mail messages of mail thread
235
- * Get all the mail messages inside a specified mail thread.
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
- * Get all the mail messages inside a specified mail thread.
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 on adding a new custom field, see <a href=\"https://pipedrive.readme.io/docs/adding-a-new-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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 on adding a new custom field, see <a href=\"https://pipedrive.readme.io/docs/adding-a-new-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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 on how to delete a custom field, see <a href=\"https://pipedrive.readme.io/docs/deleting-a-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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 on how to delete a custom field, see <a href=\"https://pipedrive.readme.io/docs/deleting-a-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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. See an example of updating custom fields’ values in <a href=\" https://pipedrive.readme.io/docs/updating-custom-field-value \" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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. See an example of updating custom fields’ values in <a href=\" https://pipedrive.readme.io/docs/updating-custom-field-value \" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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 on how to add an organization, see <a href=\"https://pipedrive.readme.io/docs/adding-an-organization\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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 on how to add an organization, see <a href=\"https://pipedrive.readme.io/docs/adding-an-organization\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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, 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.
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, 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.
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
 
@@ -780,7 +780,7 @@ var OrganizationsApi = /*#__PURE__*/function () {
780
780
  }
781
781
  /**
782
782
  * List persons of an organization
783
- * Lists persons associated with an organization.
783
+ * Lists persons associated with an organization.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
784
784
  * @param {Number} id The ID of the organization
785
785
  * @param {Object} opts Optional parameters
786
786
  * @param {Number} opts.start Pagination start (default to 0)
@@ -829,7 +829,7 @@ var OrganizationsApi = /*#__PURE__*/function () {
829
829
  }
830
830
  /**
831
831
  * List persons of an organization
832
- * Lists persons associated with an organization.
832
+ * Lists persons associated with an organization.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
833
833
  * @param {Number} id The ID of the organization
834
834
  * @param {Object} opts Optional parameters
835
835
  * @param {Number} opts.start Pagination start (default to 0)
@@ -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 on how to merge two organizations, see <a href=\"https://pipedrive.readme.io/docs/merging-two-organizations\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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 on how to merge two organizations, see <a href=\"https://pipedrive.readme.io/docs/merging-two-organizations\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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 on adding a new custom field, see <a href=\"https://pipedrive.readme.io/docs/adding-a-new-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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 on adding a new custom field, see <a href=\"https://pipedrive.readme.io/docs/adding-a-new-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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 on how to delete a custom field, see <a href=\"https://pipedrive.readme.io/docs/deleting-a-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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 on how to delete a custom field, see <a href=\"https://pipedrive.readme.io/docs/deleting-a-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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
  */
@@ -274,7 +274,7 @@ var PersonFieldsApi = /*#__PURE__*/function () {
274
274
  }
275
275
  /**
276
276
  * Get all person fields
277
- * Returns data about all person fields.
277
+ * Returns data about all person fields.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
278
278
  * @param {Object} opts Optional parameters
279
279
  * @param {Number} opts.start Pagination start (default to 0)
280
280
  * @param {Number} opts.limit Items shown per page
@@ -315,7 +315,7 @@ var PersonFieldsApi = /*#__PURE__*/function () {
315
315
  }
316
316
  /**
317
317
  * Get all person fields
318
- * Returns data about all person fields.
318
+ * Returns data about all person fields.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
319
319
  * @param {Object} opts Optional parameters
320
320
  * @param {Number} opts.start Pagination start (default to 0)
321
321
  * @param {Number} opts.limit Items shown per page
@@ -331,7 +331,7 @@ var PersonFieldsApi = /*#__PURE__*/function () {
331
331
  }
332
332
  /**
333
333
  * Update a person field
334
- * Updates a person field. See an example of updating custom fields’ values in <a href=\" https://pipedrive.readme.io/docs/updating-custom-field-value \" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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. See an example of updating custom fields’ values in <a href=\" https://pipedrive.readme.io/docs/updating-custom-field-value \" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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
@@ -84,7 +84,7 @@ var PersonsApi = /*#__PURE__*/function () {
84
84
  }
85
85
  /**
86
86
  * Add a person
87
- * Adds a new person. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the personFields and look for `key` values.
87
+ * Adds a new person. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the personFields and look for `key` values.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `data.marketing_status` field.
88
88
  * @param {Object} opts Optional parameters
89
89
  * @param {module:model/NewPerson} opts.newPerson
90
90
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddPersonResponse} and HTTP response
@@ -122,7 +122,7 @@ var PersonsApi = /*#__PURE__*/function () {
122
122
  }
123
123
  /**
124
124
  * Add a person
125
- * Adds a new person. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the personFields and look for `key` values.
125
+ * Adds a new person. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the personFields and look for `key` values.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `data.marketing_status` field.
126
126
  * @param {Object} opts Optional parameters
127
127
  * @param {module:model/NewPerson} opts.newPerson
128
128
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddPersonResponse}
@@ -515,7 +515,7 @@ var PersonsApi = /*#__PURE__*/function () {
515
515
  }
516
516
  /**
517
517
  * Get details of a person
518
- * Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.
518
+ * Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
519
519
  * @param {Number} id The ID of the person
520
520
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetPersonDetailsResponse} and HTTP response
521
521
  */
@@ -558,7 +558,7 @@ var PersonsApi = /*#__PURE__*/function () {
558
558
  }
559
559
  /**
560
560
  * Get details of a person
561
- * Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.
561
+ * Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
562
562
  * @param {Number} id The ID of the person
563
563
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetPersonDetailsResponse}
564
564
  */
@@ -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, user_id, deal_id, person_id, org_id, product_id, add_time, update_time, file_name, file_type, file_size, comment.
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, user_id, deal_id, person_id, org_id, product_id, add_time, update_time, file_name, file_type, file_size, comment.
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
 
@@ -977,13 +977,13 @@ var PersonsApi = /*#__PURE__*/function () {
977
977
  }
978
978
  /**
979
979
  * List updates about a person
980
- * Lists updates about a person.
980
+ * Lists updates about a person.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint's response will also include updates for the `marketing_status` field.
981
981
  * @param {Number} id The ID of the person
982
982
  * @param {Object} opts Optional parameters
983
983
  * @param {Number} opts.start Pagination start (default to 0)
984
984
  * @param {Number} opts.limit Items shown per page
985
985
  * @param {String} opts.allChanges Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
986
- * @param {String} opts.items A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document)
986
+ * @param {String} opts.items A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change)
987
987
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PersonFlowResponse} and HTTP response
988
988
  */
989
989
 
@@ -1030,13 +1030,13 @@ var PersonsApi = /*#__PURE__*/function () {
1030
1030
  }
1031
1031
  /**
1032
1032
  * List updates about a person
1033
- * Lists updates about a person.
1033
+ * Lists updates about a person.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint's response will also include updates for the `marketing_status` field.
1034
1034
  * @param {Number} id The ID of the person
1035
1035
  * @param {Object} opts Optional parameters
1036
1036
  * @param {Number} opts.start Pagination start (default to 0)
1037
1037
  * @param {Number} opts.limit Items shown per page
1038
1038
  * @param {String} opts.allChanges Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
1039
- * @param {String} opts.items A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document)
1039
+ * @param {String} opts.items A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change)
1040
1040
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PersonFlowResponse}
1041
1041
  */
1042
1042
 
@@ -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 on how to merge two persons, see <a href=\"https://pipedrive.readme.io/docs/merging-two-persons\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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 on how to merge two persons, see <a href=\"https://pipedrive.readme.io/docs/merging-two-persons\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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 on how to update a person, see <a href=\"https://pipedrive.readme.io/docs/updating-a-person\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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 on how to update a person, see <a href=\"https://pipedrive.readme.io/docs/updating-a-person\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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 on adding a new custom field, see <a href=\"https://pipedrive.readme.io/docs/adding-a-new-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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 on adding a new custom field, see <a href=\"https://pipedrive.readme.io/docs/adding-a-new-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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 on how to delete a custom field, see <a href=\"https://pipedrive.readme.io/docs/deleting-a-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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 on how to delete a custom field, see <a href=\"https://pipedrive.readme.io/docs/deleting-a-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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. See an example of updating custom fields’ values in <a href=\" https://pipedrive.readme.io/docs/updating-custom-field-value \" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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. See an example of updating custom fields’ values in <a href=\" https://pipedrive.readme.io/docs/updating-custom-field-value \" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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
@@ -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 on how to add a product, see <a href=\"https://pipedrive.readme.io/docs/adding-a-product\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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 on how to add a product, see <a href=\"https://pipedrive.readme.io/docs/adding-a-product\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
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, user_id, deal_id, person_id, org_id, product_id, add_time, update_time, file_name, file_type, file_size, comment.
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, user_id, deal_id, person_id, org_id, product_id, add_time, update_time, file_name, file_type, file_size, comment.
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
 
@@ -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\">this guide</a> for more details.
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\">this guide</a> for more details.
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}
package/dist/index.js CHANGED
@@ -2615,6 +2615,12 @@ Object.defineProperty(exports, "MailboxApi", {
2615
2615
  return _MailboxApi["default"];
2616
2616
  }
2617
2617
  });
2618
+ Object.defineProperty(exports, "MarketingStatus", {
2619
+ enumerable: true,
2620
+ get: function get() {
2621
+ return _MarketingStatus["default"];
2622
+ }
2623
+ });
2618
2624
  Object.defineProperty(exports, "MergeDealsRequest", {
2619
2625
  enumerable: true,
2620
2626
  get: function get() {
@@ -5140,6 +5146,8 @@ var _MailThreadPut = _interopRequireDefault(require("./model/MailThreadPut"));
5140
5146
 
5141
5147
  var _MailThreadPutAllOf = _interopRequireDefault(require("./model/MailThreadPutAllOf"));
5142
5148
 
5149
+ var _MarketingStatus = _interopRequireDefault(require("./model/MarketingStatus"));
5150
+
5143
5151
  var _MergeDealsRequest = _interopRequireDefault(require("./model/MergeDealsRequest"));
5144
5152
 
5145
5153
  var _MergeOrganizationsRequest = _interopRequireDefault(require("./model/MergeOrganizationsRequest"));
@@ -80,7 +80,7 @@ var ActivityTypeBulkDeleteResponseAllOfData = /*#__PURE__*/function () {
80
80
  return ActivityTypeBulkDeleteResponseAllOfData;
81
81
  }();
82
82
  /**
83
- * The IDs of the deleted ActivityTypes
83
+ * The IDs of the deleted activity types
84
84
  * @member {Array.<Number>} id
85
85
  */
86
86