/**
 * 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.
 */
import type { Configuration } from '../configuration';
import type { AxiosInstance } from 'axios';
import { RequestArgs, BaseAPI } from '../base';
import { AddDealFieldOptions200Response } from '../models';
import { AddDealFieldOptionsRequestInner } from '../models';
import { AddOrganizationField200Response } from '../models';
import { AddOrganizationFieldRequest } from '../models';
import { DeleteDealFieldOptionsRequestInner } from '../models';
import { DeletePersonField200Response } from '../models';
import { GetOrganizationFields200Response } from '../models';
import { UpdateDealFieldOptionsRequestInner } from '../models';
import { UpdateOrganizationFieldRequest } from '../models';
/**
 * OrganizationFieldsApi - axios parameter creator
 * @export
 */
export declare const OrganizationFieldsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Creates a new organization custom field.
     * @summary Create one organization field
     * @param {AddOrganizationFieldRequest} AddOrganizationFieldRequest

     * @throws {RequiredError}
     */
    addOrganizationField: (AddOrganizationFieldRequest: AddOrganizationFieldRequest) => Promise<RequestArgs>;
    /**
     * Adds new options to an organization 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 organization field options in bulk
     * @param {string} field_code The unique code identifying the field
     * @param {Array<AddDealFieldOptionsRequestInner>} AddDealFieldOptionsRequestInner

     * @throws {RequiredError}
     */
    addOrganizationFieldOptions: (field_code: string, AddDealFieldOptionsRequestInner: AddDealFieldOptionsRequestInner[]) => Promise<RequestArgs>;
    /**
     * Marks a custom field as deleted.
     * @summary Delete one organization field
     * @param {string} field_code The unique code identifying the field

     * @throws {RequiredError}
     */
    deleteOrganizationField: (field_code: string) => Promise<RequestArgs>;
    /**
     * Removes existing options from an organization 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 organization field options in bulk
     * @param {string} field_code The unique code identifying the field
     * @param {Array<DeleteDealFieldOptionsRequestInner>} DeleteDealFieldOptionsRequestInner

     * @throws {RequiredError}
     */
    deleteOrganizationFieldOptions: (field_code: string, DeleteDealFieldOptionsRequestInner: DeleteDealFieldOptionsRequestInner[]) => Promise<RequestArgs>;
    /**
     * Returns metadata about a specific organization field.
     * @summary Get one organization 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}
     */
    getOrganizationField: (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>;
    /**
     * Returns metadata about all organization fields in the company.
     * @summary Get all organization 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}
     */
    getOrganizationFields: (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>;
    /**
     * Updates an organization 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 organization field
     * @param {string} field_code The unique code identifying the field
     * @param {UpdateOrganizationFieldRequest} UpdateOrganizationFieldRequest

     * @throws {RequiredError}
     */
    updateOrganizationField: (field_code: string, UpdateOrganizationFieldRequest: UpdateOrganizationFieldRequest) => Promise<RequestArgs>;
    /**
     * Updates existing options for an organization 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 organization field options in bulk
     * @param {string} field_code The unique code identifying the field
     * @param {Array<UpdateDealFieldOptionsRequestInner>} UpdateDealFieldOptionsRequestInner

     * @throws {RequiredError}
     */
    updateOrganizationFieldOptions: (field_code: string, UpdateDealFieldOptionsRequestInner: UpdateDealFieldOptionsRequestInner[]) => Promise<RequestArgs>;
};
/**
 * OrganizationFieldsApi - functional programming interface
 * @export
 */
export declare const OrganizationFieldsApiFp: (configuration?: Configuration) => {
    /**
     * Creates a new organization custom field.
     * @summary Create one organization field
     * @param {AddOrganizationFieldRequest} AddOrganizationFieldRequest

     * @throws {RequiredError}
     */
    addOrganizationField(AddOrganizationFieldRequest: AddOrganizationFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddOrganizationField200Response>>;
    /**
     * Adds new options to an organization 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 organization field options in bulk
     * @param {string} field_code The unique code identifying the field
     * @param {Array<AddDealFieldOptionsRequestInner>} AddDealFieldOptionsRequestInner

     * @throws {RequiredError}
     */
    addOrganizationFieldOptions(field_code: string, AddDealFieldOptionsRequestInner: AddDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
    /**
     * Marks a custom field as deleted.
     * @summary Delete one organization field
     * @param {string} field_code The unique code identifying the field

     * @throws {RequiredError}
     */
    deleteOrganizationField(field_code: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeletePersonField200Response>>;
    /**
     * Removes existing options from an organization 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 organization field options in bulk
     * @param {string} field_code The unique code identifying the field
     * @param {Array<DeleteDealFieldOptionsRequestInner>} DeleteDealFieldOptionsRequestInner

     * @throws {RequiredError}
     */
    deleteOrganizationFieldOptions(field_code: string, DeleteDealFieldOptionsRequestInner: DeleteDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
    /**
     * Returns metadata about a specific organization field.
     * @summary Get one organization 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}
     */
    getOrganizationField(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<AddOrganizationField200Response>>;
    /**
     * Returns metadata about all organization fields in the company.
     * @summary Get all organization 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}
     */
    getOrganizationFields(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<GetOrganizationFields200Response>>;
    /**
     * Updates an organization 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 organization field
     * @param {string} field_code The unique code identifying the field
     * @param {UpdateOrganizationFieldRequest} UpdateOrganizationFieldRequest

     * @throws {RequiredError}
     */
    updateOrganizationField(field_code: string, UpdateOrganizationFieldRequest: UpdateOrganizationFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddOrganizationField200Response>>;
    /**
     * Updates existing options for an organization 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 organization field options in bulk
     * @param {string} field_code The unique code identifying the field
     * @param {Array<UpdateDealFieldOptionsRequestInner>} UpdateDealFieldOptionsRequestInner

     * @throws {RequiredError}
     */
    updateOrganizationFieldOptions(field_code: string, UpdateDealFieldOptionsRequestInner: UpdateDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
};
/**
 * OrganizationFieldsApi - factory interface
 * @export
 */
export declare const OrganizationFieldsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Creates a new organization custom field.
     * @summary Create one organization field
     * @param {OrganizationFieldsApiAddOrganizationFieldRequest} requestParameters Request parameters.

     * @throws {RequiredError}
     */
    addOrganizationField(requestParameters: OrganizationFieldsApiAddOrganizationFieldRequest): Promise<AddOrganizationField200Response>;
    /**
     * Adds new options to an organization 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 organization field options in bulk
     * @param {OrganizationFieldsApiAddOrganizationFieldOptionsRequest} requestParameters Request parameters.

     * @throws {RequiredError}
     */
    addOrganizationFieldOptions(requestParameters: OrganizationFieldsApiAddOrganizationFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
    /**
     * Marks a custom field as deleted.
     * @summary Delete one organization field
     * @param {OrganizationFieldsApiDeleteOrganizationFieldRequest} requestParameters Request parameters.

     * @throws {RequiredError}
     */
    deleteOrganizationField(requestParameters: OrganizationFieldsApiDeleteOrganizationFieldRequest): Promise<DeletePersonField200Response>;
    /**
     * Removes existing options from an organization 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 organization field options in bulk
     * @param {OrganizationFieldsApiDeleteOrganizationFieldOptionsRequest} requestParameters Request parameters.

     * @throws {RequiredError}
     */
    deleteOrganizationFieldOptions(requestParameters: OrganizationFieldsApiDeleteOrganizationFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
    /**
     * Returns metadata about a specific organization field.
     * @summary Get one organization field
     * @param {OrganizationFieldsApiGetOrganizationFieldRequest} requestParameters Request parameters.

     * @throws {RequiredError}
     */
    getOrganizationField(requestParameters: OrganizationFieldsApiGetOrganizationFieldRequest): Promise<AddOrganizationField200Response>;
    /**
     * Returns metadata about all organization fields in the company.
     * @summary Get all organization fields
     * @param {OrganizationFieldsApiGetOrganizationFieldsRequest} requestParameters Request parameters.

     * @throws {RequiredError}
     */
    getOrganizationFields(requestParameters?: OrganizationFieldsApiGetOrganizationFieldsRequest): Promise<GetOrganizationFields200Response>;
    /**
     * Updates an organization 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 organization field
     * @param {OrganizationFieldsApiUpdateOrganizationFieldRequest} requestParameters Request parameters.

     * @throws {RequiredError}
     */
    updateOrganizationField(requestParameters: OrganizationFieldsApiUpdateOrganizationFieldRequest): Promise<AddOrganizationField200Response>;
    /**
     * Updates existing options for an organization 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 organization field options in bulk
     * @param {OrganizationFieldsApiUpdateOrganizationFieldOptionsRequest} requestParameters Request parameters.

     * @throws {RequiredError}
     */
    updateOrganizationFieldOptions(requestParameters: OrganizationFieldsApiUpdateOrganizationFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
};
/**
 * Request parameters for addOrganizationField operation in OrganizationFieldsApi.
 * @export
 * @interface OrganizationFieldsApiAddOrganizationFieldRequest
 */
export interface OrganizationFieldsApiAddOrganizationFieldRequest {
    /**
     *
     * @type {AddOrganizationFieldRequest}
     * @memberof OrganizationFieldsApiAddOrganizationField
     */
    readonly AddOrganizationFieldRequest: AddOrganizationFieldRequest;
}
/**
 * Request parameters for addOrganizationFieldOptions operation in OrganizationFieldsApi.
 * @export
 * @interface OrganizationFieldsApiAddOrganizationFieldOptionsRequest
 */
export interface OrganizationFieldsApiAddOrganizationFieldOptionsRequest {
    /**
     * The unique code identifying the field
     * @type {string}
     * @memberof OrganizationFieldsApiAddOrganizationFieldOptions
     */
    readonly field_code: string;
    /**
     *
     * @type {Array<AddDealFieldOptionsRequestInner>}
     * @memberof OrganizationFieldsApiAddOrganizationFieldOptions
     */
    readonly AddDealFieldOptionsRequestInner: Array<AddDealFieldOptionsRequestInner>;
}
/**
 * Request parameters for deleteOrganizationField operation in OrganizationFieldsApi.
 * @export
 * @interface OrganizationFieldsApiDeleteOrganizationFieldRequest
 */
export interface OrganizationFieldsApiDeleteOrganizationFieldRequest {
    /**
     * The unique code identifying the field
     * @type {string}
     * @memberof OrganizationFieldsApiDeleteOrganizationField
     */
    readonly field_code: string;
}
/**
 * Request parameters for deleteOrganizationFieldOptions operation in OrganizationFieldsApi.
 * @export
 * @interface OrganizationFieldsApiDeleteOrganizationFieldOptionsRequest
 */
export interface OrganizationFieldsApiDeleteOrganizationFieldOptionsRequest {
    /**
     * The unique code identifying the field
     * @type {string}
     * @memberof OrganizationFieldsApiDeleteOrganizationFieldOptions
     */
    readonly field_code: string;
    /**
     *
     * @type {Array<DeleteDealFieldOptionsRequestInner>}
     * @memberof OrganizationFieldsApiDeleteOrganizationFieldOptions
     */
    readonly DeleteDealFieldOptionsRequestInner: Array<DeleteDealFieldOptionsRequestInner>;
}
/**
 * Request parameters for getOrganizationField operation in OrganizationFieldsApi.
 * @export
 * @interface OrganizationFieldsApiGetOrganizationFieldRequest
 */
export interface OrganizationFieldsApiGetOrganizationFieldRequest {
    /**
     * The unique code identifying the field
     * @type {string}
     * @memberof OrganizationFieldsApiGetOrganizationField
     */
    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'}
     * @memberof OrganizationFieldsApiGetOrganizationField
     */
    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';
}
/**
 * Request parameters for getOrganizationFields operation in OrganizationFieldsApi.
 * @export
 * @interface OrganizationFieldsApiGetOrganizationFieldsRequest
 */
export interface OrganizationFieldsApiGetOrganizationFieldsRequest {
    /**
     * 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'}
     * @memberof OrganizationFieldsApiGetOrganizationFields
     */
    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';
    /**
     * 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}
     * @memberof OrganizationFieldsApiGetOrganizationFields
     */
    readonly limit?: number;
    /**
     * For pagination, the marker (an opaque string value) representing the first item on the next page
     * @type {string}
     * @memberof OrganizationFieldsApiGetOrganizationFields
     */
    readonly cursor?: string;
}
/**
 * Request parameters for updateOrganizationField operation in OrganizationFieldsApi.
 * @export
 * @interface OrganizationFieldsApiUpdateOrganizationFieldRequest
 */
export interface OrganizationFieldsApiUpdateOrganizationFieldRequest {
    /**
     * The unique code identifying the field
     * @type {string}
     * @memberof OrganizationFieldsApiUpdateOrganizationField
     */
    readonly field_code: string;
    /**
     *
     * @type {UpdateOrganizationFieldRequest}
     * @memberof OrganizationFieldsApiUpdateOrganizationField
     */
    readonly UpdateOrganizationFieldRequest: UpdateOrganizationFieldRequest;
}
/**
 * Request parameters for updateOrganizationFieldOptions operation in OrganizationFieldsApi.
 * @export
 * @interface OrganizationFieldsApiUpdateOrganizationFieldOptionsRequest
 */
export interface OrganizationFieldsApiUpdateOrganizationFieldOptionsRequest {
    /**
     * The unique code identifying the field
     * @type {string}
     * @memberof OrganizationFieldsApiUpdateOrganizationFieldOptions
     */
    readonly field_code: string;
    /**
     *
     * @type {Array<UpdateDealFieldOptionsRequestInner>}
     * @memberof OrganizationFieldsApiUpdateOrganizationFieldOptions
     */
    readonly UpdateDealFieldOptionsRequestInner: Array<UpdateDealFieldOptionsRequestInner>;
}
/**
 * OrganizationFieldsApi - object-oriented interface
 * @export
 * @class OrganizationFieldsApi
 * @extends {BaseAPI}
 */
export declare class OrganizationFieldsApi extends BaseAPI {
    /**
     * Creates a new organization custom field.
     * @summary Create one organization field
     * @param {OrganizationFieldsApiAddOrganizationFieldRequest} requestParameters Request parameters.

     * @throws {RequiredError}
     * @memberof OrganizationFieldsApi
     */
    addOrganizationField(requestParameters: OrganizationFieldsApiAddOrganizationFieldRequest): Promise<AddOrganizationField200Response>;
    /**
     * Adds new options to an organization 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 organization field options in bulk
     * @param {OrganizationFieldsApiAddOrganizationFieldOptionsRequest} requestParameters Request parameters.

     * @throws {RequiredError}
     * @memberof OrganizationFieldsApi
     */
    addOrganizationFieldOptions(requestParameters: OrganizationFieldsApiAddOrganizationFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
    /**
     * Marks a custom field as deleted.
     * @summary Delete one organization field
     * @param {OrganizationFieldsApiDeleteOrganizationFieldRequest} requestParameters Request parameters.

     * @throws {RequiredError}
     * @memberof OrganizationFieldsApi
     */
    deleteOrganizationField(requestParameters: OrganizationFieldsApiDeleteOrganizationFieldRequest): Promise<DeletePersonField200Response>;
    /**
     * Removes existing options from an organization 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 organization field options in bulk
     * @param {OrganizationFieldsApiDeleteOrganizationFieldOptionsRequest} requestParameters Request parameters.

     * @throws {RequiredError}
     * @memberof OrganizationFieldsApi
     */
    deleteOrganizationFieldOptions(requestParameters: OrganizationFieldsApiDeleteOrganizationFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
    /**
     * Returns metadata about a specific organization field.
     * @summary Get one organization field
     * @param {OrganizationFieldsApiGetOrganizationFieldRequest} requestParameters Request parameters.

     * @throws {RequiredError}
     * @memberof OrganizationFieldsApi
     */
    getOrganizationField(requestParameters: OrganizationFieldsApiGetOrganizationFieldRequest): Promise<AddOrganizationField200Response>;
    /**
     * Returns metadata about all organization fields in the company.
     * @summary Get all organization fields
     * @param {OrganizationFieldsApiGetOrganizationFieldsRequest} requestParameters Request parameters.

     * @throws {RequiredError}
     * @memberof OrganizationFieldsApi
     */
    getOrganizationFields(requestParameters?: OrganizationFieldsApiGetOrganizationFieldsRequest): Promise<GetOrganizationFields200Response>;
    /**
     * Updates an organization 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 organization field
     * @param {OrganizationFieldsApiUpdateOrganizationFieldRequest} requestParameters Request parameters.

     * @throws {RequiredError}
     * @memberof OrganizationFieldsApi
     */
    updateOrganizationField(requestParameters: OrganizationFieldsApiUpdateOrganizationFieldRequest): Promise<AddOrganizationField200Response>;
    /**
     * Updates existing options for an organization 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 organization field options in bulk
     * @param {OrganizationFieldsApiUpdateOrganizationFieldOptionsRequest} requestParameters Request parameters.

     * @throws {RequiredError}
     * @memberof OrganizationFieldsApi
     */
    updateOrganizationFieldOptions(requestParameters: OrganizationFieldsApiUpdateOrganizationFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
}