/** * Pipedrive API v1 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 1.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 { GetPipelineDealsConversionRatesInResponse } from '../models'; import { GetPipelineDealsMovementsStatisticsResponse } from '../models'; import { GetStageDealsResponse } from '../models'; /** * PipelinesApi - axios parameter creator * @export */ export declare const PipelinesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period. * @summary Get deals conversion rates in pipeline * @param {number} id The ID of the pipeline * @param {string} start_date The start of the period. Date in format of YYYY-MM-DD. * @param {string} end_date The end of the period. Date in format of YYYY-MM-DD. * @param {number} [user_id] The ID of the user who\'s pipeline metrics statistics to fetch. If omitted, the authorized user will be used. * @throws {RequiredError} */ getPipelineConversionStatistics: (id: number, start_date: string, end_date: string, user_id?: number) => Promise; /** * Lists deals in a specific pipeline across all its stages. If no parameters are provided open deals owned by the authorized user will be returned.
This endpoint has been deprecated. Please use GET /api/v2/deals?pipeline_id={id} instead. * @summary Get deals in a pipeline * @param {number} id The ID of the pipeline * @param {number} [filter_id] If supplied, only deals matching the given filter will be returned * @param {number} [user_id] If supplied, `filter_id` will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned. * @param {0 | 1} [everyone] If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned * @param {number} [stage_id] If supplied, only deals within the given stage will be returned * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page * @param {0 | 1} [get_summary] Whether to include a summary of the pipeline in the `additional_data` or not * @param {string} [totals_convert_currency] The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned inside `deals_summary` inside `additional_data` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used. Only works when `get_summary` parameter flag is enabled. * @deprecated * @throws {RequiredError} */ getPipelineDeals: (id: number, filter_id?: number, user_id?: number, everyone?: 0 | 1, stage_id?: number, start?: number, limit?: number, get_summary?: 0 | 1, totals_convert_currency?: string) => Promise; /** * Returns statistics for deals movements for the given time period. * @summary Get deals movements in pipeline * @param {number} id The ID of the pipeline * @param {string} start_date The start of the period. Date in format of YYYY-MM-DD. * @param {string} end_date The end of the period. Date in format of YYYY-MM-DD. * @param {number} [user_id] The ID of the user who\'s pipeline statistics to fetch. If omitted, the authorized user will be used. * @throws {RequiredError} */ getPipelineMovementStatistics: (id: number, start_date: string, end_date: string, user_id?: number) => Promise; }; /** * PipelinesApi - functional programming interface * @export */ export declare const PipelinesApiFp: (configuration?: Configuration) => { /** * Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period. * @summary Get deals conversion rates in pipeline * @param {number} id The ID of the pipeline * @param {string} start_date The start of the period. Date in format of YYYY-MM-DD. * @param {string} end_date The end of the period. Date in format of YYYY-MM-DD. * @param {number} [user_id] The ID of the user who\'s pipeline metrics statistics to fetch. If omitted, the authorized user will be used. * @throws {RequiredError} */ getPipelineConversionStatistics(id: number, start_date: string, end_date: string, user_id?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Lists deals in a specific pipeline across all its stages. If no parameters are provided open deals owned by the authorized user will be returned.
This endpoint has been deprecated. Please use GET /api/v2/deals?pipeline_id={id} instead. * @summary Get deals in a pipeline * @param {number} id The ID of the pipeline * @param {number} [filter_id] If supplied, only deals matching the given filter will be returned * @param {number} [user_id] If supplied, `filter_id` will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned. * @param {0 | 1} [everyone] If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned * @param {number} [stage_id] If supplied, only deals within the given stage will be returned * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page * @param {0 | 1} [get_summary] Whether to include a summary of the pipeline in the `additional_data` or not * @param {string} [totals_convert_currency] The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned inside `deals_summary` inside `additional_data` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used. Only works when `get_summary` parameter flag is enabled. * @deprecated * @throws {RequiredError} */ getPipelineDeals(id: number, filter_id?: number, user_id?: number, everyone?: 0 | 1, stage_id?: number, start?: number, limit?: number, get_summary?: 0 | 1, totals_convert_currency?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Returns statistics for deals movements for the given time period. * @summary Get deals movements in pipeline * @param {number} id The ID of the pipeline * @param {string} start_date The start of the period. Date in format of YYYY-MM-DD. * @param {string} end_date The end of the period. Date in format of YYYY-MM-DD. * @param {number} [user_id] The ID of the user who\'s pipeline statistics to fetch. If omitted, the authorized user will be used. * @throws {RequiredError} */ getPipelineMovementStatistics(id: number, start_date: string, end_date: string, user_id?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; }; /** * PipelinesApi - factory interface * @export */ export declare const PipelinesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period. * @summary Get deals conversion rates in pipeline * @param {PipelinesApiGetPipelineConversionStatisticsRequest} requestParameters Request parameters. * @throws {RequiredError} */ getPipelineConversionStatistics(requestParameters: PipelinesApiGetPipelineConversionStatisticsRequest): Promise; /** * Lists deals in a specific pipeline across all its stages. If no parameters are provided open deals owned by the authorized user will be returned.
This endpoint has been deprecated. Please use GET /api/v2/deals?pipeline_id={id} instead. * @summary Get deals in a pipeline * @param {PipelinesApiGetPipelineDealsRequest} requestParameters Request parameters. * @deprecated * @throws {RequiredError} */ getPipelineDeals(requestParameters: PipelinesApiGetPipelineDealsRequest): Promise; /** * Returns statistics for deals movements for the given time period. * @summary Get deals movements in pipeline * @param {PipelinesApiGetPipelineMovementStatisticsRequest} requestParameters Request parameters. * @throws {RequiredError} */ getPipelineMovementStatistics(requestParameters: PipelinesApiGetPipelineMovementStatisticsRequest): Promise; }; /** * Request parameters for getPipelineConversionStatistics operation in PipelinesApi. * @export * @interface PipelinesApiGetPipelineConversionStatisticsRequest */ export interface PipelinesApiGetPipelineConversionStatisticsRequest { /** * The ID of the pipeline * @type {number} * @memberof PipelinesApiGetPipelineConversionStatistics */ readonly id: number; /** * The start of the period. Date in format of YYYY-MM-DD. * @type {string} * @memberof PipelinesApiGetPipelineConversionStatistics */ readonly start_date: string; /** * The end of the period. Date in format of YYYY-MM-DD. * @type {string} * @memberof PipelinesApiGetPipelineConversionStatistics */ readonly end_date: string; /** * The ID of the user who\'s pipeline metrics statistics to fetch. If omitted, the authorized user will be used. * @type {number} * @memberof PipelinesApiGetPipelineConversionStatistics */ readonly user_id?: number; } /** * Request parameters for getPipelineDeals operation in PipelinesApi. * @export * @interface PipelinesApiGetPipelineDealsRequest */ export interface PipelinesApiGetPipelineDealsRequest { /** * The ID of the pipeline * @type {number} * @memberof PipelinesApiGetPipelineDeals */ readonly id: number; /** * If supplied, only deals matching the given filter will be returned * @type {number} * @memberof PipelinesApiGetPipelineDeals */ readonly filter_id?: number; /** * If supplied, `filter_id` will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned. * @type {number} * @memberof PipelinesApiGetPipelineDeals */ readonly user_id?: number; /** * If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned * @type {0 | 1} * @memberof PipelinesApiGetPipelineDeals */ readonly everyone?: 0 | 1; /** * If supplied, only deals within the given stage will be returned * @type {number} * @memberof PipelinesApiGetPipelineDeals */ readonly stage_id?: number; /** * Pagination start * @type {number} * @memberof PipelinesApiGetPipelineDeals */ readonly start?: number; /** * Items shown per page * @type {number} * @memberof PipelinesApiGetPipelineDeals */ readonly limit?: number; /** * Whether to include a summary of the pipeline in the `additional_data` or not * @type {0 | 1} * @memberof PipelinesApiGetPipelineDeals */ readonly get_summary?: 0 | 1; /** * The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned inside `deals_summary` inside `additional_data` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used. Only works when `get_summary` parameter flag is enabled. * @type {string} * @memberof PipelinesApiGetPipelineDeals */ readonly totals_convert_currency?: string; } /** * Request parameters for getPipelineMovementStatistics operation in PipelinesApi. * @export * @interface PipelinesApiGetPipelineMovementStatisticsRequest */ export interface PipelinesApiGetPipelineMovementStatisticsRequest { /** * The ID of the pipeline * @type {number} * @memberof PipelinesApiGetPipelineMovementStatistics */ readonly id: number; /** * The start of the period. Date in format of YYYY-MM-DD. * @type {string} * @memberof PipelinesApiGetPipelineMovementStatistics */ readonly start_date: string; /** * The end of the period. Date in format of YYYY-MM-DD. * @type {string} * @memberof PipelinesApiGetPipelineMovementStatistics */ readonly end_date: string; /** * The ID of the user who\'s pipeline statistics to fetch. If omitted, the authorized user will be used. * @type {number} * @memberof PipelinesApiGetPipelineMovementStatistics */ readonly user_id?: number; } /** * PipelinesApi - object-oriented interface * @export * @class PipelinesApi * @extends {BaseAPI} */ export declare class PipelinesApi extends BaseAPI { /** * Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period. * @summary Get deals conversion rates in pipeline * @param {PipelinesApiGetPipelineConversionStatisticsRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof PipelinesApi */ getPipelineConversionStatistics(requestParameters: PipelinesApiGetPipelineConversionStatisticsRequest): Promise; /** * Lists deals in a specific pipeline across all its stages. If no parameters are provided open deals owned by the authorized user will be returned.
This endpoint has been deprecated. Please use GET /api/v2/deals?pipeline_id={id} instead. * @summary Get deals in a pipeline * @param {PipelinesApiGetPipelineDealsRequest} requestParameters Request parameters. * @deprecated * @throws {RequiredError} * @memberof PipelinesApi */ getPipelineDeals(requestParameters: PipelinesApiGetPipelineDealsRequest): Promise; /** * Returns statistics for deals movements for the given time period. * @summary Get deals movements in pipeline * @param {PipelinesApiGetPipelineMovementStatisticsRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof PipelinesApi */ getPipelineMovementStatistics(requestParameters: PipelinesApiGetPipelineMovementStatisticsRequest): Promise; }