/**
* 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 { GetStageDealsResponse } from '../models';
/**
* StagesApi - axios parameter creator
* @export
*/
export declare const StagesApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Lists deals in a specific stage. 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?stage_id={id} instead.
* @summary Get deals in a stage
* @param {number} id The ID of the stage
* @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} [start] Pagination start
* @param {number} [limit] Items shown per page
* @deprecated
* @throws {RequiredError}
*/
getStageDeals: (id: number, filter_id?: number, user_id?: number, everyone?: 0 | 1, start?: number, limit?: number) => Promise;
};
/**
* StagesApi - functional programming interface
* @export
*/
export declare const StagesApiFp: (configuration?: Configuration) => {
/**
* Lists deals in a specific stage. 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?stage_id={id} instead.
* @summary Get deals in a stage
* @param {number} id The ID of the stage
* @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} [start] Pagination start
* @param {number} [limit] Items shown per page
* @deprecated
* @throws {RequiredError}
*/
getStageDeals(id: number, filter_id?: number, user_id?: number, everyone?: 0 | 1, start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>;
};
/**
* StagesApi - factory interface
* @export
*/
export declare const StagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Lists deals in a specific stage. 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?stage_id={id} instead.
* @summary Get deals in a stage
* @param {StagesApiGetStageDealsRequest} requestParameters Request parameters.
* @deprecated
* @throws {RequiredError}
*/
getStageDeals(requestParameters: StagesApiGetStageDealsRequest): Promise;
};
/**
* Request parameters for getStageDeals operation in StagesApi.
* @export
* @interface StagesApiGetStageDealsRequest
*/
export interface StagesApiGetStageDealsRequest {
/**
* The ID of the stage
* @type {number}
* @memberof StagesApiGetStageDeals
*/
readonly id: number;
/**
* If supplied, only deals matching the given filter will be returned
* @type {number}
* @memberof StagesApiGetStageDeals
*/
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 StagesApiGetStageDeals
*/
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 StagesApiGetStageDeals
*/
readonly everyone?: 0 | 1;
/**
* Pagination start
* @type {number}
* @memberof StagesApiGetStageDeals
*/
readonly start?: number;
/**
* Items shown per page
* @type {number}
* @memberof StagesApiGetStageDeals
*/
readonly limit?: number;
}
/**
* StagesApi - object-oriented interface
* @export
* @class StagesApi
* @extends {BaseAPI}
*/
export declare class StagesApi extends BaseAPI {
/**
* Lists deals in a specific stage. 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?stage_id={id} instead.
* @summary Get deals in a stage
* @param {StagesApiGetStageDealsRequest} requestParameters Request parameters.
* @deprecated
* @throws {RequiredError}
* @memberof StagesApi
*/
getStageDeals(requestParameters: StagesApiGetStageDealsRequest): Promise;
}