/**
 * 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 { AddPersonField200Response } from '../models';
import { AddPersonFieldRequest } from '../models';
import { DeleteDealFieldOptionsRequestInner } from '../models';
import { DeletePersonField200Response } from '../models';
import { GetPersonFields200Response } from '../models';
import { UpdateDealFieldOptionsRequestInner } from '../models';
import { UpdatePersonFieldRequest } from '../models';
/**
 * PersonFieldsApi - axios parameter creator
 * @export
 */
export declare const PersonFieldsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Creates a new person custom field.
     * @summary Create one person field
     * @param {AddPersonFieldRequest} AddPersonFieldRequest

     * @throws {RequiredError}
     */
    addPersonField: (AddPersonFieldRequest: AddPersonFieldRequest) => Promise<RequestArgs>;
    /**
     * 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: string, AddDealFieldOptionsRequestInner: AddDealFieldOptionsRequestInner[]) => Promise<RequestArgs>;
    /**
     * 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: string) => Promise<RequestArgs>;
    /**
     * 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: string, DeleteDealFieldOptionsRequestInner: DeleteDealFieldOptionsRequestInner[]) => Promise<RequestArgs>;
    /**
     * 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: 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 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?: '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 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: string, UpdatePersonFieldRequest: UpdatePersonFieldRequest) => Promise<RequestArgs>;
    /**
     * 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: string, UpdateDealFieldOptionsRequestInner: UpdateDealFieldOptionsRequestInner[]) => Promise<RequestArgs>;
};
/**
 * PersonFieldsApi - functional programming interface
 * @export
 */
export declare const PersonFieldsApiFp: (configuration?: Configuration) => {
    /**
     * Creates a new person custom field.
     * @summary Create one person field
     * @param {AddPersonFieldRequest} AddPersonFieldRequest

     * @throws {RequiredError}
     */
    addPersonField(AddPersonFieldRequest: AddPersonFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddPersonField200Response>>;
    /**
     * 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: string, AddDealFieldOptionsRequestInner: AddDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
    /**
     * 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: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeletePersonField200Response>>;
    /**
     * 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: string, DeleteDealFieldOptionsRequestInner: DeleteDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
    /**
     * 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: 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<AddPersonField200Response>>;
    /**
     * 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?: '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<GetPersonFields200Response>>;
    /**
     * 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: string, UpdatePersonFieldRequest: UpdatePersonFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddPersonField200Response>>;
    /**
     * 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: string, UpdateDealFieldOptionsRequestInner: UpdateDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
};
/**
 * PersonFieldsApi - factory interface
 * @export
 */
export declare const PersonFieldsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Creates a new person custom field.
     * @summary Create one person field
     * @param {PersonFieldsApiAddPersonFieldRequest} requestParameters Request parameters.

     * @throws {RequiredError}
     */
    addPersonField(requestParameters: PersonFieldsApiAddPersonFieldRequest): Promise<AddPersonField200Response>;
    /**
     * 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: PersonFieldsApiAddPersonFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
    /**
     * Marks a custom field as deleted.
     * @summary Delete one person field
     * @param {PersonFieldsApiDeletePersonFieldRequest} requestParameters Request parameters.

     * @throws {RequiredError}
     */
    deletePersonField(requestParameters: PersonFieldsApiDeletePersonFieldRequest): Promise<DeletePersonField200Response>;
    /**
     * 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: PersonFieldsApiDeletePersonFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
    /**
     * Returns metadata about a specific person field.
     * @summary Get one person field
     * @param {PersonFieldsApiGetPersonFieldRequest} requestParameters Request parameters.

     * @throws {RequiredError}
     */
    getPersonField(requestParameters: PersonFieldsApiGetPersonFieldRequest): Promise<AddPersonField200Response>;
    /**
     * Returns metadata about all person fields in the company.
     * @summary Get all person fields
     * @param {PersonFieldsApiGetPersonFieldsRequest} requestParameters Request parameters.

     * @throws {RequiredError}
     */
    getPersonFields(requestParameters?: PersonFieldsApiGetPersonFieldsRequest): Promise<GetPersonFields200Response>;
    /**
     * 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: PersonFieldsApiUpdatePersonFieldRequest): Promise<AddPersonField200Response>;
    /**
     * 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: PersonFieldsApiUpdatePersonFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
};
/**
 * Request parameters for addPersonField operation in PersonFieldsApi.
 * @export
 * @interface PersonFieldsApiAddPersonFieldRequest
 */
export interface PersonFieldsApiAddPersonFieldRequest {
    /**
     *
     * @type {AddPersonFieldRequest}
     * @memberof PersonFieldsApiAddPersonField
     */
    readonly AddPersonFieldRequest: AddPersonFieldRequest;
}
/**
 * Request parameters for addPersonFieldOptions operation in PersonFieldsApi.
 * @export
 * @interface PersonFieldsApiAddPersonFieldOptionsRequest
 */
export interface PersonFieldsApiAddPersonFieldOptionsRequest {
    /**
     * The unique code identifying the field
     * @type {string}
     * @memberof PersonFieldsApiAddPersonFieldOptions
     */
    readonly field_code: string;
    /**
     *
     * @type {Array<AddDealFieldOptionsRequestInner>}
     * @memberof PersonFieldsApiAddPersonFieldOptions
     */
    readonly AddDealFieldOptionsRequestInner: Array<AddDealFieldOptionsRequestInner>;
}
/**
 * Request parameters for deletePersonField operation in PersonFieldsApi.
 * @export
 * @interface PersonFieldsApiDeletePersonFieldRequest
 */
export interface PersonFieldsApiDeletePersonFieldRequest {
    /**
     * The unique code identifying the field
     * @type {string}
     * @memberof PersonFieldsApiDeletePersonField
     */
    readonly field_code: string;
}
/**
 * Request parameters for deletePersonFieldOptions operation in PersonFieldsApi.
 * @export
 * @interface PersonFieldsApiDeletePersonFieldOptionsRequest
 */
export interface PersonFieldsApiDeletePersonFieldOptionsRequest {
    /**
     * The unique code identifying the field
     * @type {string}
     * @memberof PersonFieldsApiDeletePersonFieldOptions
     */
    readonly field_code: string;
    /**
     *
     * @type {Array<DeleteDealFieldOptionsRequestInner>}
     * @memberof PersonFieldsApiDeletePersonFieldOptions
     */
    readonly DeleteDealFieldOptionsRequestInner: Array<DeleteDealFieldOptionsRequestInner>;
}
/**
 * Request parameters for getPersonField operation in PersonFieldsApi.
 * @export
 * @interface PersonFieldsApiGetPersonFieldRequest
 */
export interface PersonFieldsApiGetPersonFieldRequest {
    /**
     * The unique code identifying the field
     * @type {string}
     * @memberof PersonFieldsApiGetPersonField
     */
    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 PersonFieldsApiGetPersonField
     */
    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 getPersonFields operation in PersonFieldsApi.
 * @export
 * @interface PersonFieldsApiGetPersonFieldsRequest
 */
export interface PersonFieldsApiGetPersonFieldsRequest {
    /**
     * 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 PersonFieldsApiGetPersonFields
     */
    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 PersonFieldsApiGetPersonFields
     */
    readonly limit?: number;
    /**
     * For pagination, the marker (an opaque string value) representing the first item on the next page
     * @type {string}
     * @memberof PersonFieldsApiGetPersonFields
     */
    readonly cursor?: string;
}
/**
 * Request parameters for updatePersonField operation in PersonFieldsApi.
 * @export
 * @interface PersonFieldsApiUpdatePersonFieldRequest
 */
export interface PersonFieldsApiUpdatePersonFieldRequest {
    /**
     * The unique code identifying the field
     * @type {string}
     * @memberof PersonFieldsApiUpdatePersonField
     */
    readonly field_code: string;
    /**
     *
     * @type {UpdatePersonFieldRequest}
     * @memberof PersonFieldsApiUpdatePersonField
     */
    readonly UpdatePersonFieldRequest: UpdatePersonFieldRequest;
}
/**
 * Request parameters for updatePersonFieldOptions operation in PersonFieldsApi.
 * @export
 * @interface PersonFieldsApiUpdatePersonFieldOptionsRequest
 */
export interface PersonFieldsApiUpdatePersonFieldOptionsRequest {
    /**
     * The unique code identifying the field
     * @type {string}
     * @memberof PersonFieldsApiUpdatePersonFieldOptions
     */
    readonly field_code: string;
    /**
     *
     * @type {Array<UpdateDealFieldOptionsRequestInner>}
     * @memberof PersonFieldsApiUpdatePersonFieldOptions
     */
    readonly UpdateDealFieldOptionsRequestInner: Array<UpdateDealFieldOptionsRequestInner>;
}
/**
 * PersonFieldsApi - object-oriented interface
 * @export
 * @class PersonFieldsApi
 * @extends {BaseAPI}
 */
export declare 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: PersonFieldsApiAddPersonFieldRequest): Promise<AddPersonField200Response>;
    /**
     * 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: PersonFieldsApiAddPersonFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
    /**
     * Marks a custom field as deleted.
     * @summary Delete one person field
     * @param {PersonFieldsApiDeletePersonFieldRequest} requestParameters Request parameters.

     * @throws {RequiredError}
     * @memberof PersonFieldsApi
     */
    deletePersonField(requestParameters: PersonFieldsApiDeletePersonFieldRequest): Promise<DeletePersonField200Response>;
    /**
     * 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: PersonFieldsApiDeletePersonFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
    /**
     * Returns metadata about a specific person field.
     * @summary Get one person field
     * @param {PersonFieldsApiGetPersonFieldRequest} requestParameters Request parameters.

     * @throws {RequiredError}
     * @memberof PersonFieldsApi
     */
    getPersonField(requestParameters: PersonFieldsApiGetPersonFieldRequest): Promise<AddPersonField200Response>;
    /**
     * 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?: PersonFieldsApiGetPersonFieldsRequest): Promise<GetPersonFields200Response>;
    /**
     * 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: PersonFieldsApiUpdatePersonFieldRequest): Promise<AddPersonField200Response>;
    /**
     * 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: PersonFieldsApiUpdatePersonFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
}