pipedrive 32.2.0 → 33.0.0

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

@@ -0,0 +1,457 @@
+/**
+ * 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<RequestArgs>;
+    /**
+     * 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>} AddDealFieldOptionsRequestInner
+
+     * @throws {RequiredError}
+     */
+    addProjectFieldOptions: (field_code: string, AddDealFieldOptionsRequestInner: AddDealFieldOptionsRequestInner[]) => Promise<RequestArgs>;
+    /**
+     * 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<RequestArgs>;
+    /**
+     * 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>} DeleteDealFieldOptionsRequestInner
+
+     * @throws {RequiredError}
+     */
+    deleteProjectFieldOptions: (field_code: string, DeleteDealFieldOptionsRequestInner: DeleteDealFieldOptionsRequestInner[]) => Promise<RequestArgs>;
+    /**
+     * 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<RequestArgs>;
+    /**
+     * 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<RequestArgs>;
+    /**
+     * 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<RequestArgs>;
+    /**
+     * 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>} UpdateDealFieldOptionsRequestInner
+
+     * @throws {RequiredError}
+     */
+    updateProjectFieldOptions: (field_code: string, UpdateDealFieldOptionsRequestInner: UpdateDealFieldOptionsRequestInner[]) => Promise<RequestArgs>;
+};
+/**
+ * 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<AddProjectField200Response>>;
+    /**
+     * 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>} AddDealFieldOptionsRequestInner
+
+     * @throws {RequiredError}
+     */
+    addProjectFieldOptions(field_code: string, AddDealFieldOptionsRequestInner: AddDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
+    /**
+     * 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<DeleteProjectField200Response>>;
+    /**
+     * 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>} DeleteDealFieldOptionsRequestInner
+
+     * @throws {RequiredError}
+     */
+    deleteProjectFieldOptions(field_code: string, DeleteDealFieldOptionsRequestInner: DeleteDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
+    /**
+     * 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<AddProjectField200Response>>;
+    /**
+     * 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<GetProjectFields200Response>>;
+    /**
+     * 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<AddProjectField200Response>>;
+    /**
+     * 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>} UpdateDealFieldOptionsRequestInner
+
+     * @throws {RequiredError}
+     */
+    updateProjectFieldOptions(field_code: string, UpdateDealFieldOptionsRequestInner: UpdateDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
+};
+/**
+ * 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<AddProjectField200Response>;
+    /**
+     * 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<AddDealFieldOptions200Response>;
+    /**
+     * Marks a custom field as deleted.
+     * @summary Delete one project field
+     * @param {ProjectFieldsApiDeleteProjectFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    deleteProjectField(requestParameters: ProjectFieldsApiDeleteProjectFieldRequest): Promise<DeleteProjectField200Response>;
+    /**
+     * 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<AddDealFieldOptions200Response>;
+    /**
+     * Returns metadata about a specific project field.
+     * @summary Get one project field
+     * @param {ProjectFieldsApiGetProjectFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getProjectField(requestParameters: ProjectFieldsApiGetProjectFieldRequest): Promise<AddProjectField200Response>;
+    /**
+     * 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<GetProjectFields200Response>;
+    /**
+     * 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<AddProjectField200Response>;
+    /**
+     * 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<AddDealFieldOptions200Response>;
+};
+/**
+ * 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<AddDealFieldOptionsRequestInner>}
+     * @memberof ProjectFieldsApiAddProjectFieldOptions
+     */
+    readonly AddDealFieldOptionsRequestInner: Array<AddDealFieldOptionsRequestInner>;
+}
+/**
+ * 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<DeleteDealFieldOptionsRequestInner>}
+     * @memberof ProjectFieldsApiDeleteProjectFieldOptions
+     */
+    readonly DeleteDealFieldOptionsRequestInner: Array<DeleteDealFieldOptionsRequestInner>;
+}
+/**
+ * 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<UpdateDealFieldOptionsRequestInner>}
+     * @memberof ProjectFieldsApiUpdateProjectFieldOptions
+     */
+    readonly UpdateDealFieldOptionsRequestInner: Array<UpdateDealFieldOptionsRequestInner>;
+}
+/**
+ * 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<AddProjectField200Response>;
+    /**
+     * 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<AddDealFieldOptions200Response>;
+    /**
+     * Marks a custom field as deleted.
+     * @summary Delete one project field
+     * @param {ProjectFieldsApiDeleteProjectFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProjectFieldsApi
+     */
+    deleteProjectField(requestParameters: ProjectFieldsApiDeleteProjectFieldRequest): Promise<DeleteProjectField200Response>;
+    /**
+     * 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<AddDealFieldOptions200Response>;
+    /**
+     * 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<AddProjectField200Response>;
+    /**
+     * 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<GetProjectFields200Response>;
+    /**
+     * 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<AddProjectField200Response>;
+    /**
+     * 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<AddDealFieldOptions200Response>;
+}