/** * 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 { AddProjectField200Response } from '../models'; import { AddProjectFieldRequest } from '../models'; import { DeleteDealFieldOptionsRequestInner } from '../models'; import { DeleteProjectField200Response } from '../models'; import { GetProjectFields200Response } from '../models'; import { UpdateDealFieldOptionsRequestInner } from '../models'; import { UpdateProjectFieldRequest } from '../models'; /** * ProjectFieldsApi - axios parameter creator * @export */ export declare const ProjectFieldsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a new project custom field. * @summary Create one project field * @param {AddProjectFieldRequest} AddProjectFieldRequest * @throws {RequiredError} */ addProjectField: (AddProjectFieldRequest: AddProjectFieldRequest) => Promise; /** * Adds new options to a project 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 project field options in bulk * @param {string} field_code The unique code identifying the field * @param {Array} AddDealFieldOptionsRequestInner * @throws {RequiredError} */ addProjectFieldOptions: (field_code: string, AddDealFieldOptionsRequestInner: AddDealFieldOptionsRequestInner[]) => Promise; /** * Marks a custom field as deleted. * @summary Delete one project field * @param {string} field_code The unique code identifying the field * @throws {RequiredError} */ deleteProjectField: (field_code: string) => Promise; /** * Removes existing options from a project 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 project field options in bulk * @param {string} field_code The unique code identifying the field * @param {Array} DeleteDealFieldOptionsRequestInner * @throws {RequiredError} */ deleteProjectFieldOptions: (field_code: string, DeleteDealFieldOptionsRequestInner: DeleteDealFieldOptionsRequestInner[]) => Promise; /** * Returns metadata about a specific project field. * @summary Get one project field * @param {string} field_code The unique code identifying the field * @throws {RequiredError} */ getProjectField: (field_code: string) => Promise; /** * Returns metadata about all project fields in the company. * @summary Get all project fields * @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} */ getProjectFields: (limit?: number, cursor?: string) => Promise; /** * Updates a project 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 project field * @param {string} field_code The unique code identifying the field * @param {UpdateProjectFieldRequest} UpdateProjectFieldRequest * @throws {RequiredError} */ updateProjectField: (field_code: string, UpdateProjectFieldRequest: UpdateProjectFieldRequest) => Promise; /** * Updates existing options for a project 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 project field options in bulk * @param {string} field_code The unique code identifying the field * @param {Array} UpdateDealFieldOptionsRequestInner * @throws {RequiredError} */ updateProjectFieldOptions: (field_code: string, UpdateDealFieldOptionsRequestInner: UpdateDealFieldOptionsRequestInner[]) => Promise; }; /** * ProjectFieldsApi - functional programming interface * @export */ export declare const ProjectFieldsApiFp: (configuration?: Configuration) => { /** * Creates a new project custom field. * @summary Create one project field * @param {AddProjectFieldRequest} AddProjectFieldRequest * @throws {RequiredError} */ addProjectField(AddProjectFieldRequest: AddProjectFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Adds new options to a project 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 project field options in bulk * @param {string} field_code The unique code identifying the field * @param {Array} AddDealFieldOptionsRequestInner * @throws {RequiredError} */ addProjectFieldOptions(field_code: string, AddDealFieldOptionsRequestInner: AddDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Marks a custom field as deleted. * @summary Delete one project field * @param {string} field_code The unique code identifying the field * @throws {RequiredError} */ deleteProjectField(field_code: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Removes existing options from a project 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 project field options in bulk * @param {string} field_code The unique code identifying the field * @param {Array} DeleteDealFieldOptionsRequestInner * @throws {RequiredError} */ deleteProjectFieldOptions(field_code: string, DeleteDealFieldOptionsRequestInner: DeleteDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Returns metadata about a specific project field. * @summary Get one project field * @param {string} field_code The unique code identifying the field * @throws {RequiredError} */ getProjectField(field_code: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Returns metadata about all project fields in the company. * @summary Get all project fields * @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} */ getProjectFields(limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Updates a project 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 project field * @param {string} field_code The unique code identifying the field * @param {UpdateProjectFieldRequest} UpdateProjectFieldRequest * @throws {RequiredError} */ updateProjectField(field_code: string, UpdateProjectFieldRequest: UpdateProjectFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Updates existing options for a project 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 project field options in bulk * @param {string} field_code The unique code identifying the field * @param {Array} UpdateDealFieldOptionsRequestInner * @throws {RequiredError} */ updateProjectFieldOptions(field_code: string, UpdateDealFieldOptionsRequestInner: UpdateDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; }; /** * ProjectFieldsApi - factory interface * @export */ export declare const ProjectFieldsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a new project custom field. * @summary Create one project field * @param {ProjectFieldsApiAddProjectFieldRequest} requestParameters Request parameters. * @throws {RequiredError} */ addProjectField(requestParameters: ProjectFieldsApiAddProjectFieldRequest): Promise; /** * Adds new options to a project 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 project field options in bulk * @param {ProjectFieldsApiAddProjectFieldOptionsRequest} requestParameters Request parameters. * @throws {RequiredError} */ addProjectFieldOptions(requestParameters: ProjectFieldsApiAddProjectFieldOptionsRequest): Promise; /** * Marks a custom field as deleted. * @summary Delete one project field * @param {ProjectFieldsApiDeleteProjectFieldRequest} requestParameters Request parameters. * @throws {RequiredError} */ deleteProjectField(requestParameters: ProjectFieldsApiDeleteProjectFieldRequest): Promise; /** * Removes existing options from a project 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 project field options in bulk * @param {ProjectFieldsApiDeleteProjectFieldOptionsRequest} requestParameters Request parameters. * @throws {RequiredError} */ deleteProjectFieldOptions(requestParameters: ProjectFieldsApiDeleteProjectFieldOptionsRequest): Promise; /** * Returns metadata about a specific project field. * @summary Get one project field * @param {ProjectFieldsApiGetProjectFieldRequest} requestParameters Request parameters. * @throws {RequiredError} */ getProjectField(requestParameters: ProjectFieldsApiGetProjectFieldRequest): Promise; /** * Returns metadata about all project fields in the company. * @summary Get all project fields * @param {ProjectFieldsApiGetProjectFieldsRequest} requestParameters Request parameters. * @throws {RequiredError} */ getProjectFields(requestParameters?: ProjectFieldsApiGetProjectFieldsRequest): Promise; /** * Updates a project 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 project field * @param {ProjectFieldsApiUpdateProjectFieldRequest} requestParameters Request parameters. * @throws {RequiredError} */ updateProjectField(requestParameters: ProjectFieldsApiUpdateProjectFieldRequest): Promise; /** * Updates existing options for a project 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 project field options in bulk * @param {ProjectFieldsApiUpdateProjectFieldOptionsRequest} requestParameters Request parameters. * @throws {RequiredError} */ updateProjectFieldOptions(requestParameters: ProjectFieldsApiUpdateProjectFieldOptionsRequest): Promise; }; /** * Request parameters for addProjectField operation in ProjectFieldsApi. * @export * @interface ProjectFieldsApiAddProjectFieldRequest */ export interface ProjectFieldsApiAddProjectFieldRequest { /** * * @type {AddProjectFieldRequest} * @memberof ProjectFieldsApiAddProjectField */ readonly AddProjectFieldRequest: AddProjectFieldRequest; } /** * Request parameters for addProjectFieldOptions operation in ProjectFieldsApi. * @export * @interface ProjectFieldsApiAddProjectFieldOptionsRequest */ export interface ProjectFieldsApiAddProjectFieldOptionsRequest { /** * The unique code identifying the field * @type {string} * @memberof ProjectFieldsApiAddProjectFieldOptions */ readonly field_code: string; /** * * @type {Array} * @memberof ProjectFieldsApiAddProjectFieldOptions */ readonly AddDealFieldOptionsRequestInner: Array; } /** * Request parameters for deleteProjectField operation in ProjectFieldsApi. * @export * @interface ProjectFieldsApiDeleteProjectFieldRequest */ export interface ProjectFieldsApiDeleteProjectFieldRequest { /** * The unique code identifying the field * @type {string} * @memberof ProjectFieldsApiDeleteProjectField */ readonly field_code: string; } /** * Request parameters for deleteProjectFieldOptions operation in ProjectFieldsApi. * @export * @interface ProjectFieldsApiDeleteProjectFieldOptionsRequest */ export interface ProjectFieldsApiDeleteProjectFieldOptionsRequest { /** * The unique code identifying the field * @type {string} * @memberof ProjectFieldsApiDeleteProjectFieldOptions */ readonly field_code: string; /** * * @type {Array} * @memberof ProjectFieldsApiDeleteProjectFieldOptions */ readonly DeleteDealFieldOptionsRequestInner: Array; } /** * Request parameters for getProjectField operation in ProjectFieldsApi. * @export * @interface ProjectFieldsApiGetProjectFieldRequest */ export interface ProjectFieldsApiGetProjectFieldRequest { /** * The unique code identifying the field * @type {string} * @memberof ProjectFieldsApiGetProjectField */ readonly field_code: string; } /** * Request parameters for getProjectFields operation in ProjectFieldsApi. * @export * @interface ProjectFieldsApiGetProjectFieldsRequest */ export interface ProjectFieldsApiGetProjectFieldsRequest { /** * 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 ProjectFieldsApiGetProjectFields */ readonly limit?: number; /** * For pagination, the marker (an opaque string value) representing the first item on the next page * @type {string} * @memberof ProjectFieldsApiGetProjectFields */ readonly cursor?: string; } /** * Request parameters for updateProjectField operation in ProjectFieldsApi. * @export * @interface ProjectFieldsApiUpdateProjectFieldRequest */ export interface ProjectFieldsApiUpdateProjectFieldRequest { /** * The unique code identifying the field * @type {string} * @memberof ProjectFieldsApiUpdateProjectField */ readonly field_code: string; /** * * @type {UpdateProjectFieldRequest} * @memberof ProjectFieldsApiUpdateProjectField */ readonly UpdateProjectFieldRequest: UpdateProjectFieldRequest; } /** * Request parameters for updateProjectFieldOptions operation in ProjectFieldsApi. * @export * @interface ProjectFieldsApiUpdateProjectFieldOptionsRequest */ export interface ProjectFieldsApiUpdateProjectFieldOptionsRequest { /** * The unique code identifying the field * @type {string} * @memberof ProjectFieldsApiUpdateProjectFieldOptions */ readonly field_code: string; /** * * @type {Array} * @memberof ProjectFieldsApiUpdateProjectFieldOptions */ readonly UpdateDealFieldOptionsRequestInner: Array; } /** * ProjectFieldsApi - object-oriented interface * @export * @class ProjectFieldsApi * @extends {BaseAPI} */ export declare class ProjectFieldsApi extends BaseAPI { /** * Creates a new project custom field. * @summary Create one project field * @param {ProjectFieldsApiAddProjectFieldRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof ProjectFieldsApi */ addProjectField(requestParameters: ProjectFieldsApiAddProjectFieldRequest): Promise; /** * Adds new options to a project 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 project field options in bulk * @param {ProjectFieldsApiAddProjectFieldOptionsRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof ProjectFieldsApi */ addProjectFieldOptions(requestParameters: ProjectFieldsApiAddProjectFieldOptionsRequest): Promise; /** * Marks a custom field as deleted. * @summary Delete one project field * @param {ProjectFieldsApiDeleteProjectFieldRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof ProjectFieldsApi */ deleteProjectField(requestParameters: ProjectFieldsApiDeleteProjectFieldRequest): Promise; /** * Removes existing options from a project 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 project field options in bulk * @param {ProjectFieldsApiDeleteProjectFieldOptionsRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof ProjectFieldsApi */ deleteProjectFieldOptions(requestParameters: ProjectFieldsApiDeleteProjectFieldOptionsRequest): Promise; /** * Returns metadata about a specific project field. * @summary Get one project field * @param {ProjectFieldsApiGetProjectFieldRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof ProjectFieldsApi */ getProjectField(requestParameters: ProjectFieldsApiGetProjectFieldRequest): Promise; /** * Returns metadata about all project fields in the company. * @summary Get all project fields * @param {ProjectFieldsApiGetProjectFieldsRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof ProjectFieldsApi */ getProjectFields(requestParameters?: ProjectFieldsApiGetProjectFieldsRequest): Promise; /** * Updates a project 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 project field * @param {ProjectFieldsApiUpdateProjectFieldRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof ProjectFieldsApi */ updateProjectField(requestParameters: ProjectFieldsApiUpdateProjectFieldRequest): Promise; /** * Updates existing options for a project 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 project field options in bulk * @param {ProjectFieldsApiUpdateProjectFieldOptionsRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof ProjectFieldsApi */ updateProjectFieldOptions(requestParameters: ProjectFieldsApiUpdateProjectFieldOptionsRequest): Promise; }