pipedrive 30.5.0 → 30.7.0

package/dist/esm/versions/v2/api/deal-fields-api.d.ts

@@ -0,0 +1,473 @@
+/**
+ * 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 { AddDealField200Response } from '../models';
+import { AddDealFieldOptions200Response } from '../models';
+import { AddDealFieldOptionsRequestInner } from '../models';
+import { AddDealFieldRequest } from '../models';
+import { DeleteDealField200Response } from '../models';
+import { DeleteDealFieldOptionsRequestInner } from '../models';
+import { GetDealFields200Response } from '../models';
+import { UpdateDealFieldOptionsRequestInner } from '../models';
+import { UpdateDealFieldRequest } from '../models';
+/**
+ * DealFieldsApi - axios parameter creator
+ * @export
+ */
+export declare const DealFieldsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Creates a new deal custom field.
+     * @summary Create one deal field
+     * @param {AddDealFieldRequest} AddDealFieldRequest
+
+     * @throws {RequiredError}
+     */
+    addDealField: (AddDealFieldRequest: AddDealFieldRequest) => Promise<RequestArgs>;
+    /**
+     * 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: string, AddDealFieldOptionsRequestInner: AddDealFieldOptionsRequestInner[]) => Promise<RequestArgs>;
+    /**
+     * 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: string) => Promise<RequestArgs>;
+    /**
+     * 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: string, DeleteDealFieldOptionsRequestInner: DeleteDealFieldOptionsRequestInner[]) => Promise<RequestArgs>;
+    /**
+     * 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: 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 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?: '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 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: string, UpdateDealFieldRequest: UpdateDealFieldRequest) => Promise<RequestArgs>;
+    /**
+     * 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: string, UpdateDealFieldOptionsRequestInner: UpdateDealFieldOptionsRequestInner[]) => Promise<RequestArgs>;
+};
+/**
+ * DealFieldsApi - functional programming interface
+ * @export
+ */
+export declare const DealFieldsApiFp: (configuration?: Configuration) => {
+    /**
+     * Creates a new deal custom field.
+     * @summary Create one deal field
+     * @param {AddDealFieldRequest} AddDealFieldRequest
+
+     * @throws {RequiredError}
+     */
+    addDealField(AddDealFieldRequest: AddDealFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealField200Response>>;
+    /**
+     * 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: string, AddDealFieldOptionsRequestInner: AddDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
+    /**
+     * 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: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteDealField200Response>>;
+    /**
+     * 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: string, DeleteDealFieldOptionsRequestInner: DeleteDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
+    /**
+     * 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: 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<AddDealField200Response>>;
+    /**
+     * 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?: '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<GetDealFields200Response>>;
+    /**
+     * 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: string, UpdateDealFieldRequest: UpdateDealFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealField200Response>>;
+    /**
+     * 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: string, UpdateDealFieldOptionsRequestInner: UpdateDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
+};
+/**
+ * DealFieldsApi - factory interface
+ * @export
+ */
+export declare const DealFieldsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Creates a new deal custom field.
+     * @summary Create one deal field
+     * @param {DealFieldsApiAddDealFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    addDealField(requestParameters: DealFieldsApiAddDealFieldRequest): Promise<AddDealField200Response>;
+    /**
+     * 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: DealFieldsApiAddDealFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    /**
+     * Marks a custom field as deleted.
+     * @summary Delete one deal field
+     * @param {DealFieldsApiDeleteDealFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    deleteDealField(requestParameters: DealFieldsApiDeleteDealFieldRequest): Promise<DeleteDealField200Response>;
+    /**
+     * 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: DealFieldsApiDeleteDealFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    /**
+     * Returns metadata about a specific deal field.
+     * @summary Get one deal field
+     * @param {DealFieldsApiGetDealFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getDealField(requestParameters: DealFieldsApiGetDealFieldRequest): Promise<AddDealField200Response>;
+    /**
+     * Returns metadata about all deal fields in the company.
+     * @summary Get all deal fields
+     * @param {DealFieldsApiGetDealFieldsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getDealFields(requestParameters?: DealFieldsApiGetDealFieldsRequest): Promise<GetDealFields200Response>;
+    /**
+     * 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: DealFieldsApiUpdateDealFieldRequest): Promise<AddDealField200Response>;
+    /**
+     * 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: DealFieldsApiUpdateDealFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+};
+/**
+ * Request parameters for addDealField operation in DealFieldsApi.
+ * @export
+ * @interface DealFieldsApiAddDealFieldRequest
+ */
+export interface DealFieldsApiAddDealFieldRequest {
+    /**
+     *
+     * @type {AddDealFieldRequest}
+     * @memberof DealFieldsApiAddDealField
+     */
+    readonly AddDealFieldRequest: AddDealFieldRequest;
+}
+/**
+ * Request parameters for addDealFieldOptions operation in DealFieldsApi.
+ * @export
+ * @interface DealFieldsApiAddDealFieldOptionsRequest
+ */
+export interface DealFieldsApiAddDealFieldOptionsRequest {
+    /**
+     * The unique code identifying the field
+     * @type {string}
+     * @memberof DealFieldsApiAddDealFieldOptions
+     */
+    readonly field_code: string;
+    /**
+     *
+     * @type {Array<AddDealFieldOptionsRequestInner>}
+     * @memberof DealFieldsApiAddDealFieldOptions
+     */
+    readonly AddDealFieldOptionsRequestInner: Array<AddDealFieldOptionsRequestInner>;
+}
+/**
+ * Request parameters for deleteDealField operation in DealFieldsApi.
+ * @export
+ * @interface DealFieldsApiDeleteDealFieldRequest
+ */
+export interface DealFieldsApiDeleteDealFieldRequest {
+    /**
+     * The unique code identifying the field
+     * @type {string}
+     * @memberof DealFieldsApiDeleteDealField
+     */
+    readonly field_code: string;
+}
+/**
+ * Request parameters for deleteDealFieldOptions operation in DealFieldsApi.
+ * @export
+ * @interface DealFieldsApiDeleteDealFieldOptionsRequest
+ */
+export interface DealFieldsApiDeleteDealFieldOptionsRequest {
+    /**
+     * The unique code identifying the field
+     * @type {string}
+     * @memberof DealFieldsApiDeleteDealFieldOptions
+     */
+    readonly field_code: string;
+    /**
+     *
+     * @type {Array<DeleteDealFieldOptionsRequestInner>}
+     * @memberof DealFieldsApiDeleteDealFieldOptions
+     */
+    readonly DeleteDealFieldOptionsRequestInner: Array<DeleteDealFieldOptionsRequestInner>;
+}
+/**
+ * Request parameters for getDealField operation in DealFieldsApi.
+ * @export
+ * @interface DealFieldsApiGetDealFieldRequest
+ */
+export interface DealFieldsApiGetDealFieldRequest {
+    /**
+     * The unique code identifying the field
+     * @type {string}
+     * @memberof DealFieldsApiGetDealField
+     */
+    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 DealFieldsApiGetDealField
+     */
+    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 getDealFields operation in DealFieldsApi.
+ * @export
+ * @interface DealFieldsApiGetDealFieldsRequest
+ */
+export interface DealFieldsApiGetDealFieldsRequest {
+    /**
+     * 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 DealFieldsApiGetDealFields
+     */
+    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 DealFieldsApiGetDealFields
+     */
+    readonly limit?: number;
+    /**
+     * For pagination, the marker (an opaque string value) representing the first item on the next page
+     * @type {string}
+     * @memberof DealFieldsApiGetDealFields
+     */
+    readonly cursor?: string;
+}
+/**
+ * Request parameters for updateDealField operation in DealFieldsApi.
+ * @export
+ * @interface DealFieldsApiUpdateDealFieldRequest
+ */
+export interface DealFieldsApiUpdateDealFieldRequest {
+    /**
+     * The unique code identifying the field
+     * @type {string}
+     * @memberof DealFieldsApiUpdateDealField
+     */
+    readonly field_code: string;
+    /**
+     *
+     * @type {UpdateDealFieldRequest}
+     * @memberof DealFieldsApiUpdateDealField
+     */
+    readonly UpdateDealFieldRequest: UpdateDealFieldRequest;
+}
+/**
+ * Request parameters for updateDealFieldOptions operation in DealFieldsApi.
+ * @export
+ * @interface DealFieldsApiUpdateDealFieldOptionsRequest
+ */
+export interface DealFieldsApiUpdateDealFieldOptionsRequest {
+    /**
+     * The unique code identifying the field
+     * @type {string}
+     * @memberof DealFieldsApiUpdateDealFieldOptions
+     */
+    readonly field_code: string;
+    /**
+     *
+     * @type {Array<UpdateDealFieldOptionsRequestInner>}
+     * @memberof DealFieldsApiUpdateDealFieldOptions
+     */
+    readonly UpdateDealFieldOptionsRequestInner: Array<UpdateDealFieldOptionsRequestInner>;
+}
+/**
+ * DealFieldsApi - object-oriented interface
+ * @export
+ * @class DealFieldsApi
+ * @extends {BaseAPI}
+ */
+export declare 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: DealFieldsApiAddDealFieldRequest): Promise<AddDealField200Response>;
+    /**
+     * 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: DealFieldsApiAddDealFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    /**
+     * Marks a custom field as deleted.
+     * @summary Delete one deal field
+     * @param {DealFieldsApiDeleteDealFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealFieldsApi
+     */
+    deleteDealField(requestParameters: DealFieldsApiDeleteDealFieldRequest): Promise<DeleteDealField200Response>;
+    /**
+     * 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: DealFieldsApiDeleteDealFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    /**
+     * Returns metadata about a specific deal field.
+     * @summary Get one deal field
+     * @param {DealFieldsApiGetDealFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealFieldsApi
+     */
+    getDealField(requestParameters: DealFieldsApiGetDealFieldRequest): Promise<AddDealField200Response>;
+    /**
+     * 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?: DealFieldsApiGetDealFieldsRequest): Promise<GetDealFields200Response>;
+    /**
+     * 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: DealFieldsApiUpdateDealFieldRequest): Promise<AddDealField200Response>;
+    /**
+     * 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: DealFieldsApiUpdateDealFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+}