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
@@ -42,11 +42,11 @@ export declare const DealFieldsApiAxiosParamCreator: (configuration?: Configurat
42
42
  /**
43
43
  * Marks multiple deal fields as deleted.
44
44
  * @summary Delete multiple deal fields in bulk
45
- * @param {string} ids The comma-separated field IDs to delete
45
+ * @param {Set<number>} ids The comma-separated field IDs to delete
46
46
 
47
47
  * @throws {RequiredError}
48
48
  */
49
- deleteDealFields: (ids: string) => Promise<RequestArgs>;
49
+ deleteDealFields: (ids: Set<number>) => Promise<RequestArgs>;
50
50
  /**
51
51
  * Returns data about a specific deal field.
52
52
  * @summary Get one deal field
@@ -98,11 +98,11 @@ export declare const DealFieldsApiFp: (configuration?: Configuration) => {
98
98
  /**
99
99
  * Marks multiple deal fields as deleted.
100
100
  * @summary Delete multiple deal fields in bulk
101
- * @param {string} ids The comma-separated field IDs to delete
101
+ * @param {Set<number>} ids The comma-separated field IDs to delete
102
102
 
103
103
  * @throws {RequiredError}
104
104
  */
105
- deleteDealFields(ids: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteFieldsResponse>>;
105
+ deleteDealFields(ids: Set<number>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteFieldsResponse>>;
106
106
  /**
107
107
  * Returns data about a specific deal field.
108
108
  * @summary Get one deal field
@@ -218,10 +218,10 @@ export interface DealFieldsApiDeleteDealFieldRequest {
218
218
  export interface DealFieldsApiDeleteDealFieldsRequest {
219
219
  /**
220
220
  * The comma-separated field IDs to delete
221
- * @type {string}
221
+ * @type {Set<number>}
222
222
  * @memberof DealFieldsApiDeleteDealFields
223
223
  */
224
- readonly ids: string;
224
+ readonly ids: Set<number>;
225
225
  }
226
226
  /**
227
227
  * Request parameters for getDealField operation in DealFieldsApi.
@@ -25,7 +25,7 @@ import globalAxios from 'axios';
25
25
  // @ts-ignore
26
26
  import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
27
27
  // @ts-ignore
28
- import { BASE_PATH, BaseAPI } from '../base';
28
+ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from '../base';
29
29
  /**
30
30
  * DealFieldsApi - axios parameter creator
31
31
  * @export
@@ -102,7 +102,7 @@ export const DealFieldsApiAxiosParamCreator = function (configuration) {
102
102
  /**
103
103
  * Marks multiple deal fields as deleted.
104
104
  * @summary Delete multiple deal fields in bulk
105
- * @param {string} ids The comma-separated field IDs to delete
105
+ * @param {Set<number>} ids The comma-separated field IDs to delete
106
106
 
107
107
  * @throws {RequiredError}
108
108
  */
@@ -124,8 +124,8 @@ export const DealFieldsApiAxiosParamCreator = function (configuration) {
124
124
  // authentication oauth2 required
125
125
  // oauth required
126
126
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deal-fields:full", "admin"], configuration);
127
- if (ids !== undefined) {
128
- localVarQueryParameter['ids'] = ids;
127
+ if (ids) {
128
+ localVarQueryParameter['ids'] = Array.from(ids).join(COLLECTION_FORMATS.csv);
129
129
  }
130
130
  setSearchParams(localVarUrlObj, localVarQueryParameter);
131
131
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -282,7 +282,7 @@ export const DealFieldsApiFp = function (configuration) {
282
282
  /**
283
283
  * Marks multiple deal fields as deleted.
284
284
  * @summary Delete multiple deal fields in bulk
285
- * @param {string} ids The comma-separated field IDs to delete
285
+ * @param {Set<number>} ids The comma-separated field IDs to delete
286
286
 
287
287
  * @throws {RequiredError}
288
288
  */
@@ -195,11 +195,11 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
195
195
  * @param {number} [start] Pagination start
196
196
  * @param {number} [limit] Items shown per page
197
197
  * @param {string} [all_changes] Whether to show custom field updates or not. 1 &#x3D; Include custom field changes. If omitted returns changes without custom field updates.
198
- * @param {string} [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).
198
+ * @param {Set<string>} [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).
199
199
 
200
200
  * @throws {RequiredError}
201
201
  */
202
- getDealUpdates: (id: number, start?: number, limit?: number, all_changes?: string, items?: string) => Promise<RequestArgs>;
202
+ getDealUpdates: (id: number, start?: number, limit?: number, all_changes?: string, items?: Set<string>) => Promise<RequestArgs>;
203
203
  /**
204
204
  * Lists the users permitted to access a deal.
205
205
  * @summary List permitted users
@@ -409,11 +409,11 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
409
409
  * @param {number} [start] Pagination start
410
410
  * @param {number} [limit] Items shown per page
411
411
  * @param {string} [all_changes] Whether to show custom field updates or not. 1 &#x3D; Include custom field changes. If omitted returns changes without custom field updates.
412
- * @param {string} [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).
412
+ * @param {Set<string>} [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).
413
413
 
414
414
  * @throws {RequiredError}
415
415
  */
416
- getDealUpdates(id: number, start?: number, limit?: number, all_changes?: string, items?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealUpdatesResponse>>;
416
+ getDealUpdates(id: number, start?: number, limit?: number, all_changes?: string, items?: Set<string>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealUpdatesResponse>>;
417
417
  /**
418
418
  * Lists the users permitted to access a deal.
419
419
  * @summary List permitted users
@@ -1066,10 +1066,10 @@ export interface DealsApiGetDealUpdatesRequest {
1066
1066
  readonly all_changes?: string;
1067
1067
  /**
1068
1068
  * 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).
1069
- * @type {string}
1069
+ * @type {Set<string>}
1070
1070
  * @memberof DealsApiGetDealUpdates
1071
1071
  */
1072
- readonly items?: string;
1072
+ readonly items?: Set<string>;
1073
1073
  }
1074
1074
  /**
1075
1075
  * Request parameters for getDealUsers operation in DealsApi.
@@ -25,7 +25,7 @@ import globalAxios from 'axios';
25
25
  // @ts-ignore
26
26
  import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
27
27
  // @ts-ignore
28
- import { BASE_PATH, BaseAPI } from '../base';
28
+ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from '../base';
29
29
  /**
30
30
  * DealsApi - axios parameter creator
31
31
  * @export
@@ -679,7 +679,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
679
679
  * @param {number} [start] Pagination start
680
680
  * @param {number} [limit] Items shown per page
681
681
  * @param {string} [all_changes] Whether to show custom field updates or not. 1 &#x3D; Include custom field changes. If omitted returns changes without custom field updates.
682
- * @param {string} [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).
682
+ * @param {Set<string>} [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).
683
683
 
684
684
  * @throws {RequiredError}
685
685
  */
@@ -711,8 +711,8 @@ export const DealsApiAxiosParamCreator = function (configuration) {
711
711
  if (all_changes !== undefined) {
712
712
  localVarQueryParameter['all_changes'] = all_changes;
713
713
  }
714
- if (items !== undefined) {
715
- localVarQueryParameter['items'] = items;
714
+ if (items) {
715
+ localVarQueryParameter['items'] = Array.from(items).join(COLLECTION_FORMATS.csv);
716
716
  }
717
717
  setSearchParams(localVarUrlObj, localVarQueryParameter);
718
718
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -1156,7 +1156,7 @@ export const DealsApiFp = function (configuration) {
1156
1156
  * @param {number} [start] Pagination start
1157
1157
  * @param {number} [limit] Items shown per page
1158
1158
  * @param {string} [all_changes] Whether to show custom field updates or not. 1 &#x3D; Include custom field changes. If omitted returns changes without custom field updates.
1159
- * @param {string} [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).
1159
+ * @param {Set<string>} [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).
1160
1160
 
1161
1161
  * @throws {RequiredError}
1162
1162
  */
@@ -44,11 +44,11 @@ export declare const FiltersApiAxiosParamCreator: (configuration?: Configuration
44
44
  /**
45
45
  * Marks multiple filters as deleted.
46
46
  * @summary Delete multiple filters in bulk
47
- * @param {string} ids The comma-separated filter IDs to delete
47
+ * @param {Set<number>} ids The comma-separated filter IDs to delete
48
48
 
49
49
  * @throws {RequiredError}
50
50
  */
51
- deleteFilters: (ids: string) => Promise<RequestArgs>;
51
+ deleteFilters: (ids: Set<number>) => Promise<RequestArgs>;
52
52
  /**
53
53
  * Returns data about a specific filter. Note that this also returns the condition lines of the filter.
54
54
  * @summary Get one filter
@@ -109,11 +109,11 @@ export declare const FiltersApiFp: (configuration?: Configuration) => {
109
109
  /**
110
110
  * Marks multiple filters as deleted.
111
111
  * @summary Delete multiple filters in bulk
112
- * @param {string} ids The comma-separated filter IDs to delete
112
+ * @param {Set<number>} ids The comma-separated filter IDs to delete
113
113
 
114
114
  * @throws {RequiredError}
115
115
  */
116
- deleteFilters(ids: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteFiltersResponse>>;
116
+ deleteFilters(ids: Set<number>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteFiltersResponse>>;
117
117
  /**
118
118
  * Returns data about a specific filter. Note that this also returns the condition lines of the filter.
119
119
  * @summary Get one filter
@@ -250,10 +250,10 @@ export interface FiltersApiDeleteFilterRequest {
250
250
  export interface FiltersApiDeleteFiltersRequest {
251
251
  /**
252
252
  * The comma-separated filter IDs to delete
253
- * @type {string}
253
+ * @type {Set<number>}
254
254
  * @memberof FiltersApiDeleteFilters
255
255
  */
256
- readonly ids: string;
256
+ readonly ids: Set<number>;
257
257
  }
258
258
  /**
259
259
  * Request parameters for getFilter operation in FiltersApi.
@@ -25,7 +25,7 @@ import globalAxios from 'axios';
25
25
  // @ts-ignore
26
26
  import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
27
27
  // @ts-ignore
28
- import { BASE_PATH, BaseAPI } from '../base';
28
+ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from '../base';
29
29
  /**
30
30
  * FiltersApi - axios parameter creator
31
31
  * @export
@@ -106,7 +106,7 @@ export const FiltersApiAxiosParamCreator = function (configuration) {
106
106
  /**
107
107
  * Marks multiple filters as deleted.
108
108
  * @summary Delete multiple filters in bulk
109
- * @param {string} ids The comma-separated filter IDs to delete
109
+ * @param {Set<number>} ids The comma-separated filter IDs to delete
110
110
 
111
111
  * @throws {RequiredError}
112
112
  */
@@ -128,8 +128,8 @@ export const FiltersApiAxiosParamCreator = function (configuration) {
128
128
  // authentication oauth2 required
129
129
  // oauth required
130
130
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:full", "activities:full", "contacts:full"], configuration);
131
- if (ids !== undefined) {
132
- localVarQueryParameter['ids'] = ids;
131
+ if (ids) {
132
+ localVarQueryParameter['ids'] = Array.from(ids).join(COLLECTION_FORMATS.csv);
133
133
  }
134
134
  setSearchParams(localVarUrlObj, localVarQueryParameter);
135
135
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -321,7 +321,7 @@ export const FiltersApiFp = function (configuration) {
321
321
  /**
322
322
  * Marks multiple filters as deleted.
323
323
  * @summary Delete multiple filters in bulk
324
- * @param {string} ids The comma-separated filter IDs to delete
324
+ * @param {Set<number>} ids The comma-separated filter IDs to delete
325
325
 
326
326
  * @throws {RequiredError}
327
327
  */
@@ -89,17 +89,17 @@ export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration)
89
89
  * 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.
90
90
  * @summary Search leads
91
91
  * @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.
92
- * @param {'custom_fields' | 'notes' | 'title'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
92
+ * @param {Set<'custom_fields' | 'notes' | 'title'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
93
93
  * @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.
94
94
  * @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
95
95
  * @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
96
- * @param {'lead.was_seen'} [include_fields] Supports including optional fields in the results which are not provided by default
96
+ * @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
97
97
  * @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using &#x60;search_for_related_items&#x60; parameter.
98
98
  * @param {number} [limit] Items shown per page
99
99
 
100
100
  * @throws {RequiredError}
101
101
  */
102
- searchLeads: (term: string, fields?: 'custom_fields' | 'notes' | 'title', exact_match?: boolean, person_id?: number, organization_id?: number, include_fields?: 'lead.was_seen', start?: number, limit?: number) => Promise<RequestArgs>;
102
+ searchLeads: (term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, include_fields?: Set<'lead.was_seen'>, start?: number, limit?: number) => Promise<RequestArgs>;
103
103
  /**
104
104
  * 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>.
105
105
  * @summary Update a lead
@@ -180,17 +180,17 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
180
180
  * 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.
181
181
  * @summary Search leads
182
182
  * @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.
183
- * @param {'custom_fields' | 'notes' | 'title'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
183
+ * @param {Set<'custom_fields' | 'notes' | 'title'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
184
184
  * @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.
185
185
  * @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
186
186
  * @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
187
- * @param {'lead.was_seen'} [include_fields] Supports including optional fields in the results which are not provided by default
187
+ * @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
188
188
  * @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using &#x60;search_for_related_items&#x60; parameter.
189
189
  * @param {number} [limit] Items shown per page
190
190
 
191
191
  * @throws {RequiredError}
192
192
  */
193
- searchLeads(term: string, fields?: 'custom_fields' | 'notes' | 'title', exact_match?: boolean, person_id?: number, organization_id?: number, include_fields?: 'lead.was_seen', start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadSearchResponse>>;
193
+ searchLeads(term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, include_fields?: Set<'lead.was_seen'>, start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadSearchResponse>>;
194
194
  /**
195
195
  * 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>.
196
196
  * @summary Update a lead
@@ -441,10 +441,10 @@ export interface LeadsApiSearchLeadsRequest {
441
441
  readonly term: string;
442
442
  /**
443
443
  * A comma-separated string array. The fields to perform the search from. Defaults to all of them.
444
- * @type {'custom_fields' | 'notes' | 'title'}
444
+ * @type {Set<'custom_fields' | 'notes' | 'title'>}
445
445
  * @memberof LeadsApiSearchLeads
446
446
  */
447
- readonly fields?: 'custom_fields' | 'notes' | 'title';
447
+ readonly fields?: Set<'custom_fields' | 'notes' | 'title'>;
448
448
  /**
449
449
  * When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
450
450
  * @type {boolean}
@@ -465,10 +465,10 @@ export interface LeadsApiSearchLeadsRequest {
465
465
  readonly organization_id?: number;
466
466
  /**
467
467
  * Supports including optional fields in the results which are not provided by default
468
- * @type {'lead.was_seen'}
468
+ * @type {Set<'lead.was_seen'>}
469
469
  * @memberof LeadsApiSearchLeads
470
470
  */
471
- readonly include_fields?: 'lead.was_seen';
471
+ readonly include_fields?: Set<'lead.was_seen'>;
472
472
  /**
473
473
  * Pagination start. Note that the pagination is based on main results and does not include related items when using &#x60;search_for_related_items&#x60; parameter.
474
474
  * @type {number}
@@ -25,7 +25,7 @@ import globalAxios from 'axios';
25
25
  // @ts-ignore
26
26
  import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
27
27
  // @ts-ignore
28
- import { BASE_PATH, BaseAPI } from '../base';
28
+ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from '../base';
29
29
  /**
30
30
  * LeadsApi - axios parameter creator
31
31
  * @export
@@ -291,11 +291,11 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
291
291
  * 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.
292
292
  * @summary Search leads
293
293
  * @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.
294
- * @param {'custom_fields' | 'notes' | 'title'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
294
+ * @param {Set<'custom_fields' | 'notes' | 'title'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
295
295
  * @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.
296
296
  * @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
297
297
  * @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
298
- * @param {'lead.was_seen'} [include_fields] Supports including optional fields in the results which are not provided by default
298
+ * @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
299
299
  * @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using &#x60;search_for_related_items&#x60; parameter.
300
300
  * @param {number} [limit] Items shown per page
301
301
 
@@ -322,8 +322,8 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
322
322
  if (term !== undefined) {
323
323
  localVarQueryParameter['term'] = term;
324
324
  }
325
- if (fields !== undefined) {
326
- localVarQueryParameter['fields'] = fields;
325
+ if (fields) {
326
+ localVarQueryParameter['fields'] = Array.from(fields).join(COLLECTION_FORMATS.csv);
327
327
  }
328
328
  if (exact_match !== undefined) {
329
329
  localVarQueryParameter['exact_match'] = exact_match;
@@ -334,8 +334,8 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
334
334
  if (organization_id !== undefined) {
335
335
  localVarQueryParameter['organization_id'] = organization_id;
336
336
  }
337
- if (include_fields !== undefined) {
338
- localVarQueryParameter['include_fields'] = include_fields;
337
+ if (include_fields) {
338
+ localVarQueryParameter['include_fields'] = Array.from(include_fields).join(COLLECTION_FORMATS.csv);
339
339
  }
340
340
  if (start !== undefined) {
341
341
  localVarQueryParameter['start'] = start;
@@ -492,11 +492,11 @@ export const LeadsApiFp = function (configuration) {
492
492
  * 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.
493
493
  * @summary Search leads
494
494
  * @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.
495
- * @param {'custom_fields' | 'notes' | 'title'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
495
+ * @param {Set<'custom_fields' | 'notes' | 'title'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
496
496
  * @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.
497
497
  * @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
498
498
  * @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
499
- * @param {'lead.was_seen'} [include_fields] Supports including optional fields in the results which are not provided by default
499
+ * @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
500
500
  * @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using &#x60;search_for_related_items&#x60; parameter.
501
501
  * @param {number} [limit] Items shown per page
502
502
 
@@ -42,11 +42,11 @@ export declare const OrganizationFieldsApiAxiosParamCreator: (configuration?: Co
42
42
  /**
43
43
  * Marks multiple fields as deleted.
44
44
  * @summary Delete multiple organization fields in bulk
45
- * @param {string} ids The comma-separated field IDs to delete
45
+ * @param {Set<number>} ids The comma-separated field IDs to delete
46
46
 
47
47
  * @throws {RequiredError}
48
48
  */
49
- deleteOrganizationFields: (ids: string) => Promise<RequestArgs>;
49
+ deleteOrganizationFields: (ids: Set<number>) => Promise<RequestArgs>;
50
50
  /**
51
51
  * Returns data about a specific organization field.
52
52
  * @summary Get one organization field
@@ -98,11 +98,11 @@ export declare const OrganizationFieldsApiFp: (configuration?: Configuration) =>
98
98
  /**
99
99
  * Marks multiple fields as deleted.
100
100
  * @summary Delete multiple organization fields in bulk
101
- * @param {string} ids The comma-separated field IDs to delete
101
+ * @param {Set<number>} ids The comma-separated field IDs to delete
102
102
 
103
103
  * @throws {RequiredError}
104
104
  */
105
- deleteOrganizationFields(ids: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteFieldsResponse>>;
105
+ deleteOrganizationFields(ids: Set<number>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteFieldsResponse>>;
106
106
  /**
107
107
  * Returns data about a specific organization field.
108
108
  * @summary Get one organization field
@@ -218,10 +218,10 @@ export interface OrganizationFieldsApiDeleteOrganizationFieldRequest {
218
218
  export interface OrganizationFieldsApiDeleteOrganizationFieldsRequest {
219
219
  /**
220
220
  * The comma-separated field IDs to delete
221
- * @type {string}
221
+ * @type {Set<number>}
222
222
  * @memberof OrganizationFieldsApiDeleteOrganizationFields
223
223
  */
224
- readonly ids: string;
224
+ readonly ids: Set<number>;
225
225
  }
226
226
  /**
227
227
  * Request parameters for getOrganizationField operation in OrganizationFieldsApi.
@@ -25,7 +25,7 @@ import globalAxios from 'axios';
25
25
  // @ts-ignore
26
26
  import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
27
27
  // @ts-ignore
28
- import { BASE_PATH, BaseAPI } from '../base';
28
+ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from '../base';
29
29
  /**
30
30
  * OrganizationFieldsApi - axios parameter creator
31
31
  * @export
@@ -102,7 +102,7 @@ export const OrganizationFieldsApiAxiosParamCreator = function (configuration) {
102
102
  /**
103
103
  * Marks multiple fields as deleted.
104
104
  * @summary Delete multiple organization fields in bulk
105
- * @param {string} ids The comma-separated field IDs to delete
105
+ * @param {Set<number>} ids The comma-separated field IDs to delete
106
106
 
107
107
  * @throws {RequiredError}
108
108
  */
@@ -124,8 +124,8 @@ export const OrganizationFieldsApiAxiosParamCreator = function (configuration) {
124
124
  // authentication oauth2 required
125
125
  // oauth required
126
126
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contact-fields:full", "admin"], configuration);
127
- if (ids !== undefined) {
128
- localVarQueryParameter['ids'] = ids;
127
+ if (ids) {
128
+ localVarQueryParameter['ids'] = Array.from(ids).join(COLLECTION_FORMATS.csv);
129
129
  }
130
130
  setSearchParams(localVarUrlObj, localVarQueryParameter);
131
131
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -282,7 +282,7 @@ export const OrganizationFieldsApiFp = function (configuration) {
282
282
  /**
283
283
  * Marks multiple fields as deleted.
284
284
  * @summary Delete multiple organization fields in bulk
285
- * @param {string} ids The comma-separated field IDs to delete
285
+ * @param {Set<number>} ids The comma-separated field IDs to delete
286
286
 
287
287
  * @throws {RequiredError}
288
288
  */
@@ -93,11 +93,11 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
93
93
  * @param {number} [start] Pagination start
94
94
  * @param {number} [limit] Items shown per page
95
95
  * @param {string} [all_changes] Whether to show custom field updates or not. 1 &#x3D; Include custom field changes. If omitted, returns changes without custom field updates.
96
- * @param {string} [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).
96
+ * @param {Set<string>} [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).
97
97
 
98
98
  * @throws {RequiredError}
99
99
  */
100
- getOrganizationUpdates: (id: number, start?: number, limit?: number, all_changes?: string, items?: string) => Promise<RequestArgs>;
100
+ getOrganizationUpdates: (id: number, start?: number, limit?: number, all_changes?: string, items?: Set<string>) => Promise<RequestArgs>;
101
101
  /**
102
102
  * List users permitted to access an organization.
103
103
  * @summary List permitted users
@@ -186,11 +186,11 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
186
186
  * @param {number} [start] Pagination start
187
187
  * @param {number} [limit] Items shown per page
188
188
  * @param {string} [all_changes] Whether to show custom field updates or not. 1 &#x3D; Include custom field changes. If omitted, returns changes without custom field updates.
189
- * @param {string} [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).
189
+ * @param {Set<string>} [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).
190
190
 
191
191
  * @throws {RequiredError}
192
192
  */
193
- getOrganizationUpdates(id: number, start?: number, limit?: number, all_changes?: string, items?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedOrganizationUpdatesResponse>>;
193
+ getOrganizationUpdates(id: number, start?: number, limit?: number, all_changes?: string, items?: Set<string>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedOrganizationUpdatesResponse>>;
194
194
  /**
195
195
  * List users permitted to access an organization.
196
196
  * @summary List permitted users
@@ -457,10 +457,10 @@ export interface OrganizationsApiGetOrganizationUpdatesRequest {
457
457
  readonly all_changes?: string;
458
458
  /**
459
459
  * 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).
460
- * @type {string}
460
+ * @type {Set<string>}
461
461
  * @memberof OrganizationsApiGetOrganizationUpdates
462
462
  */
463
- readonly items?: string;
463
+ readonly items?: Set<string>;
464
464
  }
465
465
  /**
466
466
  * Request parameters for getOrganizationUsers operation in OrganizationsApi.
@@ -25,7 +25,7 @@ import globalAxios from 'axios';
25
25
  // @ts-ignore
26
26
  import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
27
27
  // @ts-ignore
28
- import { BASE_PATH, BaseAPI } from '../base';
28
+ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from '../base';
29
29
  /**
30
30
  * OrganizationsApi - axios parameter creator
31
31
  * @export
@@ -282,7 +282,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
282
282
  * @param {number} [start] Pagination start
283
283
  * @param {number} [limit] Items shown per page
284
284
  * @param {string} [all_changes] Whether to show custom field updates or not. 1 &#x3D; Include custom field changes. If omitted, returns changes without custom field updates.
285
- * @param {string} [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).
285
+ * @param {Set<string>} [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).
286
286
 
287
287
  * @throws {RequiredError}
288
288
  */
@@ -314,8 +314,8 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
314
314
  if (all_changes !== undefined) {
315
315
  localVarQueryParameter['all_changes'] = all_changes;
316
316
  }
317
- if (items !== undefined) {
318
- localVarQueryParameter['items'] = items;
317
+ if (items) {
318
+ localVarQueryParameter['items'] = Array.from(items).join(COLLECTION_FORMATS.csv);
319
319
  }
320
320
  setSearchParams(localVarUrlObj, localVarQueryParameter);
321
321
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -500,7 +500,7 @@ export const OrganizationsApiFp = function (configuration) {
500
500
  * @param {number} [start] Pagination start
501
501
  * @param {number} [limit] Items shown per page
502
502
  * @param {string} [all_changes] Whether to show custom field updates or not. 1 &#x3D; Include custom field changes. If omitted, returns changes without custom field updates.
503
- * @param {string} [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).
503
+ * @param {Set<string>} [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).
504
504
 
505
505
  * @throws {RequiredError}
506
506
  */
@@ -42,11 +42,11 @@ export declare const PersonFieldsApiAxiosParamCreator: (configuration?: Configur
42
42
  /**
43
43
  * Marks multiple fields as deleted.
44
44
  * @summary Delete multiple person fields in bulk
45
- * @param {string} ids The comma-separated field IDs to delete
45
+ * @param {Set<number>} ids The comma-separated field IDs to delete
46
46
 
47
47
  * @throws {RequiredError}
48
48
  */
49
- deletePersonFields: (ids: string) => Promise<RequestArgs>;
49
+ deletePersonFields: (ids: Set<number>) => Promise<RequestArgs>;
50
50
  /**
51
51
  * Returns data about a specific person field.
52
52
  * @summary Get one person field
@@ -98,11 +98,11 @@ export declare const PersonFieldsApiFp: (configuration?: Configuration) => {
98
98
  /**
99
99
  * Marks multiple fields as deleted.
100
100
  * @summary Delete multiple person fields in bulk
101
- * @param {string} ids The comma-separated field IDs to delete
101
+ * @param {Set<number>} ids The comma-separated field IDs to delete
102
102
 
103
103
  * @throws {RequiredError}
104
104
  */
105
- deletePersonFields(ids: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteFieldsResponse>>;
105
+ deletePersonFields(ids: Set<number>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteFieldsResponse>>;
106
106
  /**
107
107
  * Returns data about a specific person field.
108
108
  * @summary Get one person field
@@ -218,10 +218,10 @@ export interface PersonFieldsApiDeletePersonFieldRequest {
218
218
  export interface PersonFieldsApiDeletePersonFieldsRequest {
219
219
  /**
220
220
  * The comma-separated field IDs to delete
221
- * @type {string}
221
+ * @type {Set<number>}
222
222
  * @memberof PersonFieldsApiDeletePersonFields
223
223
  */
224
- readonly ids: string;
224
+ readonly ids: Set<number>;
225
225
  }
226
226
  /**
227
227
  * Request parameters for getPersonField operation in PersonFieldsApi.
@@ -25,7 +25,7 @@ import globalAxios from 'axios';
25
25
  // @ts-ignore
26
26
  import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
27
27
  // @ts-ignore
28
- import { BASE_PATH, BaseAPI } from '../base';
28
+ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from '../base';
29
29
  /**
30
30
  * PersonFieldsApi - axios parameter creator
31
31
  * @export
@@ -102,7 +102,7 @@ export const PersonFieldsApiAxiosParamCreator = function (configuration) {
102
102
  /**
103
103
  * Marks multiple fields as deleted.
104
104
  * @summary Delete multiple person fields in bulk
105
- * @param {string} ids The comma-separated field IDs to delete
105
+ * @param {Set<number>} ids The comma-separated field IDs to delete
106
106
 
107
107
  * @throws {RequiredError}
108
108
  */
@@ -124,8 +124,8 @@ export const PersonFieldsApiAxiosParamCreator = function (configuration) {
124
124
  // authentication oauth2 required
125
125
  // oauth required
126
126
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contact-fields:full", "admin"], configuration);
127
- if (ids !== undefined) {
128
- localVarQueryParameter['ids'] = ids;
127
+ if (ids) {
128
+ localVarQueryParameter['ids'] = Array.from(ids).join(COLLECTION_FORMATS.csv);
129
129
  }
130
130
  setSearchParams(localVarUrlObj, localVarQueryParameter);
131
131
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -282,7 +282,7 @@ export const PersonFieldsApiFp = function (configuration) {
282
282
  /**
283
283
  * Marks multiple fields as deleted.
284
284
  * @summary Delete multiple person fields in bulk
285
- * @param {string} ids The comma-separated field IDs to delete
285
+ * @param {Set<number>} ids The comma-separated field IDs to delete
286
286
 
287
287
  * @throws {RequiredError}
288
288
  */