/** * 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 { AddProductFieldRequest } from '../models'; import { DeleteDealFieldOptionsRequestInner } from '../models'; import { DeletePersonField200Response } from '../models'; import { GetActivityField200Response } from '../models'; import { GetActivityFields200Response } from '../models'; import { UpdateDealFieldOptionsRequestInner } from '../models'; import { UpdateProductFieldRequest } from '../models'; /** * ProductFieldsApi - axios parameter creator * @export */ export declare const ProductFieldsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a new product custom field. * @summary Create one product field * @param {AddProductFieldRequest} AddProductFieldRequest * @throws {RequiredError} */ addProductField: (AddProductFieldRequest: AddProductFieldRequest) => Promise; /** * Adds new options to a product 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 product field options in bulk * @param {string} field_code The unique code identifying the field * @param {Array} AddDealFieldOptionsRequestInner * @throws {RequiredError} */ addProductFieldOptions: (field_code: string, AddDealFieldOptionsRequestInner: AddDealFieldOptionsRequestInner[]) => Promise; /** * Marks a custom field as deleted. * @summary Delete one product field * @param {string} field_code The unique code identifying the field * @throws {RequiredError} */ deleteProductField: (field_code: string) => Promise; /** * Removes existing options from a product 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 product field options in bulk * @param {string} field_code The unique code identifying the field * @param {Array} DeleteDealFieldOptionsRequestInner * @throws {RequiredError} */ deleteProductFieldOptions: (field_code: string, DeleteDealFieldOptionsRequestInner: DeleteDealFieldOptionsRequestInner[]) => Promise; /** * Returns metadata about a specific product field. * @summary Get one product field * @param {string} field_code The unique code identifying the field * @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response * @throws {RequiredError} */ getProductField: (field_code: string, include_fields?: 'ui_visibility') => Promise; /** * Returns metadata about all product fields in the company. * @summary Get all product fields * @param {'ui_visibility'} [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} */ getProductFields: (include_fields?: 'ui_visibility', limit?: number, cursor?: string) => Promise; /** * Updates a product 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 product field * @param {string} field_code The unique code identifying the field * @param {UpdateProductFieldRequest} UpdateProductFieldRequest * @throws {RequiredError} */ updateProductField: (field_code: string, UpdateProductFieldRequest: UpdateProductFieldRequest) => Promise; /** * Updates existing options for a product 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 product field options in bulk * @param {string} field_code The unique code identifying the field * @param {Array} UpdateDealFieldOptionsRequestInner * @throws {RequiredError} */ updateProductFieldOptions: (field_code: string, UpdateDealFieldOptionsRequestInner: UpdateDealFieldOptionsRequestInner[]) => Promise; }; /** * ProductFieldsApi - functional programming interface * @export */ export declare const ProductFieldsApiFp: (configuration?: Configuration) => { /** * Creates a new product custom field. * @summary Create one product field * @param {AddProductFieldRequest} AddProductFieldRequest * @throws {RequiredError} */ addProductField(AddProductFieldRequest: AddProductFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Adds new options to a product 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 product field options in bulk * @param {string} field_code The unique code identifying the field * @param {Array} AddDealFieldOptionsRequestInner * @throws {RequiredError} */ addProductFieldOptions(field_code: string, AddDealFieldOptionsRequestInner: AddDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Marks a custom field as deleted. * @summary Delete one product field * @param {string} field_code The unique code identifying the field * @throws {RequiredError} */ deleteProductField(field_code: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Removes existing options from a product 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 product field options in bulk * @param {string} field_code The unique code identifying the field * @param {Array} DeleteDealFieldOptionsRequestInner * @throws {RequiredError} */ deleteProductFieldOptions(field_code: string, DeleteDealFieldOptionsRequestInner: DeleteDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Returns metadata about a specific product field. * @summary Get one product field * @param {string} field_code The unique code identifying the field * @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response * @throws {RequiredError} */ getProductField(field_code: string, include_fields?: 'ui_visibility'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Returns metadata about all product fields in the company. * @summary Get all product fields * @param {'ui_visibility'} [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} */ getProductFields(include_fields?: 'ui_visibility', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Updates a product 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 product field * @param {string} field_code The unique code identifying the field * @param {UpdateProductFieldRequest} UpdateProductFieldRequest * @throws {RequiredError} */ updateProductField(field_code: string, UpdateProductFieldRequest: UpdateProductFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Updates existing options for a product 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 product field options in bulk * @param {string} field_code The unique code identifying the field * @param {Array} UpdateDealFieldOptionsRequestInner * @throws {RequiredError} */ updateProductFieldOptions(field_code: string, UpdateDealFieldOptionsRequestInner: UpdateDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; }; /** * ProductFieldsApi - factory interface * @export */ export declare const ProductFieldsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a new product custom field. * @summary Create one product field * @param {ProductFieldsApiAddProductFieldRequest} requestParameters Request parameters. * @throws {RequiredError} */ addProductField(requestParameters: ProductFieldsApiAddProductFieldRequest): Promise; /** * Adds new options to a product 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 product field options in bulk * @param {ProductFieldsApiAddProductFieldOptionsRequest} requestParameters Request parameters. * @throws {RequiredError} */ addProductFieldOptions(requestParameters: ProductFieldsApiAddProductFieldOptionsRequest): Promise; /** * Marks a custom field as deleted. * @summary Delete one product field * @param {ProductFieldsApiDeleteProductFieldRequest} requestParameters Request parameters. * @throws {RequiredError} */ deleteProductField(requestParameters: ProductFieldsApiDeleteProductFieldRequest): Promise; /** * Removes existing options from a product 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 product field options in bulk * @param {ProductFieldsApiDeleteProductFieldOptionsRequest} requestParameters Request parameters. * @throws {RequiredError} */ deleteProductFieldOptions(requestParameters: ProductFieldsApiDeleteProductFieldOptionsRequest): Promise; /** * Returns metadata about a specific product field. * @summary Get one product field * @param {ProductFieldsApiGetProductFieldRequest} requestParameters Request parameters. * @throws {RequiredError} */ getProductField(requestParameters: ProductFieldsApiGetProductFieldRequest): Promise; /** * Returns metadata about all product fields in the company. * @summary Get all product fields * @param {ProductFieldsApiGetProductFieldsRequest} requestParameters Request parameters. * @throws {RequiredError} */ getProductFields(requestParameters?: ProductFieldsApiGetProductFieldsRequest): Promise; /** * Updates a product 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 product field * @param {ProductFieldsApiUpdateProductFieldRequest} requestParameters Request parameters. * @throws {RequiredError} */ updateProductField(requestParameters: ProductFieldsApiUpdateProductFieldRequest): Promise; /** * Updates existing options for a product 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 product field options in bulk * @param {ProductFieldsApiUpdateProductFieldOptionsRequest} requestParameters Request parameters. * @throws {RequiredError} */ updateProductFieldOptions(requestParameters: ProductFieldsApiUpdateProductFieldOptionsRequest): Promise; }; /** * Request parameters for addProductField operation in ProductFieldsApi. * @export * @interface ProductFieldsApiAddProductFieldRequest */ export interface ProductFieldsApiAddProductFieldRequest { /** * * @type {AddProductFieldRequest} * @memberof ProductFieldsApiAddProductField */ readonly AddProductFieldRequest: AddProductFieldRequest; } /** * Request parameters for addProductFieldOptions operation in ProductFieldsApi. * @export * @interface ProductFieldsApiAddProductFieldOptionsRequest */ export interface ProductFieldsApiAddProductFieldOptionsRequest { /** * The unique code identifying the field * @type {string} * @memberof ProductFieldsApiAddProductFieldOptions */ readonly field_code: string; /** * * @type {Array} * @memberof ProductFieldsApiAddProductFieldOptions */ readonly AddDealFieldOptionsRequestInner: Array; } /** * Request parameters for deleteProductField operation in ProductFieldsApi. * @export * @interface ProductFieldsApiDeleteProductFieldRequest */ export interface ProductFieldsApiDeleteProductFieldRequest { /** * The unique code identifying the field * @type {string} * @memberof ProductFieldsApiDeleteProductField */ readonly field_code: string; } /** * Request parameters for deleteProductFieldOptions operation in ProductFieldsApi. * @export * @interface ProductFieldsApiDeleteProductFieldOptionsRequest */ export interface ProductFieldsApiDeleteProductFieldOptionsRequest { /** * The unique code identifying the field * @type {string} * @memberof ProductFieldsApiDeleteProductFieldOptions */ readonly field_code: string; /** * * @type {Array} * @memberof ProductFieldsApiDeleteProductFieldOptions */ readonly DeleteDealFieldOptionsRequestInner: Array; } /** * Request parameters for getProductField operation in ProductFieldsApi. * @export * @interface ProductFieldsApiGetProductFieldRequest */ export interface ProductFieldsApiGetProductFieldRequest { /** * The unique code identifying the field * @type {string} * @memberof ProductFieldsApiGetProductField */ readonly field_code: string; /** * Optional comma separated string array of additional data namespaces to include in response * @type {'ui_visibility'} * @memberof ProductFieldsApiGetProductField */ readonly include_fields?: 'ui_visibility'; } /** * Request parameters for getProductFields operation in ProductFieldsApi. * @export * @interface ProductFieldsApiGetProductFieldsRequest */ export interface ProductFieldsApiGetProductFieldsRequest { /** * Optional comma separated string array of additional data namespaces to include in response * @type {'ui_visibility'} * @memberof ProductFieldsApiGetProductFields */ readonly include_fields?: 'ui_visibility'; /** * 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 ProductFieldsApiGetProductFields */ readonly limit?: number; /** * For pagination, the marker (an opaque string value) representing the first item on the next page * @type {string} * @memberof ProductFieldsApiGetProductFields */ readonly cursor?: string; } /** * Request parameters for updateProductField operation in ProductFieldsApi. * @export * @interface ProductFieldsApiUpdateProductFieldRequest */ export interface ProductFieldsApiUpdateProductFieldRequest { /** * The unique code identifying the field * @type {string} * @memberof ProductFieldsApiUpdateProductField */ readonly field_code: string; /** * * @type {UpdateProductFieldRequest} * @memberof ProductFieldsApiUpdateProductField */ readonly UpdateProductFieldRequest: UpdateProductFieldRequest; } /** * Request parameters for updateProductFieldOptions operation in ProductFieldsApi. * @export * @interface ProductFieldsApiUpdateProductFieldOptionsRequest */ export interface ProductFieldsApiUpdateProductFieldOptionsRequest { /** * The unique code identifying the field * @type {string} * @memberof ProductFieldsApiUpdateProductFieldOptions */ readonly field_code: string; /** * * @type {Array} * @memberof ProductFieldsApiUpdateProductFieldOptions */ readonly UpdateDealFieldOptionsRequestInner: Array; } /** * ProductFieldsApi - object-oriented interface * @export * @class ProductFieldsApi * @extends {BaseAPI} */ export declare class ProductFieldsApi extends BaseAPI { /** * Creates a new product custom field. * @summary Create one product field * @param {ProductFieldsApiAddProductFieldRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof ProductFieldsApi */ addProductField(requestParameters: ProductFieldsApiAddProductFieldRequest): Promise; /** * Adds new options to a product 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 product field options in bulk * @param {ProductFieldsApiAddProductFieldOptionsRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof ProductFieldsApi */ addProductFieldOptions(requestParameters: ProductFieldsApiAddProductFieldOptionsRequest): Promise; /** * Marks a custom field as deleted. * @summary Delete one product field * @param {ProductFieldsApiDeleteProductFieldRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof ProductFieldsApi */ deleteProductField(requestParameters: ProductFieldsApiDeleteProductFieldRequest): Promise; /** * Removes existing options from a product 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 product field options in bulk * @param {ProductFieldsApiDeleteProductFieldOptionsRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof ProductFieldsApi */ deleteProductFieldOptions(requestParameters: ProductFieldsApiDeleteProductFieldOptionsRequest): Promise; /** * Returns metadata about a specific product field. * @summary Get one product field * @param {ProductFieldsApiGetProductFieldRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof ProductFieldsApi */ getProductField(requestParameters: ProductFieldsApiGetProductFieldRequest): Promise; /** * Returns metadata about all product fields in the company. * @summary Get all product fields * @param {ProductFieldsApiGetProductFieldsRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof ProductFieldsApi */ getProductFields(requestParameters?: ProductFieldsApiGetProductFieldsRequest): Promise; /** * Updates a product 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 product field * @param {ProductFieldsApiUpdateProductFieldRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof ProductFieldsApi */ updateProductField(requestParameters: ProductFieldsApiUpdateProductFieldRequest): Promise; /** * Updates existing options for a product 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 product field options in bulk * @param {ProductFieldsApiUpdateProductFieldOptionsRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof ProductFieldsApi */ updateProductFieldOptions(requestParameters: ProductFieldsApiUpdateProductFieldOptionsRequest): Promise; }