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
@@ -0,0 +1,97 @@
1
+ /**
2
+ * Pipedrive API v2
3
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { GetActivityFields200ResponseDataInnerOptionsInner } from './get-activity-fields200-response-data-inner-options-inner';
13
+ import { GetActivityFields200ResponseDataInnerSubfieldsInner } from './get-activity-fields200-response-data-inner-subfields-inner';
14
+ import { GetActivityFields200ResponseDataInnerUiVisibility } from './get-activity-fields200-response-data-inner-ui-visibility';
15
+ /**
16
+ *
17
+ * @export
18
+ * @interface GetProductFields200ResponseDataInner
19
+ */
20
+ export interface GetProductFields200ResponseDataInner {
21
+ /**
22
+ * The display name/label of the field
23
+ * @type {string}
24
+ */
25
+ 'field_name': string;
26
+ /**
27
+ * The unique identifier for the field (40-character hash for custom fields)
28
+ * @type {string}
29
+ */
30
+ 'field_code': string;
31
+ /**
32
+ * The type of the field
33
+ * @type {string}
34
+ */
35
+ 'field_type': GetProductFields200ResponseDataInnerFieldTypeConst;
36
+ /**
37
+ * Whether this is a user-created custom field
38
+ * @type {boolean}
39
+ */
40
+ 'is_custom_field': boolean;
41
+ /**
42
+ * Whether this field is not returned by default in entity responses
43
+ * @type {boolean}
44
+ */
45
+ 'is_optional_response_field': boolean;
46
+ /**
47
+ * Array of available options for enum/set fields, null for other field types
48
+ * @type {Array<GetActivityFields200ResponseDataInnerOptionsInner>}
49
+ */
50
+ 'options'?: Array<GetActivityFields200ResponseDataInnerOptionsInner> | null;
51
+ /**
52
+ * Array of subfields for complex field types (address, monetary), null for simple field types
53
+ * @type {Array<GetActivityFields200ResponseDataInnerSubfieldsInner>}
54
+ */
55
+ 'subfields'?: Array<GetActivityFields200ResponseDataInnerSubfieldsInner> | null;
56
+ /**
57
+ *
58
+ * @type {GetActivityFields200ResponseDataInnerUiVisibility}
59
+ */
60
+ 'ui_visibility'?: GetActivityFields200ResponseDataInnerUiVisibility;
61
+ }
62
+ export declare const GetProductFields200ResponseDataInnerFieldTypeConst: {
63
+ readonly int: "int";
64
+ readonly double: "double";
65
+ readonly boolean: "boolean";
66
+ readonly varchar: "varchar";
67
+ readonly text: "text";
68
+ readonly phone: "phone";
69
+ readonly varchar_options: "varchar_options";
70
+ readonly varchar_auto: "varchar_auto";
71
+ readonly date: "date";
72
+ readonly daterange: "daterange";
73
+ readonly time: "time";
74
+ readonly timerange: "timerange";
75
+ readonly enum: "enum";
76
+ readonly set: "set";
77
+ readonly address: "address";
78
+ readonly monetary: "monetary";
79
+ readonly deal: "deal";
80
+ readonly deals: "deals";
81
+ readonly lead: "lead";
82
+ readonly org: "org";
83
+ readonly people: "people";
84
+ readonly project: "project";
85
+ readonly stage: "stage";
86
+ readonly user: "user";
87
+ readonly activity: "activity";
88
+ readonly json: "json";
89
+ readonly picture: "picture";
90
+ readonly status: "status";
91
+ readonly visible_to: "visible_to";
92
+ readonly price_list: "price_list";
93
+ readonly billing_frequency: "billing_frequency";
94
+ readonly projects_board: "projects_board";
95
+ readonly projects_phase: "projects_phase";
96
+ };
97
+ export type GetProductFields200ResponseDataInnerFieldTypeConst = typeof GetProductFields200ResponseDataInnerFieldTypeConst[keyof typeof GetProductFields200ResponseDataInnerFieldTypeConst];
@@ -0,0 +1,48 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Pipedrive API v2
5
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6
+ *
7
+ * The version of the OpenAPI document: 2.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export const GetProductFields200ResponseDataInnerFieldTypeConst = {
15
+ int: 'int',
16
+ double: 'double',
17
+ boolean: 'boolean',
18
+ varchar: 'varchar',
19
+ text: 'text',
20
+ phone: 'phone',
21
+ varchar_options: 'varchar_options',
22
+ varchar_auto: 'varchar_auto',
23
+ date: 'date',
24
+ daterange: 'daterange',
25
+ time: 'time',
26
+ timerange: 'timerange',
27
+ enum: 'enum',
28
+ set: 'set',
29
+ address: 'address',
30
+ monetary: 'monetary',
31
+ deal: 'deal',
32
+ deals: 'deals',
33
+ lead: 'lead',
34
+ org: 'org',
35
+ people: 'people',
36
+ project: 'project',
37
+ stage: 'stage',
38
+ user: 'user',
39
+ activity: 'activity',
40
+ json: 'json',
41
+ picture: 'picture',
42
+ status: 'status',
43
+ visible_to: 'visible_to',
44
+ price_list: 'price_list',
45
+ billing_frequency: 'billing_frequency',
46
+ projects_board: 'projects_board',
47
+ projects_phase: 'projects_phase'
48
+ };
@@ -0,0 +1,35 @@
1
+ /**
2
+ * Pipedrive API v2
3
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { GetActivityFields200ResponseAdditionalData } from './get-activity-fields200-response-additional-data';
13
+ import { GetProductFields200ResponseDataInner } from './get-product-fields200-response-data-inner';
14
+ /**
15
+ *
16
+ * @export
17
+ * @interface GetProductFields200Response
18
+ */
19
+ export interface GetProductFields200Response {
20
+ /**
21
+ * Whether the request was successful
22
+ * @type {boolean}
23
+ */
24
+ 'success'?: boolean;
25
+ /**
26
+ *
27
+ * @type {Array<GetProductFields200ResponseDataInner>}
28
+ */
29
+ 'data'?: Array<GetProductFields200ResponseDataInner>;
30
+ /**
31
+ *
32
+ * @type {GetActivityFields200ResponseAdditionalData}
33
+ */
34
+ 'additional_data'?: GetActivityFields200ResponseAdditionalData;
35
+ }
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Pipedrive API v2
5
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6
+ *
7
+ * The version of the OpenAPI document: 2.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -105,5 +105,6 @@ export declare const GetProjectFields200ResponseDataInnerFieldTypeConst: {
105
105
  readonly billing_frequency: "billing_frequency";
106
106
  readonly projects_board: "projects_board";
107
107
  readonly projects_phase: "projects_phase";
108
+ readonly orgs: "orgs";
108
109
  };
109
110
  export type GetProjectFields200ResponseDataInnerFieldTypeConst = typeof GetProjectFields200ResponseDataInnerFieldTypeConst[keyof typeof GetProjectFields200ResponseDataInnerFieldTypeConst];
@@ -44,5 +44,6 @@ export const GetProjectFields200ResponseDataInnerFieldTypeConst = {
44
44
  price_list: 'price_list',
45
45
  billing_frequency: 'billing_frequency',
46
46
  projects_board: 'projects_board',
47
- projects_phase: 'projects_phase'
47
+ projects_phase: 'projects_phase',
48
+ orgs: 'orgs'
48
49
  };
@@ -44,6 +44,7 @@ export * from './add-person-field-request-ui-visibility';
44
44
  export * from './add-person-field-request-ui-visibility-show-in-add-deal-dialog';
45
45
  export * from './add-person-request';
46
46
  export * from './add-pipeline-request';
47
+ export * from './add-product-field200-response';
47
48
  export * from './add-product-field-request';
48
49
  export * from './add-product-field-request-ui-visibility';
49
50
  export * from './add-product-image-response';
@@ -202,6 +203,8 @@ export * from './get-persons-response-all-of';
202
203
  export * from './get-pipelines-response';
203
204
  export * from './get-pipelines-response-all-of';
204
205
  export * from './get-pipelines-response-all-of-data-inner';
206
+ export * from './get-product-fields200-response';
207
+ export * from './get-product-fields200-response-data-inner';
205
208
  export * from './get-product-image-response';
206
209
  export * from './get-product-image-response-data';
207
210
  export * from './get-product-response';
@@ -44,6 +44,7 @@ export * from './add-person-field-request-ui-visibility';
44
44
  export * from './add-person-field-request-ui-visibility-show-in-add-deal-dialog';
45
45
  export * from './add-person-request';
46
46
  export * from './add-pipeline-request';
47
+ export * from './add-product-field200-response';
47
48
  export * from './add-product-field-request';
48
49
  export * from './add-product-field-request-ui-visibility';
49
50
  export * from './add-product-image-response';
@@ -202,6 +203,8 @@ export * from './get-persons-response-all-of';
202
203
  export * from './get-pipelines-response';
203
204
  export * from './get-pipelines-response-all-of';
204
205
  export * from './get-pipelines-response-all-of-data-inner';
206
+ export * from './get-product-fields200-response';
207
+ export * from './get-product-fields200-response-data-inner';
205
208
  export * from './get-product-image-response';
206
209
  export * from './get-product-image-response-data';
207
210
  export * from './get-product-response';
@@ -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.
@@ -108,7 +108,7 @@ const DealFieldsApiAxiosParamCreator = function (configuration) {
108
108
  /**
109
109
  * Marks multiple deal fields as deleted.
110
110
  * @summary Delete multiple deal fields in bulk
111
- * @param {string} ids The comma-separated field IDs to delete
111
+ * @param {Set<number>} ids The comma-separated field IDs to delete
112
112
 
113
113
  * @throws {RequiredError}
114
114
  */
@@ -130,8 +130,8 @@ const DealFieldsApiAxiosParamCreator = function (configuration) {
130
130
  // authentication oauth2 required
131
131
  // oauth required
132
132
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["deal-fields:full", "admin"], configuration);
133
- if (ids !== undefined) {
134
- localVarQueryParameter['ids'] = ids;
133
+ if (ids) {
134
+ localVarQueryParameter['ids'] = Array.from(ids).join(base_1.COLLECTION_FORMATS.csv);
135
135
  }
136
136
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
137
137
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -289,7 +289,7 @@ const DealFieldsApiFp = function (configuration) {
289
289
  /**
290
290
  * Marks multiple deal fields as deleted.
291
291
  * @summary Delete multiple deal fields in bulk
292
- * @param {string} ids The comma-separated field IDs to delete
292
+ * @param {Set<number>} ids The comma-separated field IDs to delete
293
293
 
294
294
  * @throws {RequiredError}
295
295
  */
@@ -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.
@@ -685,7 +685,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
685
685
  * @param {number} [start] Pagination start
686
686
  * @param {number} [limit] Items shown per page
687
687
  * @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.
688
- * @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).
688
+ * @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).
689
689
 
690
690
  * @throws {RequiredError}
691
691
  */
@@ -717,8 +717,8 @@ const DealsApiAxiosParamCreator = function (configuration) {
717
717
  if (all_changes !== undefined) {
718
718
  localVarQueryParameter['all_changes'] = all_changes;
719
719
  }
720
- if (items !== undefined) {
721
- localVarQueryParameter['items'] = items;
720
+ if (items) {
721
+ localVarQueryParameter['items'] = Array.from(items).join(base_1.COLLECTION_FORMATS.csv);
722
722
  }
723
723
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
724
724
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -1163,7 +1163,7 @@ const DealsApiFp = function (configuration) {
1163
1163
  * @param {number} [start] Pagination start
1164
1164
  * @param {number} [limit] Items shown per page
1165
1165
  * @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.
1166
- * @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).
1166
+ * @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).
1167
1167
 
1168
1168
  * @throws {RequiredError}
1169
1169
  */
@@ -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.
@@ -112,7 +112,7 @@ const FiltersApiAxiosParamCreator = function (configuration) {
112
112
  /**
113
113
  * Marks multiple filters as deleted.
114
114
  * @summary Delete multiple filters in bulk
115
- * @param {string} ids The comma-separated filter IDs to delete
115
+ * @param {Set<number>} ids The comma-separated filter IDs to delete
116
116
 
117
117
  * @throws {RequiredError}
118
118
  */
@@ -134,8 +134,8 @@ const FiltersApiAxiosParamCreator = function (configuration) {
134
134
  // authentication oauth2 required
135
135
  // oauth required
136
136
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["deals:full", "activities:full", "contacts:full"], configuration);
137
- if (ids !== undefined) {
138
- localVarQueryParameter['ids'] = ids;
137
+ if (ids) {
138
+ localVarQueryParameter['ids'] = Array.from(ids).join(base_1.COLLECTION_FORMATS.csv);
139
139
  }
140
140
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
141
141
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -328,7 +328,7 @@ const FiltersApiFp = function (configuration) {
328
328
  /**
329
329
  * Marks multiple filters as deleted.
330
330
  * @summary Delete multiple filters in bulk
331
- * @param {string} ids The comma-separated filter IDs to delete
331
+ * @param {Set<number>} ids The comma-separated filter IDs to delete
332
332
 
333
333
  * @throws {RequiredError}
334
334
  */
@@ -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}
@@ -297,11 +297,11 @@ const LeadsApiAxiosParamCreator = function (configuration) {
297
297
  * 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.
298
298
  * @summary Search leads
299
299
  * @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.
300
- * @param {'custom_fields' | 'notes' | 'title'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
300
+ * @param {Set<'custom_fields' | 'notes' | 'title'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
301
301
  * @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.
302
302
  * @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
303
303
  * @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
304
- * @param {'lead.was_seen'} [include_fields] Supports including optional fields in the results which are not provided by default
304
+ * @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
305
305
  * @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.
306
306
  * @param {number} [limit] Items shown per page
307
307
 
@@ -328,8 +328,8 @@ const LeadsApiAxiosParamCreator = function (configuration) {
328
328
  if (term !== undefined) {
329
329
  localVarQueryParameter['term'] = term;
330
330
  }
331
- if (fields !== undefined) {
332
- localVarQueryParameter['fields'] = fields;
331
+ if (fields) {
332
+ localVarQueryParameter['fields'] = Array.from(fields).join(base_1.COLLECTION_FORMATS.csv);
333
333
  }
334
334
  if (exact_match !== undefined) {
335
335
  localVarQueryParameter['exact_match'] = exact_match;
@@ -340,8 +340,8 @@ const LeadsApiAxiosParamCreator = function (configuration) {
340
340
  if (organization_id !== undefined) {
341
341
  localVarQueryParameter['organization_id'] = organization_id;
342
342
  }
343
- if (include_fields !== undefined) {
344
- localVarQueryParameter['include_fields'] = include_fields;
343
+ if (include_fields) {
344
+ localVarQueryParameter['include_fields'] = Array.from(include_fields).join(base_1.COLLECTION_FORMATS.csv);
345
345
  }
346
346
  if (start !== undefined) {
347
347
  localVarQueryParameter['start'] = start;
@@ -499,11 +499,11 @@ const LeadsApiFp = function (configuration) {
499
499
  * 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.
500
500
  * @summary Search leads
501
501
  * @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.
502
- * @param {'custom_fields' | 'notes' | 'title'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
502
+ * @param {Set<'custom_fields' | 'notes' | 'title'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
503
503
  * @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.
504
504
  * @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
505
505
  * @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
506
- * @param {'lead.was_seen'} [include_fields] Supports including optional fields in the results which are not provided by default
506
+ * @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
507
507
  * @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.
508
508
  * @param {number} [limit] Items shown per page
509
509
 
@@ -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.