/** * 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 { AddProjectPhaseRequest } from '../models'; import { DeleteProjectPhaseResponse } from '../models'; import { GetProjectPhasesResponse } from '../models'; import { UpdateProjectPhaseRequest } from '../models'; import { UpsertProjectPhaseResponse } from '../models'; /** * ProjectPhasesApi - axios parameter creator * @export */ export declare const ProjectPhasesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Adds a new project phase to a board. * @summary Add a project phase * @param {AddProjectPhaseRequest} AddProjectPhaseRequest * @throws {RequiredError} */ addProjectPhase: (AddProjectPhaseRequest: AddProjectPhaseRequest) => 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; /** * 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; /** * 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; }; /** * ProjectPhasesApi - functional programming interface * @export */ export declare const ProjectPhasesApiFp: (configuration?: Configuration) => { /** * 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>; /** * 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>; /** * 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>; /** * 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>; }; /** * ProjectPhasesApi - factory interface * @export */ export declare const ProjectPhasesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Adds a new project phase to a board. * @summary Add a project phase * @param {ProjectPhasesApiAddProjectPhaseRequest} requestParameters Request parameters. * @throws {RequiredError} */ addProjectPhase(requestParameters: ProjectPhasesApiAddProjectPhaseRequest): Promise; /** * Marks a project phase as deleted. * @summary Delete a project phase * @param {ProjectPhasesApiDeleteProjectPhaseRequest} requestParameters Request parameters. * @throws {RequiredError} */ deleteProjectPhase(requestParameters: ProjectPhasesApiDeleteProjectPhaseRequest): Promise; /** * Returns the details of a specific project phase. * @summary Get details of a project phase * @param {ProjectPhasesApiGetProjectsPhaseRequest} requestParameters Request parameters. * @throws {RequiredError} */ getProjectsPhase(requestParameters: ProjectPhasesApiGetProjectsPhaseRequest): Promise; /** * Returns all active project phases under a specific board. * @summary Get project phases * @param {ProjectPhasesApiGetProjectsPhasesRequest} requestParameters Request parameters. * @throws {RequiredError} */ getProjectsPhases(requestParameters: ProjectPhasesApiGetProjectsPhasesRequest): Promise; /** * Updates the properties of a project phase. * @summary Update a project phase * @param {ProjectPhasesApiUpdateProjectPhaseRequest} requestParameters Request parameters. * @throws {RequiredError} */ updateProjectPhase(requestParameters: ProjectPhasesApiUpdateProjectPhaseRequest): Promise; }; /** * Request parameters for addProjectPhase operation in ProjectPhasesApi. * @export * @interface ProjectPhasesApiAddProjectPhaseRequest */ export interface ProjectPhasesApiAddProjectPhaseRequest { /** * * @type {AddProjectPhaseRequest} * @memberof ProjectPhasesApiAddProjectPhase */ readonly AddProjectPhaseRequest: AddProjectPhaseRequest; } /** * Request parameters for deleteProjectPhase operation in ProjectPhasesApi. * @export * @interface ProjectPhasesApiDeleteProjectPhaseRequest */ export interface ProjectPhasesApiDeleteProjectPhaseRequest { /** * The ID of the project phase * @type {number} * @memberof ProjectPhasesApiDeleteProjectPhase */ readonly id: number; } /** * Request parameters for getProjectsPhase operation in ProjectPhasesApi. * @export * @interface ProjectPhasesApiGetProjectsPhaseRequest */ export interface ProjectPhasesApiGetProjectsPhaseRequest { /** * The ID of the project phase * @type {number} * @memberof ProjectPhasesApiGetProjectsPhase */ readonly id: number; } /** * Request parameters for getProjectsPhases operation in ProjectPhasesApi. * @export * @interface ProjectPhasesApiGetProjectsPhasesRequest */ export interface ProjectPhasesApiGetProjectsPhasesRequest { /** * The ID of the board for which phases are requested * @type {number} * @memberof ProjectPhasesApiGetProjectsPhases */ readonly board_id: number; } /** * Request parameters for updateProjectPhase operation in ProjectPhasesApi. * @export * @interface ProjectPhasesApiUpdateProjectPhaseRequest */ export interface ProjectPhasesApiUpdateProjectPhaseRequest { /** * The ID of the project phase * @type {number} * @memberof ProjectPhasesApiUpdateProjectPhase */ readonly id: number; /** * * @type {UpdateProjectPhaseRequest} * @memberof ProjectPhasesApiUpdateProjectPhase */ readonly UpdateProjectPhaseRequest?: UpdateProjectPhaseRequest; } /** * ProjectPhasesApi - object-oriented interface * @export * @class ProjectPhasesApi * @extends {BaseAPI} */ export declare class ProjectPhasesApi extends BaseAPI { /** * Adds a new project phase to a board. * @summary Add a project phase * @param {ProjectPhasesApiAddProjectPhaseRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof ProjectPhasesApi */ addProjectPhase(requestParameters: ProjectPhasesApiAddProjectPhaseRequest): Promise; /** * Marks a project phase as deleted. * @summary Delete a project phase * @param {ProjectPhasesApiDeleteProjectPhaseRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof ProjectPhasesApi */ deleteProjectPhase(requestParameters: ProjectPhasesApiDeleteProjectPhaseRequest): Promise; /** * Returns the details of a specific project phase. * @summary Get details of a project phase * @param {ProjectPhasesApiGetProjectsPhaseRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof ProjectPhasesApi */ getProjectsPhase(requestParameters: ProjectPhasesApiGetProjectsPhaseRequest): Promise; /** * Returns all active project phases under a specific board. * @summary Get project phases * @param {ProjectPhasesApiGetProjectsPhasesRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof ProjectPhasesApi */ getProjectsPhases(requestParameters: ProjectPhasesApiGetProjectsPhasesRequest): Promise; /** * Updates the properties of a project phase. * @summary Update a project phase * @param {ProjectPhasesApiUpdateProjectPhaseRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof ProjectPhasesApi */ updateProjectPhase(requestParameters: ProjectPhasesApiUpdateProjectPhaseRequest): Promise; }