pipedrive 30.6.0 → 30.8.0

package/dist/esm/versions/v2/api/person-fields-api.js

@@ -0,0 +1,646 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Pipedrive API v2
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, BaseAPI } from '../base';
+/**
+ * PersonFieldsApi - axios parameter creator
+ * @export
+ */
+export const PersonFieldsApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Creates a new person custom field.
+         * @summary Create one person field
+         * @param {AddPersonFieldRequest} AddPersonFieldRequest
+
+         * @throws {RequiredError}
+         */
+        addPersonField: (AddPersonFieldRequest) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'AddPersonFieldRequest' is not null or undefined
+            assertParamExists('addPersonField', 'AddPersonFieldRequest', AddPersonFieldRequest);
+            const localVarPath = `/personFields`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign({ method: 'POST' }, baseOptions);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication api_key required
+            yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["admin", "contact-fields:full"], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            localVarRequestOptions.data = serializeDataIfNeeded(AddPersonFieldRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Adds new options to a person custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
+         * @summary Add person field options in bulk
+         * @param {string} field_code The unique code identifying the field
+         * @param {Array<AddDealFieldOptionsRequestInner>} AddDealFieldOptionsRequestInner
+
+         * @throws {RequiredError}
+         */
+        addPersonFieldOptions: (field_code, AddDealFieldOptionsRequestInner) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'field_code' is not null or undefined
+            assertParamExists('addPersonFieldOptions', 'field_code', field_code);
+            // verify required parameter 'AddDealFieldOptionsRequestInner' is not null or undefined
+            assertParamExists('addPersonFieldOptions', 'AddDealFieldOptionsRequestInner', AddDealFieldOptionsRequestInner);
+            const localVarPath = `/personFields/{field_code}/options`
+                .replace(`{${"field_code"}}`, encodeURIComponent(String(field_code)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign({ method: 'POST' }, baseOptions);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication api_key required
+            yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:full", "admin", "contact-fields:full"], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            localVarRequestOptions.data = serializeDataIfNeeded(AddDealFieldOptionsRequestInner, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Marks a custom field as deleted.
+         * @summary Delete one person field
+         * @param {string} field_code The unique code identifying the field
+
+         * @throws {RequiredError}
+         */
+        deletePersonField: (field_code) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'field_code' is not null or undefined
+            assertParamExists('deletePersonField', 'field_code', field_code);
+            const localVarPath = `/personFields/{field_code}`
+                .replace(`{${"field_code"}}`, encodeURIComponent(String(field_code)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign({ method: 'DELETE' }, baseOptions);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication api_key required
+            yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["admin", "contact-fields:full"], configuration);
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Removes existing options from a person custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
+         * @summary Delete person field options in bulk
+         * @param {string} field_code The unique code identifying the field
+         * @param {Array<DeleteDealFieldOptionsRequestInner>} DeleteDealFieldOptionsRequestInner
+
+         * @throws {RequiredError}
+         */
+        deletePersonFieldOptions: (field_code, DeleteDealFieldOptionsRequestInner) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'field_code' is not null or undefined
+            assertParamExists('deletePersonFieldOptions', 'field_code', field_code);
+            // verify required parameter 'DeleteDealFieldOptionsRequestInner' is not null or undefined
+            assertParamExists('deletePersonFieldOptions', 'DeleteDealFieldOptionsRequestInner', DeleteDealFieldOptionsRequestInner);
+            const localVarPath = `/personFields/{field_code}/options`
+                .replace(`{${"field_code"}}`, encodeURIComponent(String(field_code)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign({ method: 'DELETE' }, baseOptions);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication api_key required
+            yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:full", "admin", "contact-fields:full"], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            localVarRequestOptions.data = serializeDataIfNeeded(DeleteDealFieldOptionsRequestInner, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Returns metadata about a specific person field.
+         * @summary Get one person 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
+
+         * @throws {RequiredError}
+         */
+        getPersonField: (field_code, include_fields) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'field_code' is not null or undefined
+            assertParamExists('getPersonField', 'field_code', field_code);
+            const localVarPath = `/personFields/{field_code}`
+                .replace(`{${"field_code"}}`, encodeURIComponent(String(field_code)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication api_key required
+            yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full", "admin", "contact-fields:full"], configuration);
+            if (include_fields !== undefined) {
+                localVarQueryParameter['include_fields'] = include_fields;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Returns metadata about all person fields in the company.
+         * @summary Get all person 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 {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}
+         */
+        getPersonFields: (include_fields, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = `/personFields`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication api_key required
+            yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full", "admin", "contact-fields:full"], configuration);
+            if (include_fields !== undefined) {
+                localVarQueryParameter['include_fields'] = include_fields;
+            }
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+            if (cursor !== undefined) {
+                localVarQueryParameter['cursor'] = cursor;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Updates a person 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 person field
+         * @param {string} field_code The unique code identifying the field
+         * @param {UpdatePersonFieldRequest} UpdatePersonFieldRequest
+
+         * @throws {RequiredError}
+         */
+        updatePersonField: (field_code, UpdatePersonFieldRequest) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'field_code' is not null or undefined
+            assertParamExists('updatePersonField', 'field_code', field_code);
+            // verify required parameter 'UpdatePersonFieldRequest' is not null or undefined
+            assertParamExists('updatePersonField', 'UpdatePersonFieldRequest', UpdatePersonFieldRequest);
+            const localVarPath = `/personFields/{field_code}`
+                .replace(`{${"field_code"}}`, encodeURIComponent(String(field_code)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign({ method: 'PATCH' }, baseOptions);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication api_key required
+            yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:full", "admin", "contact-fields:full"], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            localVarRequestOptions.data = serializeDataIfNeeded(UpdatePersonFieldRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Updates existing options for a person custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
+         * @summary Update person field options in bulk
+         * @param {string} field_code The unique code identifying the field
+         * @param {Array<UpdateDealFieldOptionsRequestInner>} UpdateDealFieldOptionsRequestInner
+
+         * @throws {RequiredError}
+         */
+        updatePersonFieldOptions: (field_code, UpdateDealFieldOptionsRequestInner) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'field_code' is not null or undefined
+            assertParamExists('updatePersonFieldOptions', 'field_code', field_code);
+            // verify required parameter 'UpdateDealFieldOptionsRequestInner' is not null or undefined
+            assertParamExists('updatePersonFieldOptions', 'UpdateDealFieldOptionsRequestInner', UpdateDealFieldOptionsRequestInner);
+            const localVarPath = `/personFields/{field_code}/options`
+                .replace(`{${"field_code"}}`, encodeURIComponent(String(field_code)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign({ method: 'PATCH' }, baseOptions);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication api_key required
+            yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:full", "admin", "contact-fields:full"], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            localVarRequestOptions.data = serializeDataIfNeeded(UpdateDealFieldOptionsRequestInner, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * PersonFieldsApi - functional programming interface
+ * @export
+ */
+export const PersonFieldsApiFp = function (configuration) {
+    const localVarAxiosParamCreator = PersonFieldsApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Creates a new person custom field.
+         * @summary Create one person field
+         * @param {AddPersonFieldRequest} AddPersonFieldRequest
+
+         * @throws {RequiredError}
+         */
+        addPersonField(AddPersonFieldRequest) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.addPersonField(AddPersonFieldRequest);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Adds new options to a person custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
+         * @summary Add person field options in bulk
+         * @param {string} field_code The unique code identifying the field
+         * @param {Array<AddDealFieldOptionsRequestInner>} AddDealFieldOptionsRequestInner
+
+         * @throws {RequiredError}
+         */
+        addPersonFieldOptions(field_code, AddDealFieldOptionsRequestInner) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.addPersonFieldOptions(field_code, AddDealFieldOptionsRequestInner);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Marks a custom field as deleted.
+         * @summary Delete one person field
+         * @param {string} field_code The unique code identifying the field
+
+         * @throws {RequiredError}
+         */
+        deletePersonField(field_code) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deletePersonField(field_code);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Removes existing options from a person custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
+         * @summary Delete person field options in bulk
+         * @param {string} field_code The unique code identifying the field
+         * @param {Array<DeleteDealFieldOptionsRequestInner>} DeleteDealFieldOptionsRequestInner
+
+         * @throws {RequiredError}
+         */
+        deletePersonFieldOptions(field_code, DeleteDealFieldOptionsRequestInner) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deletePersonFieldOptions(field_code, DeleteDealFieldOptionsRequestInner);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Returns metadata about a specific person field.
+         * @summary Get one person 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
+
+         * @throws {RequiredError}
+         */
+        getPersonField(field_code, include_fields) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getPersonField(field_code, include_fields);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Returns metadata about all person fields in the company.
+         * @summary Get all person 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 {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}
+         */
+        getPersonFields(include_fields, limit, cursor) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getPersonFields(include_fields, limit, cursor);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Updates a person 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 person field
+         * @param {string} field_code The unique code identifying the field
+         * @param {UpdatePersonFieldRequest} UpdatePersonFieldRequest
+
+         * @throws {RequiredError}
+         */
+        updatePersonField(field_code, UpdatePersonFieldRequest) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.updatePersonField(field_code, UpdatePersonFieldRequest);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Updates existing options for a person custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
+         * @summary Update person field options in bulk
+         * @param {string} field_code The unique code identifying the field
+         * @param {Array<UpdateDealFieldOptionsRequestInner>} UpdateDealFieldOptionsRequestInner
+
+         * @throws {RequiredError}
+         */
+        updatePersonFieldOptions(field_code, UpdateDealFieldOptionsRequestInner) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.updatePersonFieldOptions(field_code, UpdateDealFieldOptionsRequestInner);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+    };
+};
+/**
+ * PersonFieldsApi - factory interface
+ * @export
+ */
+export const PersonFieldsApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = PersonFieldsApiFp(configuration);
+    return {
+        /**
+         * Creates a new person custom field.
+         * @summary Create one person field
+         * @param {PersonFieldsApiAddPersonFieldRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        addPersonField(requestParameters) {
+            return localVarFp.addPersonField(requestParameters.AddPersonFieldRequest).then((request) => request(axios, basePath));
+        },
+        /**
+         * Adds new options to a person custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
+         * @summary Add person field options in bulk
+         * @param {PersonFieldsApiAddPersonFieldOptionsRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        addPersonFieldOptions(requestParameters) {
+            return localVarFp.addPersonFieldOptions(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
+        },
+        /**
+         * Marks a custom field as deleted.
+         * @summary Delete one person field
+         * @param {PersonFieldsApiDeletePersonFieldRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        deletePersonField(requestParameters) {
+            return localVarFp.deletePersonField(requestParameters.field_code).then((request) => request(axios, basePath));
+        },
+        /**
+         * Removes existing options from a person custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
+         * @summary Delete person field options in bulk
+         * @param {PersonFieldsApiDeletePersonFieldOptionsRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        deletePersonFieldOptions(requestParameters) {
+            return localVarFp.deletePersonFieldOptions(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
+        },
+        /**
+         * Returns metadata about a specific person field.
+         * @summary Get one person field
+         * @param {PersonFieldsApiGetPersonFieldRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getPersonField(requestParameters) {
+            return localVarFp.getPersonField(requestParameters.field_code, requestParameters.include_fields).then((request) => request(axios, basePath));
+        },
+        /**
+         * Returns metadata about all person fields in the company.
+         * @summary Get all person fields
+         * @param {PersonFieldsApiGetPersonFieldsRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getPersonFields(requestParameters = {}) {
+            return localVarFp.getPersonFields(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
+        },
+        /**
+         * Updates a person 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 person field
+         * @param {PersonFieldsApiUpdatePersonFieldRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        updatePersonField(requestParameters) {
+            return localVarFp.updatePersonField(requestParameters.field_code, requestParameters.UpdatePersonFieldRequest).then((request) => request(axios, basePath));
+        },
+        /**
+         * Updates existing options for a person custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
+         * @summary Update person field options in bulk
+         * @param {PersonFieldsApiUpdatePersonFieldOptionsRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        updatePersonFieldOptions(requestParameters) {
+            return localVarFp.updatePersonFieldOptions(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * PersonFieldsApi - object-oriented interface
+ * @export
+ * @class PersonFieldsApi
+ * @extends {BaseAPI}
+ */
+export class PersonFieldsApi extends BaseAPI {
+    /**
+     * Creates a new person custom field.
+     * @summary Create one person field
+     * @param {PersonFieldsApiAddPersonFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonFieldsApi
+     */
+    addPersonField(requestParameters) {
+        return PersonFieldsApiFp(this.configuration).addPersonField(requestParameters.AddPersonFieldRequest).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Adds new options to a person custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
+     * @summary Add person field options in bulk
+     * @param {PersonFieldsApiAddPersonFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonFieldsApi
+     */
+    addPersonFieldOptions(requestParameters) {
+        return PersonFieldsApiFp(this.configuration).addPersonFieldOptions(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Marks a custom field as deleted.
+     * @summary Delete one person field
+     * @param {PersonFieldsApiDeletePersonFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonFieldsApi
+     */
+    deletePersonField(requestParameters) {
+        return PersonFieldsApiFp(this.configuration).deletePersonField(requestParameters.field_code).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Removes existing options from a person custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
+     * @summary Delete person field options in bulk
+     * @param {PersonFieldsApiDeletePersonFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonFieldsApi
+     */
+    deletePersonFieldOptions(requestParameters) {
+        return PersonFieldsApiFp(this.configuration).deletePersonFieldOptions(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Returns metadata about a specific person field.
+     * @summary Get one person field
+     * @param {PersonFieldsApiGetPersonFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonFieldsApi
+     */
+    getPersonField(requestParameters) {
+        return PersonFieldsApiFp(this.configuration).getPersonField(requestParameters.field_code, requestParameters.include_fields).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Returns metadata about all person fields in the company.
+     * @summary Get all person fields
+     * @param {PersonFieldsApiGetPersonFieldsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonFieldsApi
+     */
+    getPersonFields(requestParameters = {}) {
+        return PersonFieldsApiFp(this.configuration).getPersonFields(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Updates a person 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 person field
+     * @param {PersonFieldsApiUpdatePersonFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonFieldsApi
+     */
+    updatePersonField(requestParameters) {
+        return PersonFieldsApiFp(this.configuration).updatePersonField(requestParameters.field_code, requestParameters.UpdatePersonFieldRequest).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Updates existing options for a person custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
+     * @summary Update person field options in bulk
+     * @param {PersonFieldsApiUpdatePersonFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonFieldsApi
+     */
+    updatePersonFieldOptions(requestParameters) {
+        return PersonFieldsApiFp(this.configuration).updatePersonFieldOptions(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
+    }
+}