/** * 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 { AddProjectBoardRequest } from '../models'; import { AddProjectField200Response } from '../models'; import { AddProjectFieldRequest } from '../models'; import { AddProjectPhaseRequest } from '../models'; import { AddTaskRequest } from '../models'; import { AddTaskResponse } from '../models'; import { DeleteDealFieldOptionsRequestInner } from '../models'; import { DeleteProjectBoardResponse } from '../models'; import { DeleteProjectField200Response } from '../models'; import { DeleteProjectPhaseResponse } from '../models'; import { DeleteTaskResponse } from '../models'; import { GetProjectBoardsResponse } from '../models'; import { GetProjectFields200Response } from '../models'; import { GetProjectPhasesResponse } from '../models'; import { GetProjectSearchResponse } from '../models'; import { GetTaskResponse } from '../models'; import { GetTasksResponse } from '../models'; import { UpdateDealFieldOptionsRequestInner } from '../models'; import { UpdateProjectBoardRequest } from '../models'; import { UpdateProjectFieldRequest } from '../models'; import { UpdateProjectPhaseRequest } from '../models'; import { UpdateTaskRequest } from '../models'; import { UpdateTaskResponse } from '../models'; import { UpsertProjectBoardResponse } from '../models'; import { UpsertProjectPhaseResponse } from '../models'; /** * BetaApi - axios parameter creator * @export */ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) => { /** * Adds a new project board. * @summary Add a project board * @param {AddProjectBoardRequest} AddProjectBoardRequest * @throws {RequiredError} */ addProjectBoard: (AddProjectBoardRequest: AddProjectBoardRequest) => Promise; /** * 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; /** * Adds a new project phase to a board. * @summary Add a project phase * @param {AddProjectPhaseRequest} AddProjectPhaseRequest * @throws {RequiredError} */ addProjectPhase: (AddProjectPhaseRequest: AddProjectPhaseRequest) => Promise; /** * Adds a new task. * @summary Add a task * @param {AddTaskRequest} AddTaskRequest * @throws {RequiredError} */ addTask: (AddTaskRequest: AddTaskRequest) => Promise; /** * Marks a project board as deleted. * @summary Delete a project board * @param {number} id The ID of the project board * @throws {RequiredError} */ deleteProjectBoard: (id: number) => 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; /** * Marks a project phase as deleted. * @summary Delete a project phase * @param {number} id The ID of the project phase * @throws {RequiredError} */ deleteProjectPhase: (id: number) => Promise; /** * Marks a task as deleted. If the task has subtasks, those will also be deleted. * @summary Delete a task * @param {number} id The ID of the task * @throws {RequiredError} */ deleteTask: (id: number) => 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; /** * Returns the details of a specific project board. * @summary Get details of a project board * @param {number} id The ID of the project board * @throws {RequiredError} */ getProjectsBoard: (id: number) => Promise; /** * Returns all active project boards. * @summary Get all project boards * @throws {RequiredError} */ getProjectsBoards: () => Promise; /** * Returns the details of a specific project phase. * @summary Get details of a project phase * @param {number} id The ID of the project phase * @throws {RequiredError} */ getProjectsPhase: (id: number) => Promise; /** * Returns all active project phases under a specific board. * @summary Get project phases * @param {number} board_id The ID of the board for which phases are requested * @throws {RequiredError} */ getProjectsPhases: (board_id: number) => Promise; /** * Returns the details of a specific task. * @summary Get details of a task * @param {number} id The ID of the task * @throws {RequiredError} */ getTask: (id: number) => Promise; /** * Returns all tasks. * @summary Get all tasks * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page * @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 {boolean} [is_done] Whether the task is done or not. If omitted, both done and not done tasks are returned. * @param {boolean} [is_milestone] Whether the task is a milestone or not. If omitted, both milestone and non-milestone tasks are returned. * @param {number} [assignee_id] If supplied, only tasks assigned to this user are returned * @param {number} [project_id] If supplied, only tasks belonging to this project are returned * @param {string} [parent_task_id] If `null` is supplied, only root-level tasks (without a parent) are returned. If an integer is supplied, only subtasks of that specific task are returned. By default all tasks are returned. * @throws {RequiredError} */ getTasks: (cursor?: string, limit?: number, is_done?: boolean, is_milestone?: boolean, assignee_id?: number, project_id?: number, parent_task_id?: string) => Promise; /** * Searches all projects by title, description, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. Found projects can be filtered by person ID or organization ID. * @summary Search projects * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded. * @param {'custom_fields' | 'notes' | 'title' | 'description'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. * @param {number} [person_id] Will filter projects by the provided person ID * @param {number} [organization_id] Will filter projects by the provided organization ID * @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} */ searchProjects: (term: string, fields?: 'custom_fields' | 'notes' | 'title' | 'description', exact_match?: boolean, person_id?: number, organization_id?: number, limit?: number, cursor?: string) => Promise; /** * Updates the properties of a project board. * @summary Update a project board * @param {number} id The ID of the project board * @param {UpdateProjectBoardRequest} [UpdateProjectBoardRequest] * @throws {RequiredError} */ updateProjectBoard: (id: number, UpdateProjectBoardRequest?: UpdateProjectBoardRequest) => 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; /** * Updates the properties of a project phase. * @summary Update a project phase * @param {number} id The ID of the project phase * @param {UpdateProjectPhaseRequest} [UpdateProjectPhaseRequest] * @throws {RequiredError} */ updateProjectPhase: (id: number, UpdateProjectPhaseRequest?: UpdateProjectPhaseRequest) => Promise; /** * Updates a task. * @summary Update a task * @param {number} id The ID of the task * @param {UpdateTaskRequest} [UpdateTaskRequest] * @throws {RequiredError} */ updateTask: (id: number, UpdateTaskRequest?: UpdateTaskRequest) => Promise; }; /** * BetaApi - functional programming interface * @export */ export declare const BetaApiFp: (configuration?: Configuration) => { /** * Adds a new project board. * @summary Add a project board * @param {AddProjectBoardRequest} AddProjectBoardRequest * @throws {RequiredError} */ addProjectBoard(AddProjectBoardRequest: AddProjectBoardRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * 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>; /** * Adds a new project phase to a board. * @summary Add a project phase * @param {AddProjectPhaseRequest} AddProjectPhaseRequest * @throws {RequiredError} */ addProjectPhase(AddProjectPhaseRequest: AddProjectPhaseRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Adds a new task. * @summary Add a task * @param {AddTaskRequest} AddTaskRequest * @throws {RequiredError} */ addTask(AddTaskRequest: AddTaskRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Marks a project board as deleted. * @summary Delete a project board * @param {number} id The ID of the project board * @throws {RequiredError} */ deleteProjectBoard(id: number): 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>; /** * Marks a project phase as deleted. * @summary Delete a project phase * @param {number} id The ID of the project phase * @throws {RequiredError} */ deleteProjectPhase(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Marks a task as deleted. If the task has subtasks, those will also be deleted. * @summary Delete a task * @param {number} id The ID of the task * @throws {RequiredError} */ deleteTask(id: number): 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>; /** * Returns the details of a specific project board. * @summary Get details of a project board * @param {number} id The ID of the project board * @throws {RequiredError} */ getProjectsBoard(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Returns all active project boards. * @summary Get all project boards * @throws {RequiredError} */ getProjectsBoards(): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Returns the details of a specific project phase. * @summary Get details of a project phase * @param {number} id The ID of the project phase * @throws {RequiredError} */ getProjectsPhase(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Returns all active project phases under a specific board. * @summary Get project phases * @param {number} board_id The ID of the board for which phases are requested * @throws {RequiredError} */ getProjectsPhases(board_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Returns the details of a specific task. * @summary Get details of a task * @param {number} id The ID of the task * @throws {RequiredError} */ getTask(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Returns all tasks. * @summary Get all tasks * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page * @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 {boolean} [is_done] Whether the task is done or not. If omitted, both done and not done tasks are returned. * @param {boolean} [is_milestone] Whether the task is a milestone or not. If omitted, both milestone and non-milestone tasks are returned. * @param {number} [assignee_id] If supplied, only tasks assigned to this user are returned * @param {number} [project_id] If supplied, only tasks belonging to this project are returned * @param {string} [parent_task_id] If `null` is supplied, only root-level tasks (without a parent) are returned. If an integer is supplied, only subtasks of that specific task are returned. By default all tasks are returned. * @throws {RequiredError} */ getTasks(cursor?: string, limit?: number, is_done?: boolean, is_milestone?: boolean, assignee_id?: number, project_id?: number, parent_task_id?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Searches all projects by title, description, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. Found projects can be filtered by person ID or organization ID. * @summary Search projects * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded. * @param {'custom_fields' | 'notes' | 'title' | 'description'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. * @param {number} [person_id] Will filter projects by the provided person ID * @param {number} [organization_id] Will filter projects by the provided organization ID * @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} */ searchProjects(term: string, fields?: 'custom_fields' | 'notes' | 'title' | 'description', exact_match?: boolean, person_id?: number, organization_id?: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Updates the properties of a project board. * @summary Update a project board * @param {number} id The ID of the project board * @param {UpdateProjectBoardRequest} [UpdateProjectBoardRequest] * @throws {RequiredError} */ updateProjectBoard(id: number, UpdateProjectBoardRequest?: UpdateProjectBoardRequest): 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>; /** * Updates the properties of a project phase. * @summary Update a project phase * @param {number} id The ID of the project phase * @param {UpdateProjectPhaseRequest} [UpdateProjectPhaseRequest] * @throws {RequiredError} */ updateProjectPhase(id: number, UpdateProjectPhaseRequest?: UpdateProjectPhaseRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Updates a task. * @summary Update a task * @param {number} id The ID of the task * @param {UpdateTaskRequest} [UpdateTaskRequest] * @throws {RequiredError} */ updateTask(id: number, UpdateTaskRequest?: UpdateTaskRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; }; /** * BetaApi - factory interface * @export */ export declare const BetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Adds a new project board. * @summary Add a project board * @param {BetaApiAddProjectBoardRequest} requestParameters Request parameters. * @throws {RequiredError} */ addProjectBoard(requestParameters: BetaApiAddProjectBoardRequest): Promise; /** * Creates a new project custom field. * @summary Create one project field * @param {BetaApiAddProjectFieldRequest} requestParameters Request parameters. * @throws {RequiredError} */ addProjectField(requestParameters: BetaApiAddProjectFieldRequest): 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 {BetaApiAddProjectFieldOptionsRequest} requestParameters Request parameters. * @throws {RequiredError} */ addProjectFieldOptions(requestParameters: BetaApiAddProjectFieldOptionsRequest): Promise; /** * Adds a new project phase to a board. * @summary Add a project phase * @param {BetaApiAddProjectPhaseRequest} requestParameters Request parameters. * @throws {RequiredError} */ addProjectPhase(requestParameters: BetaApiAddProjectPhaseRequest): Promise; /** * Adds a new task. * @summary Add a task * @param {BetaApiAddTaskRequest} requestParameters Request parameters. * @throws {RequiredError} */ addTask(requestParameters: BetaApiAddTaskRequest): Promise; /** * Marks a project board as deleted. * @summary Delete a project board * @param {BetaApiDeleteProjectBoardRequest} requestParameters Request parameters. * @throws {RequiredError} */ deleteProjectBoard(requestParameters: BetaApiDeleteProjectBoardRequest): Promise; /** * Marks a custom field as deleted. * @summary Delete one project field * @param {BetaApiDeleteProjectFieldRequest} requestParameters Request parameters. * @throws {RequiredError} */ deleteProjectField(requestParameters: BetaApiDeleteProjectFieldRequest): 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 {BetaApiDeleteProjectFieldOptionsRequest} requestParameters Request parameters. * @throws {RequiredError} */ deleteProjectFieldOptions(requestParameters: BetaApiDeleteProjectFieldOptionsRequest): Promise; /** * Marks a project phase as deleted. * @summary Delete a project phase * @param {BetaApiDeleteProjectPhaseRequest} requestParameters Request parameters. * @throws {RequiredError} */ deleteProjectPhase(requestParameters: BetaApiDeleteProjectPhaseRequest): Promise; /** * Marks a task as deleted. If the task has subtasks, those will also be deleted. * @summary Delete a task * @param {BetaApiDeleteTaskRequest} requestParameters Request parameters. * @throws {RequiredError} */ deleteTask(requestParameters: BetaApiDeleteTaskRequest): Promise; /** * Returns metadata about a specific project field. * @summary Get one project field * @param {BetaApiGetProjectFieldRequest} requestParameters Request parameters. * @throws {RequiredError} */ getProjectField(requestParameters: BetaApiGetProjectFieldRequest): Promise; /** * Returns metadata about all project fields in the company. * @summary Get all project fields * @param {BetaApiGetProjectFieldsRequest} requestParameters Request parameters. * @throws {RequiredError} */ getProjectFields(requestParameters?: BetaApiGetProjectFieldsRequest): Promise; /** * Returns the details of a specific project board. * @summary Get details of a project board * @param {BetaApiGetProjectsBoardRequest} requestParameters Request parameters. * @throws {RequiredError} */ getProjectsBoard(requestParameters: BetaApiGetProjectsBoardRequest): Promise; /** * Returns all active project boards. * @summary Get all project boards * @throws {RequiredError} */ getProjectsBoards(): Promise; /** * Returns the details of a specific project phase. * @summary Get details of a project phase * @param {BetaApiGetProjectsPhaseRequest} requestParameters Request parameters. * @throws {RequiredError} */ getProjectsPhase(requestParameters: BetaApiGetProjectsPhaseRequest): Promise; /** * Returns all active project phases under a specific board. * @summary Get project phases * @param {BetaApiGetProjectsPhasesRequest} requestParameters Request parameters. * @throws {RequiredError} */ getProjectsPhases(requestParameters: BetaApiGetProjectsPhasesRequest): Promise; /** * Returns the details of a specific task. * @summary Get details of a task * @param {BetaApiGetTaskRequest} requestParameters Request parameters. * @throws {RequiredError} */ getTask(requestParameters: BetaApiGetTaskRequest): Promise; /** * Returns all tasks. * @summary Get all tasks * @param {BetaApiGetTasksRequest} requestParameters Request parameters. * @throws {RequiredError} */ getTasks(requestParameters?: BetaApiGetTasksRequest): Promise; /** * Searches all projects by title, description, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. Found projects can be filtered by person ID or organization ID. * @summary Search projects * @param {BetaApiSearchProjectsRequest} requestParameters Request parameters. * @throws {RequiredError} */ searchProjects(requestParameters: BetaApiSearchProjectsRequest): Promise; /** * Updates the properties of a project board. * @summary Update a project board * @param {BetaApiUpdateProjectBoardRequest} requestParameters Request parameters. * @throws {RequiredError} */ updateProjectBoard(requestParameters: BetaApiUpdateProjectBoardRequest): 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 {BetaApiUpdateProjectFieldRequest} requestParameters Request parameters. * @throws {RequiredError} */ updateProjectField(requestParameters: BetaApiUpdateProjectFieldRequest): 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 {BetaApiUpdateProjectFieldOptionsRequest} requestParameters Request parameters. * @throws {RequiredError} */ updateProjectFieldOptions(requestParameters: BetaApiUpdateProjectFieldOptionsRequest): Promise; /** * Updates the properties of a project phase. * @summary Update a project phase * @param {BetaApiUpdateProjectPhaseRequest} requestParameters Request parameters. * @throws {RequiredError} */ updateProjectPhase(requestParameters: BetaApiUpdateProjectPhaseRequest): Promise; /** * Updates a task. * @summary Update a task * @param {BetaApiUpdateTaskRequest} requestParameters Request parameters. * @throws {RequiredError} */ updateTask(requestParameters: BetaApiUpdateTaskRequest): Promise; }; /** * Request parameters for addProjectBoard operation in BetaApi. * @export * @interface BetaApiAddProjectBoardRequest */ export interface BetaApiAddProjectBoardRequest { /** * * @type {AddProjectBoardRequest} * @memberof BetaApiAddProjectBoard */ readonly AddProjectBoardRequest: AddProjectBoardRequest; } /** * Request parameters for addProjectField operation in BetaApi. * @export * @interface BetaApiAddProjectFieldRequest */ export interface BetaApiAddProjectFieldRequest { /** * * @type {AddProjectFieldRequest} * @memberof BetaApiAddProjectField */ readonly AddProjectFieldRequest: AddProjectFieldRequest; } /** * Request parameters for addProjectFieldOptions operation in BetaApi. * @export * @interface BetaApiAddProjectFieldOptionsRequest */ export interface BetaApiAddProjectFieldOptionsRequest { /** * The unique code identifying the field * @type {string} * @memberof BetaApiAddProjectFieldOptions */ readonly field_code: string; /** * * @type {Array} * @memberof BetaApiAddProjectFieldOptions */ readonly AddDealFieldOptionsRequestInner: Array; } /** * Request parameters for addProjectPhase operation in BetaApi. * @export * @interface BetaApiAddProjectPhaseRequest */ export interface BetaApiAddProjectPhaseRequest { /** * * @type {AddProjectPhaseRequest} * @memberof BetaApiAddProjectPhase */ readonly AddProjectPhaseRequest: AddProjectPhaseRequest; } /** * Request parameters for addTask operation in BetaApi. * @export * @interface BetaApiAddTaskRequest */ export interface BetaApiAddTaskRequest { /** * * @type {AddTaskRequest} * @memberof BetaApiAddTask */ readonly AddTaskRequest: AddTaskRequest; } /** * Request parameters for deleteProjectBoard operation in BetaApi. * @export * @interface BetaApiDeleteProjectBoardRequest */ export interface BetaApiDeleteProjectBoardRequest { /** * The ID of the project board * @type {number} * @memberof BetaApiDeleteProjectBoard */ readonly id: number; } /** * Request parameters for deleteProjectField operation in BetaApi. * @export * @interface BetaApiDeleteProjectFieldRequest */ export interface BetaApiDeleteProjectFieldRequest { /** * The unique code identifying the field * @type {string} * @memberof BetaApiDeleteProjectField */ readonly field_code: string; } /** * Request parameters for deleteProjectFieldOptions operation in BetaApi. * @export * @interface BetaApiDeleteProjectFieldOptionsRequest */ export interface BetaApiDeleteProjectFieldOptionsRequest { /** * The unique code identifying the field * @type {string} * @memberof BetaApiDeleteProjectFieldOptions */ readonly field_code: string; /** * * @type {Array} * @memberof BetaApiDeleteProjectFieldOptions */ readonly DeleteDealFieldOptionsRequestInner: Array; } /** * Request parameters for deleteProjectPhase operation in BetaApi. * @export * @interface BetaApiDeleteProjectPhaseRequest */ export interface BetaApiDeleteProjectPhaseRequest { /** * The ID of the project phase * @type {number} * @memberof BetaApiDeleteProjectPhase */ readonly id: number; } /** * Request parameters for deleteTask operation in BetaApi. * @export * @interface BetaApiDeleteTaskRequest */ export interface BetaApiDeleteTaskRequest { /** * The ID of the task * @type {number} * @memberof BetaApiDeleteTask */ readonly id: number; } /** * Request parameters for getProjectField operation in BetaApi. * @export * @interface BetaApiGetProjectFieldRequest */ export interface BetaApiGetProjectFieldRequest { /** * The unique code identifying the field * @type {string} * @memberof BetaApiGetProjectField */ readonly field_code: string; } /** * Request parameters for getProjectFields operation in BetaApi. * @export * @interface BetaApiGetProjectFieldsRequest */ export interface BetaApiGetProjectFieldsRequest { /** * 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 BetaApiGetProjectFields */ readonly limit?: number; /** * For pagination, the marker (an opaque string value) representing the first item on the next page * @type {string} * @memberof BetaApiGetProjectFields */ readonly cursor?: string; } /** * Request parameters for getProjectsBoard operation in BetaApi. * @export * @interface BetaApiGetProjectsBoardRequest */ export interface BetaApiGetProjectsBoardRequest { /** * The ID of the project board * @type {number} * @memberof BetaApiGetProjectsBoard */ readonly id: number; } /** * Request parameters for getProjectsPhase operation in BetaApi. * @export * @interface BetaApiGetProjectsPhaseRequest */ export interface BetaApiGetProjectsPhaseRequest { /** * The ID of the project phase * @type {number} * @memberof BetaApiGetProjectsPhase */ readonly id: number; } /** * Request parameters for getProjectsPhases operation in BetaApi. * @export * @interface BetaApiGetProjectsPhasesRequest */ export interface BetaApiGetProjectsPhasesRequest { /** * The ID of the board for which phases are requested * @type {number} * @memberof BetaApiGetProjectsPhases */ readonly board_id: number; } /** * Request parameters for getTask operation in BetaApi. * @export * @interface BetaApiGetTaskRequest */ export interface BetaApiGetTaskRequest { /** * The ID of the task * @type {number} * @memberof BetaApiGetTask */ readonly id: number; } /** * Request parameters for getTasks operation in BetaApi. * @export * @interface BetaApiGetTasksRequest */ export interface BetaApiGetTasksRequest { /** * For pagination, the marker (an opaque string value) representing the first item on the next page * @type {string} * @memberof BetaApiGetTasks */ readonly cursor?: string; /** * 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 BetaApiGetTasks */ readonly limit?: number; /** * Whether the task is done or not. If omitted, both done and not done tasks are returned. * @type {boolean} * @memberof BetaApiGetTasks */ readonly is_done?: boolean; /** * Whether the task is a milestone or not. If omitted, both milestone and non-milestone tasks are returned. * @type {boolean} * @memberof BetaApiGetTasks */ readonly is_milestone?: boolean; /** * If supplied, only tasks assigned to this user are returned * @type {number} * @memberof BetaApiGetTasks */ readonly assignee_id?: number; /** * If supplied, only tasks belonging to this project are returned * @type {number} * @memberof BetaApiGetTasks */ readonly project_id?: number; /** * If `null` is supplied, only root-level tasks (without a parent) are returned. If an integer is supplied, only subtasks of that specific task are returned. By default all tasks are returned. * @type {string} * @memberof BetaApiGetTasks */ readonly parent_task_id?: string; } /** * Request parameters for searchProjects operation in BetaApi. * @export * @interface BetaApiSearchProjectsRequest */ export interface BetaApiSearchProjectsRequest { /** * The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded. * @type {string} * @memberof BetaApiSearchProjects */ readonly term: string; /** * A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. * @type {'custom_fields' | 'notes' | 'title' | 'description'} * @memberof BetaApiSearchProjects */ readonly fields?: 'custom_fields' | 'notes' | 'title' | 'description'; /** * When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. * @type {boolean} * @memberof BetaApiSearchProjects */ readonly exact_match?: boolean; /** * Will filter projects by the provided person ID * @type {number} * @memberof BetaApiSearchProjects */ readonly person_id?: number; /** * Will filter projects by the provided organization ID * @type {number} * @memberof BetaApiSearchProjects */ readonly organization_id?: number; /** * 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 BetaApiSearchProjects */ readonly limit?: number; /** * For pagination, the marker (an opaque string value) representing the first item on the next page * @type {string} * @memberof BetaApiSearchProjects */ readonly cursor?: string; } /** * Request parameters for updateProjectBoard operation in BetaApi. * @export * @interface BetaApiUpdateProjectBoardRequest */ export interface BetaApiUpdateProjectBoardRequest { /** * The ID of the project board * @type {number} * @memberof BetaApiUpdateProjectBoard */ readonly id: number; /** * * @type {UpdateProjectBoardRequest} * @memberof BetaApiUpdateProjectBoard */ readonly UpdateProjectBoardRequest?: UpdateProjectBoardRequest; } /** * Request parameters for updateProjectField operation in BetaApi. * @export * @interface BetaApiUpdateProjectFieldRequest */ export interface BetaApiUpdateProjectFieldRequest { /** * The unique code identifying the field * @type {string} * @memberof BetaApiUpdateProjectField */ readonly field_code: string; /** * * @type {UpdateProjectFieldRequest} * @memberof BetaApiUpdateProjectField */ readonly UpdateProjectFieldRequest: UpdateProjectFieldRequest; } /** * Request parameters for updateProjectFieldOptions operation in BetaApi. * @export * @interface BetaApiUpdateProjectFieldOptionsRequest */ export interface BetaApiUpdateProjectFieldOptionsRequest { /** * The unique code identifying the field * @type {string} * @memberof BetaApiUpdateProjectFieldOptions */ readonly field_code: string; /** * * @type {Array} * @memberof BetaApiUpdateProjectFieldOptions */ readonly UpdateDealFieldOptionsRequestInner: Array; } /** * Request parameters for updateProjectPhase operation in BetaApi. * @export * @interface BetaApiUpdateProjectPhaseRequest */ export interface BetaApiUpdateProjectPhaseRequest { /** * The ID of the project phase * @type {number} * @memberof BetaApiUpdateProjectPhase */ readonly id: number; /** * * @type {UpdateProjectPhaseRequest} * @memberof BetaApiUpdateProjectPhase */ readonly UpdateProjectPhaseRequest?: UpdateProjectPhaseRequest; } /** * Request parameters for updateTask operation in BetaApi. * @export * @interface BetaApiUpdateTaskRequest */ export interface BetaApiUpdateTaskRequest { /** * The ID of the task * @type {number} * @memberof BetaApiUpdateTask */ readonly id: number; /** * * @type {UpdateTaskRequest} * @memberof BetaApiUpdateTask */ readonly UpdateTaskRequest?: UpdateTaskRequest; } /** * BetaApi - object-oriented interface * @export * @class BetaApi * @extends {BaseAPI} */ export declare class BetaApi extends BaseAPI { /** * Adds a new project board. * @summary Add a project board * @param {BetaApiAddProjectBoardRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof BetaApi */ addProjectBoard(requestParameters: BetaApiAddProjectBoardRequest): Promise; /** * Creates a new project custom field. * @summary Create one project field * @param {BetaApiAddProjectFieldRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof BetaApi */ addProjectField(requestParameters: BetaApiAddProjectFieldRequest): 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 {BetaApiAddProjectFieldOptionsRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof BetaApi */ addProjectFieldOptions(requestParameters: BetaApiAddProjectFieldOptionsRequest): Promise; /** * Adds a new project phase to a board. * @summary Add a project phase * @param {BetaApiAddProjectPhaseRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof BetaApi */ addProjectPhase(requestParameters: BetaApiAddProjectPhaseRequest): Promise; /** * Adds a new task. * @summary Add a task * @param {BetaApiAddTaskRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof BetaApi */ addTask(requestParameters: BetaApiAddTaskRequest): Promise; /** * Marks a project board as deleted. * @summary Delete a project board * @param {BetaApiDeleteProjectBoardRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof BetaApi */ deleteProjectBoard(requestParameters: BetaApiDeleteProjectBoardRequest): Promise; /** * Marks a custom field as deleted. * @summary Delete one project field * @param {BetaApiDeleteProjectFieldRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof BetaApi */ deleteProjectField(requestParameters: BetaApiDeleteProjectFieldRequest): 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 {BetaApiDeleteProjectFieldOptionsRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof BetaApi */ deleteProjectFieldOptions(requestParameters: BetaApiDeleteProjectFieldOptionsRequest): Promise; /** * Marks a project phase as deleted. * @summary Delete a project phase * @param {BetaApiDeleteProjectPhaseRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof BetaApi */ deleteProjectPhase(requestParameters: BetaApiDeleteProjectPhaseRequest): Promise; /** * Marks a task as deleted. If the task has subtasks, those will also be deleted. * @summary Delete a task * @param {BetaApiDeleteTaskRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof BetaApi */ deleteTask(requestParameters: BetaApiDeleteTaskRequest): Promise; /** * Returns metadata about a specific project field. * @summary Get one project field * @param {BetaApiGetProjectFieldRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof BetaApi */ getProjectField(requestParameters: BetaApiGetProjectFieldRequest): Promise; /** * Returns metadata about all project fields in the company. * @summary Get all project fields * @param {BetaApiGetProjectFieldsRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof BetaApi */ getProjectFields(requestParameters?: BetaApiGetProjectFieldsRequest): Promise; /** * Returns the details of a specific project board. * @summary Get details of a project board * @param {BetaApiGetProjectsBoardRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof BetaApi */ getProjectsBoard(requestParameters: BetaApiGetProjectsBoardRequest): Promise; /** * Returns all active project boards. * @summary Get all project boards * @throws {RequiredError} * @memberof BetaApi */ getProjectsBoards(): Promise; /** * Returns the details of a specific project phase. * @summary Get details of a project phase * @param {BetaApiGetProjectsPhaseRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof BetaApi */ getProjectsPhase(requestParameters: BetaApiGetProjectsPhaseRequest): Promise; /** * Returns all active project phases under a specific board. * @summary Get project phases * @param {BetaApiGetProjectsPhasesRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof BetaApi */ getProjectsPhases(requestParameters: BetaApiGetProjectsPhasesRequest): Promise; /** * Returns the details of a specific task. * @summary Get details of a task * @param {BetaApiGetTaskRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof BetaApi */ getTask(requestParameters: BetaApiGetTaskRequest): Promise; /** * Returns all tasks. * @summary Get all tasks * @param {BetaApiGetTasksRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof BetaApi */ getTasks(requestParameters?: BetaApiGetTasksRequest): Promise; /** * Searches all projects by title, description, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. Found projects can be filtered by person ID or organization ID. * @summary Search projects * @param {BetaApiSearchProjectsRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof BetaApi */ searchProjects(requestParameters: BetaApiSearchProjectsRequest): Promise; /** * Updates the properties of a project board. * @summary Update a project board * @param {BetaApiUpdateProjectBoardRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof BetaApi */ updateProjectBoard(requestParameters: BetaApiUpdateProjectBoardRequest): 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 {BetaApiUpdateProjectFieldRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof BetaApi */ updateProjectField(requestParameters: BetaApiUpdateProjectFieldRequest): 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 {BetaApiUpdateProjectFieldOptionsRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof BetaApi */ updateProjectFieldOptions(requestParameters: BetaApiUpdateProjectFieldOptionsRequest): Promise; /** * Updates the properties of a project phase. * @summary Update a project phase * @param {BetaApiUpdateProjectPhaseRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof BetaApi */ updateProjectPhase(requestParameters: BetaApiUpdateProjectPhaseRequest): Promise; /** * Updates a task. * @summary Update a task * @param {BetaApiUpdateTaskRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof BetaApi */ updateTask(requestParameters: BetaApiUpdateTaskRequest): Promise; }