pipedrive 34.0.0 → 35.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 (99) hide show
  1. package/dist/esm/versions/v1/api/deal-fields-api.d.ts +6 -6
  2. package/dist/esm/versions/v1/api/deal-fields-api.js +5 -5
  3. package/dist/esm/versions/v1/api/deals-api.d.ts +6 -6
  4. package/dist/esm/versions/v1/api/deals-api.js +5 -5
  5. package/dist/esm/versions/v1/api/filters-api.d.ts +6 -6
  6. package/dist/esm/versions/v1/api/filters-api.js +5 -5
  7. package/dist/esm/versions/v1/api/leads-api.d.ts +10 -10
  8. package/dist/esm/versions/v1/api/leads-api.js +9 -9
  9. package/dist/esm/versions/v1/api/organization-fields-api.d.ts +6 -6
  10. package/dist/esm/versions/v1/api/organization-fields-api.js +5 -5
  11. package/dist/esm/versions/v1/api/organizations-api.d.ts +6 -6
  12. package/dist/esm/versions/v1/api/organizations-api.js +5 -5
  13. package/dist/esm/versions/v1/api/person-fields-api.d.ts +6 -6
  14. package/dist/esm/versions/v1/api/person-fields-api.js +5 -5
  15. package/dist/esm/versions/v1/api/persons-api.d.ts +6 -6
  16. package/dist/esm/versions/v1/api/persons-api.js +5 -5
  17. package/dist/esm/versions/v1/api/product-fields-api.d.ts +6 -6
  18. package/dist/esm/versions/v1/api/product-fields-api.js +5 -5
  19. package/dist/esm/versions/v2/api/beta-api.d.ts +6 -6
  20. package/dist/esm/versions/v2/api/beta-api.js +5 -5
  21. package/dist/esm/versions/v2/api/deal-products-api.d.ts +6 -6
  22. package/dist/esm/versions/v2/api/deal-products-api.js +4 -4
  23. package/dist/esm/versions/v2/api/deals-api.d.ts +26 -26
  24. package/dist/esm/versions/v2/api/deals-api.js +20 -20
  25. package/dist/esm/versions/v2/api/item-search-api.d.ts +14 -14
  26. package/dist/esm/versions/v2/api/item-search-api.js +13 -13
  27. package/dist/esm/versions/v2/api/leads-api.d.ts +10 -10
  28. package/dist/esm/versions/v2/api/leads-api.js +9 -9
  29. package/dist/esm/versions/v2/api/organizations-api.d.ts +6 -6
  30. package/dist/esm/versions/v2/api/organizations-api.js +4 -4
  31. package/dist/esm/versions/v2/api/persons-api.d.ts +10 -10
  32. package/dist/esm/versions/v2/api/persons-api.js +8 -8
  33. package/dist/esm/versions/v2/api/product-fields-api.d.ts +14 -14
  34. package/dist/esm/versions/v2/api/products-api.d.ts +10 -10
  35. package/dist/esm/versions/v2/api/products-api.js +8 -8
  36. package/dist/esm/versions/v2/api/projects-api.d.ts +6 -6
  37. package/dist/esm/versions/v2/api/projects-api.js +5 -5
  38. package/dist/esm/versions/v2/models/add-product-field200-response.d.ts +29 -0
  39. package/dist/esm/versions/v2/models/add-product-field200-response.js +14 -0
  40. package/dist/esm/versions/v2/models/get-activity-fields200-response-data-inner.d.ts +2 -0
  41. package/dist/esm/versions/v2/models/get-activity-fields200-response-data-inner.js +3 -1
  42. package/dist/esm/versions/v2/models/get-product-fields200-response-data-inner.d.ts +97 -0
  43. package/dist/esm/versions/v2/models/get-product-fields200-response-data-inner.js +48 -0
  44. package/dist/esm/versions/v2/models/get-product-fields200-response.d.ts +35 -0
  45. package/dist/esm/versions/v2/models/get-product-fields200-response.js +14 -0
  46. package/dist/esm/versions/v2/models/get-project-fields200-response-data-inner.d.ts +1 -0
  47. package/dist/esm/versions/v2/models/get-project-fields200-response-data-inner.js +2 -1
  48. package/dist/esm/versions/v2/models/index.d.ts +3 -0
  49. package/dist/esm/versions/v2/models/index.js +3 -0
  50. package/dist/versions/v1/api/deal-fields-api.d.ts +6 -6
  51. package/dist/versions/v1/api/deal-fields-api.js +4 -4
  52. package/dist/versions/v1/api/deals-api.d.ts +6 -6
  53. package/dist/versions/v1/api/deals-api.js +4 -4
  54. package/dist/versions/v1/api/filters-api.d.ts +6 -6
  55. package/dist/versions/v1/api/filters-api.js +4 -4
  56. package/dist/versions/v1/api/leads-api.d.ts +10 -10
  57. package/dist/versions/v1/api/leads-api.js +8 -8
  58. package/dist/versions/v1/api/organization-fields-api.d.ts +6 -6
  59. package/dist/versions/v1/api/organization-fields-api.js +4 -4
  60. package/dist/versions/v1/api/organizations-api.d.ts +6 -6
  61. package/dist/versions/v1/api/organizations-api.js +4 -4
  62. package/dist/versions/v1/api/person-fields-api.d.ts +6 -6
  63. package/dist/versions/v1/api/person-fields-api.js +4 -4
  64. package/dist/versions/v1/api/persons-api.d.ts +6 -6
  65. package/dist/versions/v1/api/persons-api.js +4 -4
  66. package/dist/versions/v1/api/product-fields-api.d.ts +6 -6
  67. package/dist/versions/v1/api/product-fields-api.js +4 -4
  68. package/dist/versions/v2/api/beta-api.d.ts +6 -6
  69. package/dist/versions/v2/api/beta-api.js +4 -4
  70. package/dist/versions/v2/api/deal-products-api.d.ts +6 -6
  71. package/dist/versions/v2/api/deal-products-api.js +4 -4
  72. package/dist/versions/v2/api/deals-api.d.ts +26 -26
  73. package/dist/versions/v2/api/deals-api.js +20 -20
  74. package/dist/versions/v2/api/item-search-api.d.ts +14 -14
  75. package/dist/versions/v2/api/item-search-api.js +12 -12
  76. package/dist/versions/v2/api/leads-api.d.ts +10 -10
  77. package/dist/versions/v2/api/leads-api.js +8 -8
  78. package/dist/versions/v2/api/organizations-api.d.ts +6 -6
  79. package/dist/versions/v2/api/organizations-api.js +4 -4
  80. package/dist/versions/v2/api/persons-api.d.ts +10 -10
  81. package/dist/versions/v2/api/persons-api.js +8 -8
  82. package/dist/versions/v2/api/product-fields-api.d.ts +14 -14
  83. package/dist/versions/v2/api/products-api.d.ts +10 -10
  84. package/dist/versions/v2/api/products-api.js +8 -8
  85. package/dist/versions/v2/api/projects-api.d.ts +6 -6
  86. package/dist/versions/v2/api/projects-api.js +4 -4
  87. package/dist/versions/v2/models/add-product-field200-response.d.ts +29 -0
  88. package/dist/versions/v2/models/add-product-field200-response.js +15 -0
  89. package/dist/versions/v2/models/get-activity-fields200-response-data-inner.d.ts +2 -0
  90. package/dist/versions/v2/models/get-activity-fields200-response-data-inner.js +3 -1
  91. package/dist/versions/v2/models/get-product-fields200-response-data-inner.d.ts +97 -0
  92. package/dist/versions/v2/models/get-product-fields200-response-data-inner.js +51 -0
  93. package/dist/versions/v2/models/get-product-fields200-response.d.ts +35 -0
  94. package/dist/versions/v2/models/get-product-fields200-response.js +15 -0
  95. package/dist/versions/v2/models/get-project-fields200-response-data-inner.d.ts +1 -0
  96. package/dist/versions/v2/models/get-project-fields200-response-data-inner.js +2 -1
  97. package/dist/versions/v2/models/index.d.ts +3 -0
  98. package/dist/versions/v2/models/index.js +3 -0
  99. package/package.json +1 -1
@@ -43,17 +43,17 @@ export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration)
43
43
  * Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
44
44
  * @summary Search leads
45
45
  * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
46
- * @param {'custom_fields' | 'notes' | 'title'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
46
+ * @param {Set<'custom_fields' | 'notes' | 'title'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
47
47
  * @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.
48
48
  * @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
49
49
  * @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
50
- * @param {'lead.was_seen'} [include_fields] Supports including optional fields in the results which are not provided by default
50
+ * @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
51
51
  * @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.
52
52
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
53
53
 
54
54
  * @throws {RequiredError}
55
55
  */
56
- searchLeads: (term: string, fields?: 'custom_fields' | 'notes' | 'title', exact_match?: boolean, person_id?: number, organization_id?: number, include_fields?: 'lead.was_seen', limit?: number, cursor?: string) => Promise<RequestArgs>;
56
+ searchLeads: (term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, include_fields?: Set<'lead.was_seen'>, limit?: number, cursor?: string) => Promise<RequestArgs>;
57
57
  };
58
58
  /**
59
59
  * LeadsApi - functional programming interface
@@ -82,17 +82,17 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
82
82
  * Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
83
83
  * @summary Search leads
84
84
  * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
85
- * @param {'custom_fields' | 'notes' | 'title'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
85
+ * @param {Set<'custom_fields' | 'notes' | 'title'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
86
86
  * @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.
87
87
  * @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
88
88
  * @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
89
- * @param {'lead.was_seen'} [include_fields] Supports including optional fields in the results which are not provided by default
89
+ * @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
90
90
  * @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.
91
91
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
92
92
 
93
93
  * @throws {RequiredError}
94
94
  */
95
- searchLeads(term: string, fields?: 'custom_fields' | 'notes' | 'title', exact_match?: boolean, person_id?: number, organization_id?: number, include_fields?: 'lead.was_seen', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadSearchResponse>>;
95
+ searchLeads(term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, include_fields?: Set<'lead.was_seen'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadSearchResponse>>;
96
96
  };
97
97
  /**
98
98
  * LeadsApi - factory interface
@@ -176,10 +176,10 @@ export interface LeadsApiSearchLeadsRequest {
176
176
  readonly term: string;
177
177
  /**
178
178
  * A comma-separated string array. The fields to perform the search from. Defaults to all of them.
179
- * @type {'custom_fields' | 'notes' | 'title'}
179
+ * @type {Set<'custom_fields' | 'notes' | 'title'>}
180
180
  * @memberof LeadsApiSearchLeads
181
181
  */
182
- readonly fields?: 'custom_fields' | 'notes' | 'title';
182
+ readonly fields?: Set<'custom_fields' | 'notes' | 'title'>;
183
183
  /**
184
184
  * When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
185
185
  * @type {boolean}
@@ -200,10 +200,10 @@ export interface LeadsApiSearchLeadsRequest {
200
200
  readonly organization_id?: number;
201
201
  /**
202
202
  * Supports including optional fields in the results which are not provided by default
203
- * @type {'lead.was_seen'}
203
+ * @type {Set<'lead.was_seen'>}
204
204
  * @memberof LeadsApiSearchLeads
205
205
  */
206
- readonly include_fields?: 'lead.was_seen';
206
+ readonly include_fields?: Set<'lead.was_seen'>;
207
207
  /**
208
208
  * 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.
209
209
  * @type {number}
@@ -117,11 +117,11 @@ const LeadsApiAxiosParamCreator = function (configuration) {
117
117
  * Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
118
118
  * @summary Search leads
119
119
  * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
120
- * @param {'custom_fields' | 'notes' | 'title'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
120
+ * @param {Set<'custom_fields' | 'notes' | 'title'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
121
121
  * @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.
122
122
  * @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
123
123
  * @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
124
- * @param {'lead.was_seen'} [include_fields] Supports including optional fields in the results which are not provided by default
124
+ * @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
125
125
  * @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.
126
126
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
127
127
 
@@ -148,8 +148,8 @@ const LeadsApiAxiosParamCreator = function (configuration) {
148
148
  if (term !== undefined) {
149
149
  localVarQueryParameter['term'] = term;
150
150
  }
151
- if (fields !== undefined) {
152
- localVarQueryParameter['fields'] = fields;
151
+ if (fields) {
152
+ localVarQueryParameter['fields'] = Array.from(fields).join(base_1.COLLECTION_FORMATS.csv);
153
153
  }
154
154
  if (exact_match !== undefined) {
155
155
  localVarQueryParameter['exact_match'] = exact_match;
@@ -160,8 +160,8 @@ const LeadsApiAxiosParamCreator = function (configuration) {
160
160
  if (organization_id !== undefined) {
161
161
  localVarQueryParameter['organization_id'] = organization_id;
162
162
  }
163
- if (include_fields !== undefined) {
164
- localVarQueryParameter['include_fields'] = include_fields;
163
+ if (include_fields) {
164
+ localVarQueryParameter['include_fields'] = Array.from(include_fields).join(base_1.COLLECTION_FORMATS.csv);
165
165
  }
166
166
  if (limit !== undefined) {
167
167
  localVarQueryParameter['limit'] = limit;
@@ -219,11 +219,11 @@ const LeadsApiFp = function (configuration) {
219
219
  * Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
220
220
  * @summary Search leads
221
221
  * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
222
- * @param {'custom_fields' | 'notes' | 'title'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
222
+ * @param {Set<'custom_fields' | 'notes' | 'title'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
223
223
  * @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.
224
224
  * @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
225
225
  * @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
226
- * @param {'lead.was_seen'} [include_fields] Supports including optional fields in the results which are not provided by default
226
+ * @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
227
227
  * @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.
228
228
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
229
229
 
@@ -118,14 +118,14 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
118
118
  * Searches all organizations by name, address, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope.
119
119
  * @summary Search organizations
120
120
  * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
121
- * @param {'address' | 'custom_fields' | 'notes' | '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;.
121
+ * @param {Set<'address' | 'custom_fields' | 'notes' | '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;.
122
122
  * @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.
123
123
  * @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.
124
124
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
125
125
 
126
126
  * @throws {RequiredError}
127
127
  */
128
- searchOrganization: (term: string, fields?: 'address' | 'custom_fields' | 'notes' | 'name', exact_match?: boolean, limit?: number, cursor?: string) => Promise<RequestArgs>;
128
+ searchOrganization: (term: string, fields?: Set<'address' | 'custom_fields' | 'notes' | 'name'>, exact_match?: boolean, limit?: number, cursor?: string) => Promise<RequestArgs>;
129
129
  /**
130
130
  * Updates the properties of a organization.
131
131
  * @summary Update a organization
@@ -231,14 +231,14 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
231
231
  * Searches all organizations by name, address, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope.
232
232
  * @summary Search organizations
233
233
  * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
234
- * @param {'address' | 'custom_fields' | 'notes' | '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;.
234
+ * @param {Set<'address' | 'custom_fields' | 'notes' | '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;.
235
235
  * @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.
236
236
  * @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.
237
237
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
238
238
 
239
239
  * @throws {RequiredError}
240
240
  */
241
- searchOrganization(term: string, fields?: 'address' | 'custom_fields' | 'notes' | 'name', exact_match?: boolean, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetOrganizationSearchResponse>>;
241
+ searchOrganization(term: string, fields?: Set<'address' | 'custom_fields' | 'notes' | 'name'>, exact_match?: boolean, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetOrganizationSearchResponse>>;
242
242
  /**
243
243
  * Updates the properties of a organization.
244
244
  * @summary Update a organization
@@ -585,10 +585,10 @@ export interface OrganizationsApiSearchOrganizationRequest {
585
585
  readonly term: string;
586
586
  /**
587
587
  * 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;.
588
- * @type {'address' | 'custom_fields' | 'notes' | 'name'}
588
+ * @type {Set<'address' | 'custom_fields' | 'notes' | 'name'>}
589
589
  * @memberof OrganizationsApiSearchOrganization
590
590
  */
591
- readonly fields?: 'address' | 'custom_fields' | 'notes' | 'name';
591
+ readonly fields?: Set<'address' | 'custom_fields' | 'notes' | 'name'>;
592
592
  /**
593
593
  * When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
594
594
  * @type {boolean}
@@ -400,7 +400,7 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
400
400
  * Searches all organizations by name, address, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope.
401
401
  * @summary Search organizations
402
402
  * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
403
- * @param {'address' | 'custom_fields' | 'notes' | '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;.
403
+ * @param {Set<'address' | 'custom_fields' | 'notes' | '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;.
404
404
  * @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.
405
405
  * @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.
406
406
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
@@ -428,8 +428,8 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
428
428
  if (term !== undefined) {
429
429
  localVarQueryParameter['term'] = term;
430
430
  }
431
- if (fields !== undefined) {
432
- localVarQueryParameter['fields'] = fields;
431
+ if (fields) {
432
+ localVarQueryParameter['fields'] = Array.from(fields).join(base_1.COLLECTION_FORMATS.csv);
433
433
  }
434
434
  if (exact_match !== undefined) {
435
435
  localVarQueryParameter['exact_match'] = exact_match;
@@ -625,7 +625,7 @@ const OrganizationsApiFp = function (configuration) {
625
625
  * Searches all organizations by name, address, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope.
626
626
  * @summary Search organizations
627
627
  * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
628
- * @param {'address' | 'custom_fields' | 'notes' | '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;.
628
+ * @param {Set<'address' | 'custom_fields' | 'notes' | '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;.
629
629
  * @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.
630
630
  * @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.
631
631
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
@@ -129,16 +129,16 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
129
129
  * Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found persons can be filtered by organization ID.
130
130
  * @summary Search persons
131
131
  * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
132
- * @param {'custom_fields' | 'email' | 'notes' | 'phone' | '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;.
132
+ * @param {Set<'custom_fields' | 'email' | 'notes' | 'phone' | '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;.
133
133
  * @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.
134
134
  * @param {number} [organization_id] Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
135
- * @param {'person.picture'} [include_fields] Supports including optional fields in the results which are not provided by default
135
+ * @param {Set<'person.picture'>} [include_fields] Supports including optional fields in the results which are not provided by default
136
136
  * @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.
137
137
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
138
138
 
139
139
  * @throws {RequiredError}
140
140
  */
141
- searchPersons: (term: string, fields?: 'custom_fields' | 'email' | 'notes' | 'phone' | 'name', exact_match?: boolean, organization_id?: number, include_fields?: 'person.picture', limit?: number, cursor?: string) => Promise<RequestArgs>;
141
+ searchPersons: (term: string, fields?: Set<'custom_fields' | 'email' | 'notes' | 'phone' | 'name'>, exact_match?: boolean, organization_id?: number, include_fields?: Set<'person.picture'>, limit?: number, cursor?: string) => Promise<RequestArgs>;
142
142
  /**
143
143
  * Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
144
144
  * @summary Update a person
@@ -254,16 +254,16 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
254
254
  * Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found persons can be filtered by organization ID.
255
255
  * @summary Search persons
256
256
  * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
257
- * @param {'custom_fields' | 'email' | 'notes' | 'phone' | '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;.
257
+ * @param {Set<'custom_fields' | 'email' | 'notes' | 'phone' | '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;.
258
258
  * @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.
259
259
  * @param {number} [organization_id] Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
260
- * @param {'person.picture'} [include_fields] Supports including optional fields in the results which are not provided by default
260
+ * @param {Set<'person.picture'>} [include_fields] Supports including optional fields in the results which are not provided by default
261
261
  * @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.
262
262
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
263
263
 
264
264
  * @throws {RequiredError}
265
265
  */
266
- searchPersons(term: string, fields?: 'custom_fields' | 'email' | 'notes' | 'phone' | 'name', exact_match?: boolean, organization_id?: number, include_fields?: 'person.picture', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonSearchResponse>>;
266
+ searchPersons(term: string, fields?: Set<'custom_fields' | 'email' | 'notes' | 'phone' | 'name'>, exact_match?: boolean, organization_id?: number, include_fields?: Set<'person.picture'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonSearchResponse>>;
267
267
  /**
268
268
  * Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
269
269
  * @summary Update a person
@@ -643,10 +643,10 @@ export interface PersonsApiSearchPersonsRequest {
643
643
  readonly term: string;
644
644
  /**
645
645
  * 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;.
646
- * @type {'custom_fields' | 'email' | 'notes' | 'phone' | 'name'}
646
+ * @type {Set<'custom_fields' | 'email' | 'notes' | 'phone' | 'name'>}
647
647
  * @memberof PersonsApiSearchPersons
648
648
  */
649
- readonly fields?: 'custom_fields' | 'email' | 'notes' | 'phone' | 'name';
649
+ readonly fields?: Set<'custom_fields' | 'email' | 'notes' | 'phone' | 'name'>;
650
650
  /**
651
651
  * When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
652
652
  * @type {boolean}
@@ -661,10 +661,10 @@ export interface PersonsApiSearchPersonsRequest {
661
661
  readonly organization_id?: number;
662
662
  /**
663
663
  * Supports including optional fields in the results which are not provided by default
664
- * @type {'person.picture'}
664
+ * @type {Set<'person.picture'>}
665
665
  * @memberof PersonsApiSearchPersons
666
666
  */
667
- readonly include_fields?: 'person.picture';
667
+ readonly include_fields?: Set<'person.picture'>;
668
668
  /**
669
669
  * 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.
670
670
  * @type {number}
@@ -442,10 +442,10 @@ const PersonsApiAxiosParamCreator = function (configuration) {
442
442
  * Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found persons can be filtered by organization ID.
443
443
  * @summary Search persons
444
444
  * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
445
- * @param {'custom_fields' | 'email' | 'notes' | 'phone' | '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;.
445
+ * @param {Set<'custom_fields' | 'email' | 'notes' | 'phone' | '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;.
446
446
  * @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.
447
447
  * @param {number} [organization_id] Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
448
- * @param {'person.picture'} [include_fields] Supports including optional fields in the results which are not provided by default
448
+ * @param {Set<'person.picture'>} [include_fields] Supports including optional fields in the results which are not provided by default
449
449
  * @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.
450
450
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
451
451
 
@@ -472,8 +472,8 @@ const PersonsApiAxiosParamCreator = function (configuration) {
472
472
  if (term !== undefined) {
473
473
  localVarQueryParameter['term'] = term;
474
474
  }
475
- if (fields !== undefined) {
476
- localVarQueryParameter['fields'] = fields;
475
+ if (fields) {
476
+ localVarQueryParameter['fields'] = Array.from(fields).join(base_1.COLLECTION_FORMATS.csv);
477
477
  }
478
478
  if (exact_match !== undefined) {
479
479
  localVarQueryParameter['exact_match'] = exact_match;
@@ -481,8 +481,8 @@ const PersonsApiAxiosParamCreator = function (configuration) {
481
481
  if (organization_id !== undefined) {
482
482
  localVarQueryParameter['organization_id'] = organization_id;
483
483
  }
484
- if (include_fields !== undefined) {
485
- localVarQueryParameter['include_fields'] = include_fields;
484
+ if (include_fields) {
485
+ localVarQueryParameter['include_fields'] = Array.from(include_fields).join(base_1.COLLECTION_FORMATS.csv);
486
486
  }
487
487
  if (limit !== undefined) {
488
488
  localVarQueryParameter['limit'] = limit;
@@ -690,10 +690,10 @@ const PersonsApiFp = function (configuration) {
690
690
  * Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found persons can be filtered by organization ID.
691
691
  * @summary Search persons
692
692
  * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
693
- * @param {'custom_fields' | 'email' | 'notes' | 'phone' | '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;.
693
+ * @param {Set<'custom_fields' | 'email' | 'notes' | 'phone' | '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;.
694
694
  * @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.
695
695
  * @param {number} [organization_id] Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
696
- * @param {'person.picture'} [include_fields] Supports including optional fields in the results which are not provided by default
696
+ * @param {Set<'person.picture'>} [include_fields] Supports including optional fields in the results which are not provided by default
697
697
  * @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.
698
698
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
699
699
 
@@ -14,11 +14,11 @@ import type { AxiosInstance } from 'axios';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
15
  import { AddDealFieldOptions200Response } from '../models';
16
16
  import { AddDealFieldOptionsRequestInner } from '../models';
17
+ import { AddProductField200Response } from '../models';
17
18
  import { AddProductFieldRequest } from '../models';
18
19
  import { DeleteDealFieldOptionsRequestInner } from '../models';
19
20
  import { DeletePersonField200Response } from '../models';
20
- import { GetActivityField200Response } from '../models';
21
- import { GetActivityFields200Response } from '../models';
21
+ import { GetProductFields200Response } from '../models';
22
22
  import { UpdateDealFieldOptionsRequestInner } from '../models';
23
23
  import { UpdateProductFieldRequest } from '../models';
24
24
  /**
@@ -110,7 +110,7 @@ export declare const ProductFieldsApiFp: (configuration?: Configuration) => {
110
110
 
111
111
  * @throws {RequiredError}
112
112
  */
113
- addProductField(AddProductFieldRequest: AddProductFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivityField200Response>>;
113
+ addProductField(AddProductFieldRequest: AddProductFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddProductField200Response>>;
114
114
  /**
115
115
  * Adds new options to a product custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
116
116
  * @summary Add product field options in bulk
@@ -145,7 +145,7 @@ export declare const ProductFieldsApiFp: (configuration?: Configuration) => {
145
145
 
146
146
  * @throws {RequiredError}
147
147
  */
148
- getProductField(field_code: string, include_fields?: Set<'ui_visibility'>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivityField200Response>>;
148
+ getProductField(field_code: string, include_fields?: Set<'ui_visibility'>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddProductField200Response>>;
149
149
  /**
150
150
  * Returns metadata about all product fields in the company.
151
151
  * @summary Get all product fields
@@ -155,7 +155,7 @@ export declare const ProductFieldsApiFp: (configuration?: Configuration) => {
155
155
 
156
156
  * @throws {RequiredError}
157
157
  */
158
- getProductFields(include_fields?: Set<'ui_visibility'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivityFields200Response>>;
158
+ getProductFields(include_fields?: Set<'ui_visibility'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductFields200Response>>;
159
159
  /**
160
160
  * Updates a product custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
161
161
  * @summary Update one product field
@@ -164,7 +164,7 @@ export declare const ProductFieldsApiFp: (configuration?: Configuration) => {
164
164
 
165
165
  * @throws {RequiredError}
166
166
  */
167
- updateProductField(field_code: string, UpdateProductFieldRequest: UpdateProductFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivityField200Response>>;
167
+ updateProductField(field_code: string, UpdateProductFieldRequest: UpdateProductFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddProductField200Response>>;
168
168
  /**
169
169
  * Updates existing options for a product custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
170
170
  * @summary Update product field options in bulk
@@ -187,7 +187,7 @@ export declare const ProductFieldsApiFactory: (configuration?: Configuration, ba
187
187
 
188
188
  * @throws {RequiredError}
189
189
  */
190
- addProductField(requestParameters: ProductFieldsApiAddProductFieldRequest): Promise<GetActivityField200Response>;
190
+ addProductField(requestParameters: ProductFieldsApiAddProductFieldRequest): Promise<AddProductField200Response>;
191
191
  /**
192
192
  * Adds new options to a product custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
193
193
  * @summary Add product field options in bulk
@@ -219,7 +219,7 @@ export declare const ProductFieldsApiFactory: (configuration?: Configuration, ba
219
219
 
220
220
  * @throws {RequiredError}
221
221
  */
222
- getProductField(requestParameters: ProductFieldsApiGetProductFieldRequest): Promise<GetActivityField200Response>;
222
+ getProductField(requestParameters: ProductFieldsApiGetProductFieldRequest): Promise<AddProductField200Response>;
223
223
  /**
224
224
  * Returns metadata about all product fields in the company.
225
225
  * @summary Get all product fields
@@ -227,7 +227,7 @@ export declare const ProductFieldsApiFactory: (configuration?: Configuration, ba
227
227
 
228
228
  * @throws {RequiredError}
229
229
  */
230
- getProductFields(requestParameters?: ProductFieldsApiGetProductFieldsRequest): Promise<GetActivityFields200Response>;
230
+ getProductFields(requestParameters?: ProductFieldsApiGetProductFieldsRequest): Promise<GetProductFields200Response>;
231
231
  /**
232
232
  * Updates a product custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
233
233
  * @summary Update one product field
@@ -235,7 +235,7 @@ export declare const ProductFieldsApiFactory: (configuration?: Configuration, ba
235
235
 
236
236
  * @throws {RequiredError}
237
237
  */
238
- updateProductField(requestParameters: ProductFieldsApiUpdateProductFieldRequest): Promise<GetActivityField200Response>;
238
+ updateProductField(requestParameters: ProductFieldsApiUpdateProductFieldRequest): Promise<AddProductField200Response>;
239
239
  /**
240
240
  * Updates existing options for a product custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
241
241
  * @summary Update product field options in bulk
@@ -406,7 +406,7 @@ export declare class ProductFieldsApi extends BaseAPI {
406
406
  * @throws {RequiredError}
407
407
  * @memberof ProductFieldsApi
408
408
  */
409
- addProductField(requestParameters: ProductFieldsApiAddProductFieldRequest): Promise<GetActivityField200Response>;
409
+ addProductField(requestParameters: ProductFieldsApiAddProductFieldRequest): Promise<AddProductField200Response>;
410
410
  /**
411
411
  * Adds new options to a product custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
412
412
  * @summary Add product field options in bulk
@@ -442,7 +442,7 @@ export declare class ProductFieldsApi extends BaseAPI {
442
442
  * @throws {RequiredError}
443
443
  * @memberof ProductFieldsApi
444
444
  */
445
- getProductField(requestParameters: ProductFieldsApiGetProductFieldRequest): Promise<GetActivityField200Response>;
445
+ getProductField(requestParameters: ProductFieldsApiGetProductFieldRequest): Promise<AddProductField200Response>;
446
446
  /**
447
447
  * Returns metadata about all product fields in the company.
448
448
  * @summary Get all product fields
@@ -451,7 +451,7 @@ export declare class ProductFieldsApi extends BaseAPI {
451
451
  * @throws {RequiredError}
452
452
  * @memberof ProductFieldsApi
453
453
  */
454
- getProductFields(requestParameters?: ProductFieldsApiGetProductFieldsRequest): Promise<GetActivityFields200Response>;
454
+ getProductFields(requestParameters?: ProductFieldsApiGetProductFieldsRequest): Promise<GetProductFields200Response>;
455
455
  /**
456
456
  * Updates a product custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
457
457
  * @summary Update one product field
@@ -460,7 +460,7 @@ export declare class ProductFieldsApi extends BaseAPI {
460
460
  * @throws {RequiredError}
461
461
  * @memberof ProductFieldsApi
462
462
  */
463
- updateProductField(requestParameters: ProductFieldsApiUpdateProductFieldRequest): Promise<GetActivityField200Response>;
463
+ updateProductField(requestParameters: ProductFieldsApiUpdateProductFieldRequest): Promise<AddProductField200Response>;
464
464
  /**
465
465
  * Updates existing options for a product custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
466
466
  * @summary Update product field options in bulk
@@ -172,15 +172,15 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
172
172
  * Searches all products by name, code and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope.
173
173
  * @summary Search products
174
174
  * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
175
- * @param {'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;.
175
+ * @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;.
176
176
  * @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.
177
- * @param {'product.price'} [include_fields] Supports including optional fields in the results which are not provided by default
177
+ * @param {Set<'product.price'>} [include_fields] Supports including optional fields in the results which are not provided by default
178
178
  * @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.
179
179
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
180
180
 
181
181
  * @throws {RequiredError}
182
182
  */
183
- searchProducts: (term: string, fields?: 'code' | 'custom_fields' | 'name', exact_match?: boolean, include_fields?: 'product.price', limit?: number, cursor?: string) => Promise<RequestArgs>;
183
+ searchProducts: (term: string, fields?: Set<'code' | 'custom_fields' | 'name'>, exact_match?: boolean, include_fields?: Set<'product.price'>, limit?: number, cursor?: string) => Promise<RequestArgs>;
184
184
  /**
185
185
  * Updates product data.
186
186
  * @summary Update a product
@@ -358,15 +358,15 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
358
358
  * Searches all products by name, code and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope.
359
359
  * @summary Search products
360
360
  * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
361
- * @param {'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;.
361
+ * @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;.
362
362
  * @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.
363
- * @param {'product.price'} [include_fields] Supports including optional fields in the results which are not provided by default
363
+ * @param {Set<'product.price'>} [include_fields] Supports including optional fields in the results which are not provided by default
364
364
  * @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.
365
365
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
366
366
 
367
367
  * @throws {RequiredError}
368
368
  */
369
- searchProducts(term: string, fields?: 'code' | 'custom_fields' | 'name', exact_match?: boolean, include_fields?: 'product.price', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductSearchResponse>>;
369
+ searchProducts(term: string, fields?: Set<'code' | 'custom_fields' | 'name'>, exact_match?: boolean, include_fields?: Set<'product.price'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductSearchResponse>>;
370
370
  /**
371
371
  * Updates product data.
372
372
  * @summary Update a product
@@ -867,10 +867,10 @@ export interface ProductsApiSearchProductsRequest {
867
867
  readonly term: string;
868
868
  /**
869
869
  * 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;.
870
- * @type {'code' | 'custom_fields' | 'name'}
870
+ * @type {Set<'code' | 'custom_fields' | 'name'>}
871
871
  * @memberof ProductsApiSearchProducts
872
872
  */
873
- readonly fields?: 'code' | 'custom_fields' | 'name';
873
+ readonly fields?: Set<'code' | 'custom_fields' | 'name'>;
874
874
  /**
875
875
  * When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
876
876
  * @type {boolean}
@@ -879,10 +879,10 @@ export interface ProductsApiSearchProductsRequest {
879
879
  readonly exact_match?: boolean;
880
880
  /**
881
881
  * Supports including optional fields in the results which are not provided by default
882
- * @type {'product.price'}
882
+ * @type {Set<'product.price'>}
883
883
  * @memberof ProductsApiSearchProducts
884
884
  */
885
- readonly include_fields?: 'product.price';
885
+ readonly include_fields?: Set<'product.price'>;
886
886
  /**
887
887
  * 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.
888
888
  * @type {number}
@@ -587,9 +587,9 @@ const ProductsApiAxiosParamCreator = function (configuration) {
587
587
  * Searches all products by name, code and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope.
588
588
  * @summary Search products
589
589
  * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
590
- * @param {'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;.
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
- * @param {'product.price'} [include_fields] Supports including optional fields in the results which are not provided by default
592
+ * @param {Set<'product.price'>} [include_fields] Supports including optional fields in the results which are not provided by default
593
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.
594
594
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
595
595
 
@@ -616,14 +616,14 @@ const ProductsApiAxiosParamCreator = function (configuration) {
616
616
  if (term !== undefined) {
617
617
  localVarQueryParameter['term'] = term;
618
618
  }
619
- if (fields !== undefined) {
620
- localVarQueryParameter['fields'] = fields;
619
+ if (fields) {
620
+ localVarQueryParameter['fields'] = Array.from(fields).join(base_1.COLLECTION_FORMATS.csv);
621
621
  }
622
622
  if (exact_match !== undefined) {
623
623
  localVarQueryParameter['exact_match'] = exact_match;
624
624
  }
625
- if (include_fields !== undefined) {
626
- localVarQueryParameter['include_fields'] = include_fields;
625
+ if (include_fields) {
626
+ localVarQueryParameter['include_fields'] = Array.from(include_fields).join(base_1.COLLECTION_FORMATS.csv);
627
627
  }
628
628
  if (limit !== undefined) {
629
629
  localVarQueryParameter['limit'] = limit;
@@ -1017,9 +1017,9 @@ const ProductsApiFp = function (configuration) {
1017
1017
  * Searches all products by name, code and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope.
1018
1018
  * @summary Search products
1019
1019
  * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
1020
- * @param {'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;.
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
- * @param {'product.price'} [include_fields] Supports including optional fields in the results which are not provided by default
1022
+ * @param {Set<'product.price'>} [include_fields] Supports including optional fields in the results which are not provided by default
1023
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.
1024
1024
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
1025
1025