pipedrive 33.9.0 → 34.0.0

package/dist/esm/versions/v2/api/products-api.js

@@ -25,7 +25,7 @@ import globalAxios from 'axios';
 // @ts-ignore
 import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
 // @ts-ignore
-import { BASE_PATH, BaseAPI } from '../base';
+import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from '../base';
 /**
  * ProductsApi - axios parameter creator
  * @export
@@ -515,18 +515,18 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
          * Returns data about all products.
          * @summary Get all products
          * @param {number} [owner_id] If supplied, only products owned by the given user will be returned
-         * @param {string} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
+         * @param {Set<string>} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
+         * @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
          * @param {number} [filter_id] The ID of the filter to use
          * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
          * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
          * @param {'id' | 'name' | 'add_time' | 'update_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;name&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
          * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
          * @param {string} [updated_since] If set, only products with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
-         * @param {string} [custom_fields] Comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for a smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
 
          * @throws {RequiredError}
          */
-        getProducts: (owner_id, ids, filter_id, cursor, limit, sort_by, sort_direction, updated_since, custom_fields) => __awaiter(this, void 0, void 0, function* () {
+        getProducts: (owner_id, ids, custom_fields, filter_id, cursor, limit, sort_by, sort_direction, updated_since) => __awaiter(this, void 0, void 0, function* () {
             const localVarPath = `/products`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -545,8 +545,11 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
             if (owner_id !== undefined) {
                 localVarQueryParameter['owner_id'] = owner_id;
             }
-            if (ids !== undefined) {
-                localVarQueryParameter['ids'] = ids;
+            if (ids) {
+                localVarQueryParameter['ids'] = Array.from(ids).join(COLLECTION_FORMATS.csv);
+            }
+            if (custom_fields) {
+                localVarQueryParameter['custom_fields'] = Array.from(custom_fields).join(COLLECTION_FORMATS.csv);
             }
             if (filter_id !== undefined) {
                 localVarQueryParameter['filter_id'] = filter_id;
@@ -566,9 +569,6 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
             if (updated_since !== undefined) {
                 localVarQueryParameter['updated_since'] = updated_since;
             }
-            if (custom_fields !== undefined) {
-                localVarQueryParameter['custom_fields'] = custom_fields;
-            }
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
@@ -989,20 +989,20 @@ export const ProductsApiFp = function (configuration) {
          * Returns data about all products.
          * @summary Get all products
          * @param {number} [owner_id] If supplied, only products owned by the given user will be returned
-         * @param {string} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
+         * @param {Set<string>} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
+         * @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
          * @param {number} [filter_id] The ID of the filter to use
          * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
          * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
          * @param {'id' | 'name' | 'add_time' | 'update_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;name&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
          * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
          * @param {string} [updated_since] If set, only products with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
-         * @param {string} [custom_fields] Comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for a smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
 
          * @throws {RequiredError}
          */
-        getProducts(owner_id, ids, filter_id, cursor, limit, sort_by, sort_direction, updated_since, custom_fields) {
+        getProducts(owner_id, ids, custom_fields, filter_id, cursor, limit, sort_by, sort_direction, updated_since) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getProducts(owner_id, ids, filter_id, cursor, limit, sort_by, sort_direction, updated_since, custom_fields);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getProducts(owner_id, ids, custom_fields, filter_id, cursor, limit, sort_by, sort_direction, updated_since);
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
@@ -1228,7 +1228,7 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         getProducts(requestParameters = {}) {
-            return localVarFp.getProducts(requestParameters.owner_id, requestParameters.ids, requestParameters.filter_id, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.updated_since, requestParameters.custom_fields).then((request) => request(axios, basePath));
+            return localVarFp.getProducts(requestParameters.owner_id, requestParameters.ids, requestParameters.custom_fields, requestParameters.filter_id, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.updated_since).then((request) => request(axios, basePath));
         },
         /**
          * Searches all products by name, code and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope.
@@ -1441,7 +1441,7 @@ export class ProductsApi extends BaseAPI {
      * @memberof ProductsApi
      */
     getProducts(requestParameters = {}) {
-        return ProductsApiFp(this.configuration).getProducts(requestParameters.owner_id, requestParameters.ids, requestParameters.filter_id, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.updated_since, requestParameters.custom_fields).then((request) => request(this.axios, this.basePath));
+        return ProductsApiFp(this.configuration).getProducts(requestParameters.owner_id, requestParameters.ids, requestParameters.custom_fields, requestParameters.filter_id, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.updated_since).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Searches all products by name, code and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope.

package/dist/versions/v2/api/activities-api.d.ts

@@ -41,7 +41,7 @@ export declare const ActivitiesApiAxiosParamCreator: (configuration?: Configurat
      * Returns data about all activities.
      * @summary Get all activities
      * @param {number} [filter_id] If supplied, only activities matching the specified filter are returned
-     * @param {string} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
+     * @param {Set<string>} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
      * @param {number} [owner_id] If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
      * @param {number} [deal_id] If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
      * @param {string} [lead_id] If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
@@ -52,22 +52,22 @@ export declare const ActivitiesApiAxiosParamCreator: (configuration?: Configurat
      * @param {string} [updated_until] If set, only activities with an &#x60;update_time&#x60; earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
      * @param {'id' | 'update_time' | 'add_time' | 'due_date'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;, &#x60;due_date&#x60;.
      * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
-     * @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
+     * @param {Set<'attendees'>} [include_fields] Optional comma separated string array of additional fields to include
      * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
      * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
 
      * @throws {RequiredError}
      */
-    getActivities: (filter_id?: number, ids?: string, owner_id?: number, deal_id?: number, lead_id?: string, person_id?: number, org_id?: number, done?: boolean, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time' | 'due_date', sort_direction?: 'asc' | 'desc', include_fields?: 'attendees', limit?: number, cursor?: string) => Promise<RequestArgs>;
+    getActivities: (filter_id?: number, ids?: Set<string>, owner_id?: number, deal_id?: number, lead_id?: string, person_id?: number, org_id?: number, done?: boolean, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time' | 'due_date', sort_direction?: 'asc' | 'desc', include_fields?: Set<'attendees'>, limit?: number, cursor?: string) => Promise<RequestArgs>;
     /**
      * Returns the details of a specific activity.
      * @summary Get details of an activity
      * @param {number} id The ID of the activity
-     * @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
+     * @param {Set<'attendees'>} [include_fields] Optional comma separated string array of additional fields to include
 
      * @throws {RequiredError}
      */
-    getActivity: (id: number, include_fields?: 'attendees') => Promise<RequestArgs>;
+    getActivity: (id: number, include_fields?: Set<'attendees'>) => Promise<RequestArgs>;
     /**
      * Updates the properties of an activity.
      * @summary Update an activity
@@ -103,7 +103,7 @@ export declare const ActivitiesApiFp: (configuration?: Configuration) => {
      * Returns data about all activities.
      * @summary Get all activities
      * @param {number} [filter_id] If supplied, only activities matching the specified filter are returned
-     * @param {string} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
+     * @param {Set<string>} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
      * @param {number} [owner_id] If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
      * @param {number} [deal_id] If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
      * @param {string} [lead_id] If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
@@ -114,22 +114,22 @@ export declare const ActivitiesApiFp: (configuration?: Configuration) => {
      * @param {string} [updated_until] If set, only activities with an &#x60;update_time&#x60; earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
      * @param {'id' | 'update_time' | 'add_time' | 'due_date'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;, &#x60;due_date&#x60;.
      * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
-     * @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
+     * @param {Set<'attendees'>} [include_fields] Optional comma separated string array of additional fields to include
      * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
      * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
 
      * @throws {RequiredError}
      */
-    getActivities(filter_id?: number, ids?: string, owner_id?: number, deal_id?: number, lead_id?: string, person_id?: number, org_id?: number, done?: boolean, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time' | 'due_date', sort_direction?: 'asc' | 'desc', include_fields?: 'attendees', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivitiesResponse>>;
+    getActivities(filter_id?: number, ids?: Set<string>, owner_id?: number, deal_id?: number, lead_id?: string, person_id?: number, org_id?: number, done?: boolean, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time' | 'due_date', sort_direction?: 'asc' | 'desc', include_fields?: Set<'attendees'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivitiesResponse>>;
     /**
      * Returns the details of a specific activity.
      * @summary Get details of an activity
      * @param {number} id The ID of the activity
-     * @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
+     * @param {Set<'attendees'>} [include_fields] Optional comma separated string array of additional fields to include
 
      * @throws {RequiredError}
      */
-    getActivity(id: number, include_fields?: 'attendees'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertActivityResponse>>;
+    getActivity(id: number, include_fields?: Set<'attendees'>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertActivityResponse>>;
     /**
      * Updates the properties of an activity.
      * @summary Update an activity
@@ -226,10 +226,10 @@ export interface ActivitiesApiGetActivitiesRequest {
     readonly filter_id?: number;
     /**
      * Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
-     * @type {string}
+     * @type {Set<string>}
      * @memberof ActivitiesApiGetActivities
      */
-    readonly ids?: string;
+    readonly ids?: Set<string>;
     /**
      * If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
      * @type {number}
@@ -292,10 +292,10 @@ export interface ActivitiesApiGetActivitiesRequest {
     readonly sort_direction?: 'asc' | 'desc';
     /**
      * Optional comma separated string array of additional fields to include
-     * @type {'attendees'}
+     * @type {Set<'attendees'>}
      * @memberof ActivitiesApiGetActivities
      */
-    readonly include_fields?: 'attendees';
+    readonly include_fields?: Set<'attendees'>;
     /**
      * For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
      * @type {number}
@@ -323,10 +323,10 @@ export interface ActivitiesApiGetActivityRequest {
     readonly id: number;
     /**
      * Optional comma separated string array of additional fields to include
-     * @type {'attendees'}
+     * @type {Set<'attendees'>}
      * @memberof ActivitiesApiGetActivity
      */
-    readonly include_fields?: 'attendees';
+    readonly include_fields?: Set<'attendees'>;
 }
 /**
  * Request parameters for updateActivity operation in ActivitiesApi.

package/dist/versions/v2/api/activities-api.js

@@ -109,7 +109,7 @@ const ActivitiesApiAxiosParamCreator = function (configuration) {
          * Returns data about all activities.
          * @summary Get all activities
          * @param {number} [filter_id] If supplied, only activities matching the specified filter are returned
-         * @param {string} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
+         * @param {Set<string>} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
          * @param {number} [owner_id] If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
          * @param {number} [deal_id] If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
          * @param {string} [lead_id] If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
@@ -120,7 +120,7 @@ const ActivitiesApiAxiosParamCreator = function (configuration) {
          * @param {string} [updated_until] If set, only activities with an &#x60;update_time&#x60; earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
          * @param {'id' | 'update_time' | 'add_time' | 'due_date'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;, &#x60;due_date&#x60;.
          * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
-         * @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
+         * @param {Set<'attendees'>} [include_fields] Optional comma separated string array of additional fields to include
          * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
          * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
 
@@ -145,8 +145,8 @@ const ActivitiesApiAxiosParamCreator = function (configuration) {
             if (filter_id !== undefined) {
                 localVarQueryParameter['filter_id'] = filter_id;
             }
-            if (ids !== undefined) {
-                localVarQueryParameter['ids'] = ids;
+            if (ids) {
+                localVarQueryParameter['ids'] = Array.from(ids).join(base_1.COLLECTION_FORMATS.csv);
             }
             if (owner_id !== undefined) {
                 localVarQueryParameter['owner_id'] = owner_id;
@@ -178,8 +178,8 @@ const ActivitiesApiAxiosParamCreator = function (configuration) {
             if (sort_direction !== undefined) {
                 localVarQueryParameter['sort_direction'] = sort_direction;
             }
-            if (include_fields !== undefined) {
-                localVarQueryParameter['include_fields'] = include_fields;
+            if (include_fields) {
+                localVarQueryParameter['include_fields'] = Array.from(include_fields).join(base_1.COLLECTION_FORMATS.csv);
             }
             if (limit !== undefined) {
                 localVarQueryParameter['limit'] = limit;
@@ -199,7 +199,7 @@ const ActivitiesApiAxiosParamCreator = function (configuration) {
          * Returns the details of a specific activity.
          * @summary Get details of an activity
          * @param {number} id The ID of the activity
-         * @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
+         * @param {Set<'attendees'>} [include_fields] Optional comma separated string array of additional fields to include
 
          * @throws {RequiredError}
          */
@@ -222,8 +222,8 @@ const ActivitiesApiAxiosParamCreator = function (configuration) {
             // authentication oauth2 required
             // oauth required
             yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["activities:read", "activities:full"], configuration);
-            if (include_fields !== undefined) {
-                localVarQueryParameter['include_fields'] = include_fields;
+            if (include_fields) {
+                localVarQueryParameter['include_fields'] = Array.from(include_fields).join(base_1.COLLECTION_FORMATS.csv);
             }
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -310,7 +310,7 @@ const ActivitiesApiFp = function (configuration) {
          * Returns data about all activities.
          * @summary Get all activities
          * @param {number} [filter_id] If supplied, only activities matching the specified filter are returned
-         * @param {string} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
+         * @param {Set<string>} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
          * @param {number} [owner_id] If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
          * @param {number} [deal_id] If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
          * @param {string} [lead_id] If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
@@ -321,7 +321,7 @@ const ActivitiesApiFp = function (configuration) {
          * @param {string} [updated_until] If set, only activities with an &#x60;update_time&#x60; earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
          * @param {'id' | 'update_time' | 'add_time' | 'due_date'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;, &#x60;due_date&#x60;.
          * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
-         * @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
+         * @param {Set<'attendees'>} [include_fields] Optional comma separated string array of additional fields to include
          * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
          * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
 
@@ -337,7 +337,7 @@ const ActivitiesApiFp = function (configuration) {
          * Returns the details of a specific activity.
          * @summary Get details of an activity
          * @param {number} id The ID of the activity
-         * @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
+         * @param {Set<'attendees'>} [include_fields] Optional comma separated string array of additional fields to include
 
          * @throws {RequiredError}
          */

package/dist/versions/v2/api/activity-fields-api.d.ts

@@ -23,21 +23,21 @@ export declare const ActivityFieldsApiAxiosParamCreator: (configuration?: Config
      * Returns metadata about a specific activity field.
      * @summary Get one activity field
      * @param {string} field_code The unique code identifying the field
-     * @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+     * @param {Set<'ui_visibility'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
 
      * @throws {RequiredError}
      */
-    getActivityField: (field_code: string, include_fields?: 'ui_visibility') => Promise<RequestArgs>;
+    getActivityField: (field_code: string, include_fields?: Set<'ui_visibility'>) => Promise<RequestArgs>;
     /**
      * Returns metadata about all activity fields in the company.
      * @summary Get all activity fields
-     * @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+     * @param {Set<'ui_visibility'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
      * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
      * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
 
      * @throws {RequiredError}
      */
-    getActivityFields: (include_fields?: 'ui_visibility', limit?: number, cursor?: string) => Promise<RequestArgs>;
+    getActivityFields: (include_fields?: Set<'ui_visibility'>, limit?: number, cursor?: string) => Promise<RequestArgs>;
 };
 /**
  * ActivityFieldsApi - functional programming interface
@@ -48,21 +48,21 @@ export declare const ActivityFieldsApiFp: (configuration?: Configuration) => {
      * Returns metadata about a specific activity field.
      * @summary Get one activity field
      * @param {string} field_code The unique code identifying the field
-     * @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+     * @param {Set<'ui_visibility'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
 
      * @throws {RequiredError}
      */
-    getActivityField(field_code: string, include_fields?: 'ui_visibility'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivityField200Response>>;
+    getActivityField(field_code: string, include_fields?: Set<'ui_visibility'>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivityField200Response>>;
     /**
      * Returns metadata about all activity fields in the company.
      * @summary Get all activity fields
-     * @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+     * @param {Set<'ui_visibility'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
      * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
      * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
 
      * @throws {RequiredError}
      */
-    getActivityFields(include_fields?: 'ui_visibility', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivityFields200Response>>;
+    getActivityFields(include_fields?: Set<'ui_visibility'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivityFields200Response>>;
 };
 /**
  * ActivityFieldsApi - factory interface
@@ -100,10 +100,10 @@ export interface ActivityFieldsApiGetActivityFieldRequest {
     readonly field_code: string;
     /**
      * Optional comma separated string array of additional data namespaces to include in response
-     * @type {'ui_visibility'}
+     * @type {Set<'ui_visibility'>}
      * @memberof ActivityFieldsApiGetActivityField
      */
-    readonly include_fields?: 'ui_visibility';
+    readonly include_fields?: Set<'ui_visibility'>;
 }
 /**
  * Request parameters for getActivityFields operation in ActivityFieldsApi.
@@ -113,10 +113,10 @@ export interface ActivityFieldsApiGetActivityFieldRequest {
 export interface ActivityFieldsApiGetActivityFieldsRequest {
     /**
      * Optional comma separated string array of additional data namespaces to include in response
-     * @type {'ui_visibility'}
+     * @type {Set<'ui_visibility'>}
      * @memberof ActivityFieldsApiGetActivityFields
      */
-    readonly include_fields?: 'ui_visibility';
+    readonly include_fields?: Set<'ui_visibility'>;
     /**
      * For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
      * @type {number}

package/dist/versions/v2/api/activity-fields-api.js

@@ -42,7 +42,7 @@ const ActivityFieldsApiAxiosParamCreator = function (configuration) {
          * Returns metadata about a specific activity field.
          * @summary Get one activity field
          * @param {string} field_code The unique code identifying the field
-         * @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+         * @param {Set<'ui_visibility'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
 
          * @throws {RequiredError}
          */
@@ -65,8 +65,8 @@ const ActivityFieldsApiAxiosParamCreator = function (configuration) {
             // authentication oauth2 required
             // oauth required
             yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["admin"], configuration);
-            if (include_fields !== undefined) {
-                localVarQueryParameter['include_fields'] = include_fields;
+            if (include_fields) {
+                localVarQueryParameter['include_fields'] = Array.from(include_fields).join(base_1.COLLECTION_FORMATS.csv);
             }
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -79,7 +79,7 @@ const ActivityFieldsApiAxiosParamCreator = function (configuration) {
         /**
          * Returns metadata about all activity fields in the company.
          * @summary Get all activity fields
-         * @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+         * @param {Set<'ui_visibility'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
          * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
          * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
 
@@ -101,8 +101,8 @@ const ActivityFieldsApiAxiosParamCreator = function (configuration) {
             // authentication oauth2 required
             // oauth required
             yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["admin"], configuration);
-            if (include_fields !== undefined) {
-                localVarQueryParameter['include_fields'] = include_fields;
+            if (include_fields) {
+                localVarQueryParameter['include_fields'] = Array.from(include_fields).join(base_1.COLLECTION_FORMATS.csv);
             }
             if (limit !== undefined) {
                 localVarQueryParameter['limit'] = limit;
@@ -132,7 +132,7 @@ const ActivityFieldsApiFp = function (configuration) {
          * Returns metadata about a specific activity field.
          * @summary Get one activity field
          * @param {string} field_code The unique code identifying the field
-         * @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+         * @param {Set<'ui_visibility'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
 
          * @throws {RequiredError}
          */
@@ -145,7 +145,7 @@ const ActivityFieldsApiFp = function (configuration) {
         /**
          * Returns metadata about all activity fields in the company.
          * @summary Get all activity fields
-         * @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+         * @param {Set<'ui_visibility'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
          * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
          * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
 

package/dist/versions/v2/api/deal-fields-api.d.ts

@@ -64,21 +64,21 @@ export declare const DealFieldsApiAxiosParamCreator: (configuration?: Configurat
      * Returns metadata about a specific deal field.
      * @summary Get one deal field
      * @param {string} field_code The unique code identifying the field
-     * @param {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+     * @param {Set<'ui_visibility' | 'important_fields' | 'required_fields'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
 
      * @throws {RequiredError}
      */
-    getDealField: (field_code: string, include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields') => Promise<RequestArgs>;
+    getDealField: (field_code: string, include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>) => Promise<RequestArgs>;
     /**
      * Returns metadata about all deal fields in the company.
      * @summary Get all deal fields
-     * @param {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+     * @param {Set<'ui_visibility' | 'important_fields' | 'required_fields'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
      * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
      * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
 
      * @throws {RequiredError}
      */
-    getDealFields: (include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields', limit?: number, cursor?: string) => Promise<RequestArgs>;
+    getDealFields: (include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>, limit?: number, cursor?: string) => Promise<RequestArgs>;
     /**
      * Updates a deal custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
      * @summary Update one deal field
@@ -141,21 +141,21 @@ export declare const DealFieldsApiFp: (configuration?: Configuration) => {
      * Returns metadata about a specific deal field.
      * @summary Get one deal field
      * @param {string} field_code The unique code identifying the field
-     * @param {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+     * @param {Set<'ui_visibility' | 'important_fields' | 'required_fields'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
 
      * @throws {RequiredError}
      */
-    getDealField(field_code: string, include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealField200Response>>;
+    getDealField(field_code: string, include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealField200Response>>;
     /**
      * Returns metadata about all deal fields in the company.
      * @summary Get all deal fields
-     * @param {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+     * @param {Set<'ui_visibility' | 'important_fields' | 'required_fields'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
      * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
      * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
 
      * @throws {RequiredError}
      */
-    getDealFields(include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealFields200Response>>;
+    getDealFields(include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealFields200Response>>;
     /**
      * Updates a deal custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
      * @summary Update one deal field
@@ -323,10 +323,10 @@ export interface DealFieldsApiGetDealFieldRequest {
     readonly field_code: string;
     /**
      * Optional comma separated string array of additional data namespaces to include in response
-     * @type {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'}
+     * @type {Set<'ui_visibility' | 'important_fields' | 'required_fields'>}
      * @memberof DealFieldsApiGetDealField
      */
-    readonly include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields';
+    readonly include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>;
 }
 /**
  * Request parameters for getDealFields operation in DealFieldsApi.
@@ -336,10 +336,10 @@ export interface DealFieldsApiGetDealFieldRequest {
 export interface DealFieldsApiGetDealFieldsRequest {
     /**
      * Optional comma separated string array of additional data namespaces to include in response
-     * @type {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'}
+     * @type {Set<'ui_visibility' | 'important_fields' | 'required_fields'>}
      * @memberof DealFieldsApiGetDealFields
      */
-    readonly include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields';
+    readonly include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>;
     /**
      * For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
      * @type {number}

package/dist/versions/v2/api/deal-fields-api.js

@@ -189,7 +189,7 @@ const DealFieldsApiAxiosParamCreator = function (configuration) {
          * Returns metadata about a specific deal field.
          * @summary Get one deal field
          * @param {string} field_code The unique code identifying the field
-         * @param {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+         * @param {Set<'ui_visibility' | 'important_fields' | 'required_fields'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
 
          * @throws {RequiredError}
          */
@@ -212,8 +212,8 @@ const DealFieldsApiAxiosParamCreator = function (configuration) {
             // authentication oauth2 required
             // oauth required
             yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full", "admin", "deal-fields:full"], configuration);
-            if (include_fields !== undefined) {
-                localVarQueryParameter['include_fields'] = include_fields;
+            if (include_fields) {
+                localVarQueryParameter['include_fields'] = Array.from(include_fields).join(base_1.COLLECTION_FORMATS.csv);
             }
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -226,7 +226,7 @@ const DealFieldsApiAxiosParamCreator = function (configuration) {
         /**
          * Returns metadata about all deal fields in the company.
          * @summary Get all deal fields
-         * @param {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+         * @param {Set<'ui_visibility' | 'important_fields' | 'required_fields'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
          * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
          * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
 
@@ -248,8 +248,8 @@ const DealFieldsApiAxiosParamCreator = function (configuration) {
             // authentication oauth2 required
             // oauth required
             yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full", "admin", "deal-fields:full"], configuration);
-            if (include_fields !== undefined) {
-                localVarQueryParameter['include_fields'] = include_fields;
+            if (include_fields) {
+                localVarQueryParameter['include_fields'] = Array.from(include_fields).join(base_1.COLLECTION_FORMATS.csv);
             }
             if (limit !== undefined) {
                 localVarQueryParameter['limit'] = limit;
@@ -411,7 +411,7 @@ const DealFieldsApiFp = function (configuration) {
          * Returns metadata about a specific deal field.
          * @summary Get one deal field
          * @param {string} field_code The unique code identifying the field
-         * @param {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+         * @param {Set<'ui_visibility' | 'important_fields' | 'required_fields'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
 
          * @throws {RequiredError}
          */
@@ -424,7 +424,7 @@ const DealFieldsApiFp = function (configuration) {
         /**
          * Returns metadata about all deal fields in the company.
          * @summary Get all deal fields
-         * @param {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+         * @param {Set<'ui_visibility' | 'important_fields' | 'required_fields'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
          * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
          * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page