pipedrive 35.1.1 → 36.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/dist/esm/versions/v1/api/leads-api.d.ts +7 -7
  2. package/dist/esm/versions/v1/api/leads-api.js +2 -2
  3. package/dist/esm/versions/v2/api/activities-api.d.ts +7 -7
  4. package/dist/esm/versions/v2/api/activities-api.js +2 -2
  5. package/dist/esm/versions/v2/api/beta-api.d.ts +3 -3
  6. package/dist/esm/versions/v2/api/beta-api.js +2 -2
  7. package/dist/esm/versions/v2/api/deals-api.d.ts +17 -17
  8. package/dist/esm/versions/v2/api/deals-api.js +6 -6
  9. package/dist/esm/versions/v2/api/leads-api.d.ts +3 -3
  10. package/dist/esm/versions/v2/api/leads-api.js +2 -2
  11. package/dist/esm/versions/v2/api/organizations-api.d.ts +10 -10
  12. package/dist/esm/versions/v2/api/organizations-api.js +4 -4
  13. package/dist/esm/versions/v2/api/persons-api.d.ts +10 -10
  14. package/dist/esm/versions/v2/api/persons-api.js +4 -4
  15. package/dist/esm/versions/v2/api/products-api.d.ts +10 -10
  16. package/dist/esm/versions/v2/api/products-api.js +4 -4
  17. package/dist/esm/versions/v2/api/projects-api.d.ts +3 -3
  18. package/dist/esm/versions/v2/api/projects-api.js +2 -2
  19. package/dist/versions/v1/api/leads-api.d.ts +7 -7
  20. package/dist/versions/v1/api/leads-api.js +2 -2
  21. package/dist/versions/v2/api/activities-api.d.ts +7 -7
  22. package/dist/versions/v2/api/activities-api.js +2 -2
  23. package/dist/versions/v2/api/beta-api.d.ts +3 -3
  24. package/dist/versions/v2/api/beta-api.js +2 -2
  25. package/dist/versions/v2/api/deals-api.d.ts +17 -17
  26. package/dist/versions/v2/api/deals-api.js +6 -6
  27. package/dist/versions/v2/api/leads-api.d.ts +3 -3
  28. package/dist/versions/v2/api/leads-api.js +2 -2
  29. package/dist/versions/v2/api/organizations-api.d.ts +10 -10
  30. package/dist/versions/v2/api/organizations-api.js +4 -4
  31. package/dist/versions/v2/api/persons-api.d.ts +10 -10
  32. package/dist/versions/v2/api/persons-api.js +4 -4
  33. package/dist/versions/v2/api/products-api.d.ts +10 -10
  34. package/dist/versions/v2/api/products-api.js +4 -4
  35. package/dist/versions/v2/api/projects-api.d.ts +3 -3
  36. package/dist/versions/v2/api/projects-api.js +2 -2
  37. package/package.json +1 -1
@@ -521,7 +521,7 @@ const ProductsApiAxiosParamCreator = function (configuration) {
521
521
  * Returns data about all products.
522
522
  * @summary Get all products
523
523
  * @param {number} [owner_id] If supplied, only products owned by the given user will be returned
524
- * @param {Set<string>} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
524
+ * @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
525
525
  * @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
526
526
  * @param {number} [filter_id] The ID of the filter to use
527
527
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
@@ -590,7 +590,7 @@ const ProductsApiAxiosParamCreator = function (configuration) {
590
590
  * @param {Set<'code' | 'custom_fields' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.
591
591
  * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
592
592
  * @param {Set<'product.price'>} [include_fields] Supports including optional fields in the results which are not provided by default
593
- * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
593
+ * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
594
594
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
595
595
 
596
596
  * @throws {RequiredError}
@@ -996,7 +996,7 @@ const ProductsApiFp = function (configuration) {
996
996
  * Returns data about all products.
997
997
  * @summary Get all products
998
998
  * @param {number} [owner_id] If supplied, only products owned by the given user will be returned
999
- * @param {Set<string>} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
999
+ * @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
1000
1000
  * @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
1001
1001
  * @param {number} [filter_id] The ID of the filter to use
1002
1002
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
@@ -1020,7 +1020,7 @@ const ProductsApiFp = function (configuration) {
1020
1020
  * @param {Set<'code' | 'custom_fields' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.
1021
1021
  * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
1022
1022
  * @param {Set<'product.price'>} [include_fields] Supports including optional fields in the results which are not provided by default
1023
- * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
1023
+ * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
1024
1024
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
1025
1025
 
1026
1026
  * @throws {RequiredError}
@@ -110,7 +110,7 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
110
110
  * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
111
111
  * @param {number} [person_id] Will filter projects by the provided person ID
112
112
  * @param {number} [organization_id] Will filter projects by the provided organization ID
113
- * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
113
+ * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
114
114
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
115
115
 
116
116
  * @throws {RequiredError}
@@ -216,7 +216,7 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
216
216
  * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
217
217
  * @param {number} [person_id] Will filter projects by the provided person ID
218
218
  * @param {number} [organization_id] Will filter projects by the provided organization ID
219
- * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
219
+ * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
220
220
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
221
221
 
222
222
  * @throws {RequiredError}
@@ -537,7 +537,7 @@ export interface ProjectsApiSearchProjectsRequest {
537
537
  */
538
538
  readonly organization_id?: number;
539
539
  /**
540
- * For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
540
+ * For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
541
541
  * @type {number}
542
542
  * @memberof ProjectsApiSearchProjects
543
543
  */
@@ -371,7 +371,7 @@ const ProjectsApiAxiosParamCreator = function (configuration) {
371
371
  * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
372
372
  * @param {number} [person_id] Will filter projects by the provided person ID
373
373
  * @param {number} [organization_id] Will filter projects by the provided organization ID
374
- * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
374
+ * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
375
375
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
376
376
 
377
377
  * @throws {RequiredError}
@@ -595,7 +595,7 @@ const ProjectsApiFp = function (configuration) {
595
595
  * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
596
596
  * @param {number} [person_id] Will filter projects by the provided person ID
597
597
  * @param {number} [organization_id] Will filter projects by the provided organization ID
598
- * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
598
+ * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
599
599
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
600
600
 
601
601
  * @throws {RequiredError}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pipedrive",
3
- "version": "35.1.1",
3
+ "version": "36.0.0",
4
4
  "description": "Pipedrive REST client for NodeJS",
5
5
  "license": "MIT",
6
6
  "homepage": "https://developers.pipedrive.com",