pipedrive 30.6.0 → 30.8.0

package/dist/esm/versions/v2/api/deal-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';
+/**
+ * DealFieldsApi - axios parameter creator
+ * @export
+ */
+export const DealFieldsApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Creates a new deal custom field.
+         * @summary Create one deal field
+         * @param {AddDealFieldRequest} AddDealFieldRequest
+
+         * @throws {RequiredError}
+         */
+        addDealField: (AddDealFieldRequest) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'AddDealFieldRequest' is not null or undefined
+            assertParamExists('addDealField', 'AddDealFieldRequest', AddDealFieldRequest);
+            const localVarPath = `/dealFields`;
+            // 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", "deal-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(AddDealFieldRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Adds new options to a deal 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 deal field options in bulk
+         * @param {string} field_code The unique code identifying the field
+         * @param {Array<AddDealFieldOptionsRequestInner>} AddDealFieldOptionsRequestInner
+
+         * @throws {RequiredError}
+         */
+        addDealFieldOptions: (field_code, AddDealFieldOptionsRequestInner) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'field_code' is not null or undefined
+            assertParamExists('addDealFieldOptions', 'field_code', field_code);
+            // verify required parameter 'AddDealFieldOptionsRequestInner' is not null or undefined
+            assertParamExists('addDealFieldOptions', 'AddDealFieldOptionsRequestInner', AddDealFieldOptionsRequestInner);
+            const localVarPath = `/dealFields/{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", ["deals:full", "admin", "deal-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 deal field
+         * @param {string} field_code The unique code identifying the field
+
+         * @throws {RequiredError}
+         */
+        deleteDealField: (field_code) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'field_code' is not null or undefined
+            assertParamExists('deleteDealField', 'field_code', field_code);
+            const localVarPath = `/dealFields/{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", "deal-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 deal 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 deal field options in bulk
+         * @param {string} field_code The unique code identifying the field
+         * @param {Array<DeleteDealFieldOptionsRequestInner>} DeleteDealFieldOptionsRequestInner
+
+         * @throws {RequiredError}
+         */
+        deleteDealFieldOptions: (field_code, DeleteDealFieldOptionsRequestInner) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'field_code' is not null or undefined
+            assertParamExists('deleteDealFieldOptions', 'field_code', field_code);
+            // verify required parameter 'DeleteDealFieldOptionsRequestInner' is not null or undefined
+            assertParamExists('deleteDealFieldOptions', 'DeleteDealFieldOptionsRequestInner', DeleteDealFieldOptionsRequestInner);
+            const localVarPath = `/dealFields/{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", ["deals:full", "admin", "deal-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 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
+
+         * @throws {RequiredError}
+         */
+        getDealField: (field_code, include_fields) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'field_code' is not null or undefined
+            assertParamExists('getDealField', 'field_code', field_code);
+            const localVarPath = `/dealFields/{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", ["deals:read", "deals:full", "admin", "deal-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 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 {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, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = `/dealFields`;
+            // 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", ["deals:read", "deals:full", "admin", "deal-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 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
+         * @param {string} field_code The unique code identifying the field
+         * @param {UpdateDealFieldRequest} UpdateDealFieldRequest
+
+         * @throws {RequiredError}
+         */
+        updateDealField: (field_code, UpdateDealFieldRequest) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'field_code' is not null or undefined
+            assertParamExists('updateDealField', 'field_code', field_code);
+            // verify required parameter 'UpdateDealFieldRequest' is not null or undefined
+            assertParamExists('updateDealField', 'UpdateDealFieldRequest', UpdateDealFieldRequest);
+            const localVarPath = `/dealFields/{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", ["deals:full", "admin", "deal-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(UpdateDealFieldRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Updates existing options for a deal 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 deal field options in bulk
+         * @param {string} field_code The unique code identifying the field
+         * @param {Array<UpdateDealFieldOptionsRequestInner>} UpdateDealFieldOptionsRequestInner
+
+         * @throws {RequiredError}
+         */
+        updateDealFieldOptions: (field_code, UpdateDealFieldOptionsRequestInner) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'field_code' is not null or undefined
+            assertParamExists('updateDealFieldOptions', 'field_code', field_code);
+            // verify required parameter 'UpdateDealFieldOptionsRequestInner' is not null or undefined
+            assertParamExists('updateDealFieldOptions', 'UpdateDealFieldOptionsRequestInner', UpdateDealFieldOptionsRequestInner);
+            const localVarPath = `/dealFields/{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", ["deals:full", "admin", "deal-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,
+            };
+        }),
+    };
+};
+/**
+ * DealFieldsApi - functional programming interface
+ * @export
+ */
+export const DealFieldsApiFp = function (configuration) {
+    const localVarAxiosParamCreator = DealFieldsApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Creates a new deal custom field.
+         * @summary Create one deal field
+         * @param {AddDealFieldRequest} AddDealFieldRequest
+
+         * @throws {RequiredError}
+         */
+        addDealField(AddDealFieldRequest) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.addDealField(AddDealFieldRequest);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Adds new options to a deal 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 deal field options in bulk
+         * @param {string} field_code The unique code identifying the field
+         * @param {Array<AddDealFieldOptionsRequestInner>} AddDealFieldOptionsRequestInner
+
+         * @throws {RequiredError}
+         */
+        addDealFieldOptions(field_code, AddDealFieldOptionsRequestInner) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.addDealFieldOptions(field_code, AddDealFieldOptionsRequestInner);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Marks a custom field as deleted.
+         * @summary Delete one deal field
+         * @param {string} field_code The unique code identifying the field
+
+         * @throws {RequiredError}
+         */
+        deleteDealField(field_code) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteDealField(field_code);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Removes existing options from a deal 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 deal field options in bulk
+         * @param {string} field_code The unique code identifying the field
+         * @param {Array<DeleteDealFieldOptionsRequestInner>} DeleteDealFieldOptionsRequestInner
+
+         * @throws {RequiredError}
+         */
+        deleteDealFieldOptions(field_code, DeleteDealFieldOptionsRequestInner) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteDealFieldOptions(field_code, DeleteDealFieldOptionsRequestInner);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, 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
+
+         * @throws {RequiredError}
+         */
+        getDealField(field_code, include_fields) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealField(field_code, include_fields);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, 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 {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, limit, cursor) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealFields(include_fields, limit, cursor);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * 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
+         * @param {string} field_code The unique code identifying the field
+         * @param {UpdateDealFieldRequest} UpdateDealFieldRequest
+
+         * @throws {RequiredError}
+         */
+        updateDealField(field_code, UpdateDealFieldRequest) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.updateDealField(field_code, UpdateDealFieldRequest);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Updates existing options for a deal 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 deal field options in bulk
+         * @param {string} field_code The unique code identifying the field
+         * @param {Array<UpdateDealFieldOptionsRequestInner>} UpdateDealFieldOptionsRequestInner
+
+         * @throws {RequiredError}
+         */
+        updateDealFieldOptions(field_code, UpdateDealFieldOptionsRequestInner) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.updateDealFieldOptions(field_code, UpdateDealFieldOptionsRequestInner);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+    };
+};
+/**
+ * DealFieldsApi - factory interface
+ * @export
+ */
+export const DealFieldsApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = DealFieldsApiFp(configuration);
+    return {
+        /**
+         * Creates a new deal custom field.
+         * @summary Create one deal field
+         * @param {DealFieldsApiAddDealFieldRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        addDealField(requestParameters) {
+            return localVarFp.addDealField(requestParameters.AddDealFieldRequest).then((request) => request(axios, basePath));
+        },
+        /**
+         * Adds new options to a deal 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 deal field options in bulk
+         * @param {DealFieldsApiAddDealFieldOptionsRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        addDealFieldOptions(requestParameters) {
+            return localVarFp.addDealFieldOptions(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
+        },
+        /**
+         * Marks a custom field as deleted.
+         * @summary Delete one deal field
+         * @param {DealFieldsApiDeleteDealFieldRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        deleteDealField(requestParameters) {
+            return localVarFp.deleteDealField(requestParameters.field_code).then((request) => request(axios, basePath));
+        },
+        /**
+         * Removes existing options from a deal 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 deal field options in bulk
+         * @param {DealFieldsApiDeleteDealFieldOptionsRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        deleteDealFieldOptions(requestParameters) {
+            return localVarFp.deleteDealFieldOptions(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
+        },
+        /**
+         * Returns metadata about a specific deal field.
+         * @summary Get one deal field
+         * @param {DealFieldsApiGetDealFieldRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getDealField(requestParameters) {
+            return localVarFp.getDealField(requestParameters.field_code, requestParameters.include_fields).then((request) => request(axios, basePath));
+        },
+        /**
+         * Returns metadata about all deal fields in the company.
+         * @summary Get all deal fields
+         * @param {DealFieldsApiGetDealFieldsRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getDealFields(requestParameters = {}) {
+            return localVarFp.getDealFields(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
+        },
+        /**
+         * 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
+         * @param {DealFieldsApiUpdateDealFieldRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        updateDealField(requestParameters) {
+            return localVarFp.updateDealField(requestParameters.field_code, requestParameters.UpdateDealFieldRequest).then((request) => request(axios, basePath));
+        },
+        /**
+         * Updates existing options for a deal 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 deal field options in bulk
+         * @param {DealFieldsApiUpdateDealFieldOptionsRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        updateDealFieldOptions(requestParameters) {
+            return localVarFp.updateDealFieldOptions(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * DealFieldsApi - object-oriented interface
+ * @export
+ * @class DealFieldsApi
+ * @extends {BaseAPI}
+ */
+export class DealFieldsApi extends BaseAPI {
+    /**
+     * Creates a new deal custom field.
+     * @summary Create one deal field
+     * @param {DealFieldsApiAddDealFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealFieldsApi
+     */
+    addDealField(requestParameters) {
+        return DealFieldsApiFp(this.configuration).addDealField(requestParameters.AddDealFieldRequest).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Adds new options to a deal 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 deal field options in bulk
+     * @param {DealFieldsApiAddDealFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealFieldsApi
+     */
+    addDealFieldOptions(requestParameters) {
+        return DealFieldsApiFp(this.configuration).addDealFieldOptions(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Marks a custom field as deleted.
+     * @summary Delete one deal field
+     * @param {DealFieldsApiDeleteDealFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealFieldsApi
+     */
+    deleteDealField(requestParameters) {
+        return DealFieldsApiFp(this.configuration).deleteDealField(requestParameters.field_code).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Removes existing options from a deal 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 deal field options in bulk
+     * @param {DealFieldsApiDeleteDealFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealFieldsApi
+     */
+    deleteDealFieldOptions(requestParameters) {
+        return DealFieldsApiFp(this.configuration).deleteDealFieldOptions(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Returns metadata about a specific deal field.
+     * @summary Get one deal field
+     * @param {DealFieldsApiGetDealFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealFieldsApi
+     */
+    getDealField(requestParameters) {
+        return DealFieldsApiFp(this.configuration).getDealField(requestParameters.field_code, requestParameters.include_fields).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Returns metadata about all deal fields in the company.
+     * @summary Get all deal fields
+     * @param {DealFieldsApiGetDealFieldsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealFieldsApi
+     */
+    getDealFields(requestParameters = {}) {
+        return DealFieldsApiFp(this.configuration).getDealFields(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * 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
+     * @param {DealFieldsApiUpdateDealFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealFieldsApi
+     */
+    updateDealField(requestParameters) {
+        return DealFieldsApiFp(this.configuration).updateDealField(requestParameters.field_code, requestParameters.UpdateDealFieldRequest).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Updates existing options for a deal 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 deal field options in bulk
+     * @param {DealFieldsApiUpdateDealFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealFieldsApi
+     */
+    updateDealFieldOptions(requestParameters) {
+        return DealFieldsApiFp(this.configuration).updateDealFieldOptions(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
+    }
+}