/** * 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 { AddDealFollowerRequest } from '../models'; import { AddDealFollowerResponse } from '../models'; import { AddDealParticipantRequest } from '../models'; import { AddParticipantsResponse } from '../models'; import { DeleteDealFollowerResponse } from '../models'; import { DeleteDealParticipantResponse } from '../models'; import { GetAssociatedFilesResponse } from '../models'; import { GetAssociatedMailMessagesResponse } from '../models'; import { GetChangelogResponse } from '../models'; import { GetDealParticipantsResponse } from '../models'; import { GetDealUpdatesResponse } from '../models'; import { GetDealsResponse } from '../models'; import { GetDealsSummaryResponse } from '../models'; import { GetDealsTimelineResponse } from '../models'; import { GetDuplicatedDealResponse } from '../models'; import { GetListFollowersResponse } from '../models'; import { GetMergedDealResponse } from '../models'; import { GetParticipantsChangelogResponse } from '../models'; import { GetPermittedUsersResponse } from '../models'; import { MergeDealsRequest } from '../models'; /** * DealsApi - axios parameter creator * @export */ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Adds a follower to a deal. * @summary Add a follower to a deal * @param {number} id The ID of the deal * @param {AddDealFollowerRequest} [AddDealFollowerRequest] * @throws {RequiredError} */ addDealFollower: (id: number, AddDealFollowerRequest?: AddDealFollowerRequest) => Promise; /** * Adds a participant to a deal. * @summary Add a participant to a deal * @param {number} id The ID of the deal * @param {AddDealParticipantRequest} [AddDealParticipantRequest] * @throws {RequiredError} */ addDealParticipant: (id: number, AddDealParticipantRequest?: AddDealParticipantRequest) => Promise; /** * Deletes a follower from a deal. * @summary Delete a follower from a deal * @param {number} id The ID of the deal * @param {number} follower_id The ID of the relationship between the follower and the deal * @throws {RequiredError} */ deleteDealFollower: (id: number, follower_id: number) => Promise; /** * Deletes a participant from a deal. * @summary Delete a participant from a deal * @param {number} id The ID of the deal * @param {number} deal_participant_id The ID of the participant of the deal * @throws {RequiredError} */ deleteDealParticipant: (id: number, deal_participant_id: number) => Promise; /** * Duplicates a deal. * @summary Duplicate deal * @param {number} id The ID of the deal * @throws {RequiredError} */ duplicateDeal: (id: number) => Promise; /** * Returns all archived deals. * @summary Get all archived deals * @param {number} [user_id] If supplied, only deals matching the given user will be returned. However, `filter_id` and `owned_by_you` takes precedence over `user_id` when supplied. * @param {number} [filter_id] The ID of the filter to use * @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored. * @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored. * @param {number} [product_id] If supplied, only deals linked to the specified product are returned. If filter_id is provided, this is ignored. * @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored. * @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored. * @param {'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted'} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page * @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). * @param {0 | 1} [owned_by_you] When supplied, only deals owned by you are returned. However, `filter_id` takes precedence over `owned_by_you` when both are supplied. * @deprecated * @throws {RequiredError} */ getArchivedDeals: (user_id?: number, filter_id?: number, person_id?: number, org_id?: number, product_id?: number, pipeline_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted', start?: number, limit?: number, sort?: string, owned_by_you?: 0 | 1) => Promise; /** * Returns a summary of all archived deals. * @summary Get archived deals summary * @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open = Open, won = Won, lost = Lost. * @param {number} [filter_id] <code>user_id</code> will not be considered. Only deals matching the given filter will be returned. * @param {number} [user_id] Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`. * @param {number} [pipeline_id] Only deals within the given pipeline will be returned * @param {number} [stage_id] Only deals within the given stage will be returned * @deprecated * @throws {RequiredError} */ getArchivedDealsSummary: (status?: 'open' | 'won' | 'lost', filter_id?: number, user_id?: number, pipeline_id?: number, stage_id?: number) => Promise; /** * Returns archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`. * @summary Get archived deals timeline * @param {string} start_date The date when the first interval starts. Format: YYYY-MM-DD. * @param {'day' | 'week' | 'month' | 'quarter'} interval The type of the interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>`day`</td><td>Day</td></tr><tr><td>`week`</td><td>A full week (7 days) starting from `start_date`</td></tr><tr><td>`month`</td><td>A full month (depending on the number of days in given month) starting from `start_date`</td></tr><tr><td>`quarter`</td><td>A full quarter (3 months) starting from `start_date`</td></tr></table> * @param {number} amount The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months). * @param {string} field_key The date field key which deals will be retrieved from * @param {number} [user_id] If supplied, only deals matching the given user will be returned * @param {number} [pipeline_id] If supplied, only deals matching the given pipeline will be returned * @param {number} [filter_id] If supplied, only deals matching the given filter will be returned * @param {0 | 1} [exclude_deals] Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned. * @param {string} [totals_convert_currency] The 3-letter currency code of any of the supported currencies. When supplied, `totals_converted` is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to `default_currency` in which case the user\'s default currency is used. * @deprecated * @throws {RequiredError} */ getArchivedDealsTimeline: (start_date: string, interval: 'day' | 'week' | 'month' | 'quarter', amount: number, field_key: string, user_id?: number, pipeline_id?: number, filter_id?: number, exclude_deals?: 0 | 1, totals_convert_currency?: string) => Promise; /** * Lists updates about field values of a deal. * @summary List updates about deal field values * @param {number} id The ID of the deal * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page * @param {number} [limit] Items shown per page * @throws {RequiredError} */ getDealChangelog: (id: number, cursor?: string, limit?: number) => Promise; /** * Lists files associated with a deal. * @summary List files attached to a deal * @param {number} id The ID of the deal * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page. Please note that a maximum value of 100 is allowed. * @param {string} [sort] Supported fields: `id`, `update_time` * @throws {RequiredError} */ getDealFiles: (id: number, start?: number, limit?: number, sort?: string) => Promise; /** * Lists the followers of a deal. * @summary List followers of a deal * @param {number} id The ID of the deal * @throws {RequiredError} */ getDealFollowers: (id: number) => Promise; /** * Lists mail messages associated with a deal. * @summary List mail messages associated with a deal * @param {number} id The ID of the deal * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page * @throws {RequiredError} */ getDealMailMessages: (id: number, start?: number, limit?: number) => Promise; /** * Lists the participants associated with a deal.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. * @summary List participants of a deal * @param {number} id The ID of the deal * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page * @throws {RequiredError} */ getDealParticipants: (id: number, start?: number, limit?: number) => Promise; /** * List updates about participants of a deal. This is a cursor-paginated endpoint. For more information, please refer to our documentation on pagination. * @summary List updates about participants of a deal * @param {number} id The ID of the deal * @param {number} [limit] Items shown per page * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page * @throws {RequiredError} */ getDealParticipantsChangelog: (id: number, limit?: number, cursor?: string) => Promise; /** * Lists updates about a deal. * @summary List updates about a deal * @param {number} id The ID of the deal * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page * @param {string} [all_changes] Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates. * @param {string} [items] A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change). * @throws {RequiredError} */ getDealUpdates: (id: number, start?: number, limit?: number, all_changes?: string, items?: string) => Promise; /** * Lists the users permitted to access a deal. * @summary List permitted users * @param {number} id The ID of the deal * @throws {RequiredError} */ getDealUsers: (id: number) => Promise; /** * Returns a summary of all not archived deals. * @summary Get deals summary * @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open = Open, won = Won, lost = Lost. * @param {number} [filter_id] <code>user_id</code> will not be considered. Only deals matching the given filter will be returned. * @param {number} [user_id] Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`. * @param {number} [pipeline_id] Only deals within the given pipeline will be returned * @param {number} [stage_id] Only deals within the given stage will be returned * @throws {RequiredError} */ getDealsSummary: (status?: 'open' | 'won' | 'lost', filter_id?: number, user_id?: number, pipeline_id?: number, stage_id?: number) => Promise; /** * Returns not archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`. * @summary Get deals timeline * @param {string} start_date The date when the first interval starts. Format: YYYY-MM-DD. * @param {'day' | 'week' | 'month' | 'quarter'} interval The type of the interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>`day`</td><td>Day</td></tr><tr><td>`week`</td><td>A full week (7 days) starting from `start_date`</td></tr><tr><td>`month`</td><td>A full month (depending on the number of days in given month) starting from `start_date`</td></tr><tr><td>`quarter`</td><td>A full quarter (3 months) starting from `start_date`</td></tr></table> * @param {number} amount The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months). * @param {string} field_key The date field key which deals will be retrieved from * @param {number} [user_id] If supplied, only deals matching the given user will be returned * @param {number} [pipeline_id] If supplied, only deals matching the given pipeline will be returned * @param {number} [filter_id] If supplied, only deals matching the given filter will be returned * @param {0 | 1} [exclude_deals] Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned. * @param {string} [totals_convert_currency] The 3-letter currency code of any of the supported currencies. When supplied, `totals_converted` is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to `default_currency` in which case the user\'s default currency is used. * @throws {RequiredError} */ getDealsTimeline: (start_date: string, interval: 'day' | 'week' | 'month' | 'quarter', amount: number, field_key: string, user_id?: number, pipeline_id?: number, filter_id?: number, exclude_deals?: 0 | 1, totals_convert_currency?: string) => Promise; /** * Merges a deal with another deal. For more information, see the tutorial for merging two deals. * @summary Merge two deals * @param {number} id The ID of the deal * @param {MergeDealsRequest} [MergeDealsRequest] * @throws {RequiredError} */ mergeDeals: (id: number, MergeDealsRequest?: MergeDealsRequest) => Promise; }; /** * DealsApi - functional programming interface * @export */ export declare const DealsApiFp: (configuration?: Configuration) => { /** * Adds a follower to a deal. * @summary Add a follower to a deal * @param {number} id The ID of the deal * @param {AddDealFollowerRequest} [AddDealFollowerRequest] * @throws {RequiredError} */ addDealFollower(id: number, AddDealFollowerRequest?: AddDealFollowerRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Adds a participant to a deal. * @summary Add a participant to a deal * @param {number} id The ID of the deal * @param {AddDealParticipantRequest} [AddDealParticipantRequest] * @throws {RequiredError} */ addDealParticipant(id: number, AddDealParticipantRequest?: AddDealParticipantRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Deletes a follower from a deal. * @summary Delete a follower from a deal * @param {number} id The ID of the deal * @param {number} follower_id The ID of the relationship between the follower and the deal * @throws {RequiredError} */ deleteDealFollower(id: number, follower_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Deletes a participant from a deal. * @summary Delete a participant from a deal * @param {number} id The ID of the deal * @param {number} deal_participant_id The ID of the participant of the deal * @throws {RequiredError} */ deleteDealParticipant(id: number, deal_participant_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Duplicates a deal. * @summary Duplicate deal * @param {number} id The ID of the deal * @throws {RequiredError} */ duplicateDeal(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Returns all archived deals. * @summary Get all archived deals * @param {number} [user_id] If supplied, only deals matching the given user will be returned. However, `filter_id` and `owned_by_you` takes precedence over `user_id` when supplied. * @param {number} [filter_id] The ID of the filter to use * @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored. * @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored. * @param {number} [product_id] If supplied, only deals linked to the specified product are returned. If filter_id is provided, this is ignored. * @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored. * @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored. * @param {'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted'} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page * @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). * @param {0 | 1} [owned_by_you] When supplied, only deals owned by you are returned. However, `filter_id` takes precedence over `owned_by_you` when both are supplied. * @deprecated * @throws {RequiredError} */ getArchivedDeals(user_id?: number, filter_id?: number, person_id?: number, org_id?: number, product_id?: number, pipeline_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted', start?: number, limit?: number, sort?: string, owned_by_you?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Returns a summary of all archived deals. * @summary Get archived deals summary * @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open = Open, won = Won, lost = Lost. * @param {number} [filter_id] <code>user_id</code> will not be considered. Only deals matching the given filter will be returned. * @param {number} [user_id] Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`. * @param {number} [pipeline_id] Only deals within the given pipeline will be returned * @param {number} [stage_id] Only deals within the given stage will be returned * @deprecated * @throws {RequiredError} */ getArchivedDealsSummary(status?: 'open' | 'won' | 'lost', filter_id?: number, user_id?: number, pipeline_id?: number, stage_id?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Returns archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`. * @summary Get archived deals timeline * @param {string} start_date The date when the first interval starts. Format: YYYY-MM-DD. * @param {'day' | 'week' | 'month' | 'quarter'} interval The type of the interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>`day`</td><td>Day</td></tr><tr><td>`week`</td><td>A full week (7 days) starting from `start_date`</td></tr><tr><td>`month`</td><td>A full month (depending on the number of days in given month) starting from `start_date`</td></tr><tr><td>`quarter`</td><td>A full quarter (3 months) starting from `start_date`</td></tr></table> * @param {number} amount The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months). * @param {string} field_key The date field key which deals will be retrieved from * @param {number} [user_id] If supplied, only deals matching the given user will be returned * @param {number} [pipeline_id] If supplied, only deals matching the given pipeline will be returned * @param {number} [filter_id] If supplied, only deals matching the given filter will be returned * @param {0 | 1} [exclude_deals] Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned. * @param {string} [totals_convert_currency] The 3-letter currency code of any of the supported currencies. When supplied, `totals_converted` is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to `default_currency` in which case the user\'s default currency is used. * @deprecated * @throws {RequiredError} */ getArchivedDealsTimeline(start_date: string, interval: 'day' | 'week' | 'month' | 'quarter', amount: number, field_key: string, user_id?: number, pipeline_id?: number, filter_id?: number, exclude_deals?: 0 | 1, totals_convert_currency?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Lists updates about field values of a deal. * @summary List updates about deal field values * @param {number} id The ID of the deal * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page * @param {number} [limit] Items shown per page * @throws {RequiredError} */ getDealChangelog(id: number, cursor?: string, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Lists files associated with a deal. * @summary List files attached to a deal * @param {number} id The ID of the deal * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page. Please note that a maximum value of 100 is allowed. * @param {string} [sort] Supported fields: `id`, `update_time` * @throws {RequiredError} */ getDealFiles(id: number, start?: number, limit?: number, sort?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Lists the followers of a deal. * @summary List followers of a deal * @param {number} id The ID of the deal * @throws {RequiredError} */ getDealFollowers(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Lists mail messages associated with a deal. * @summary List mail messages associated with a deal * @param {number} id The ID of the deal * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page * @throws {RequiredError} */ getDealMailMessages(id: number, start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Lists the participants associated with a deal.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. * @summary List participants of a deal * @param {number} id The ID of the deal * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page * @throws {RequiredError} */ getDealParticipants(id: number, start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * List updates about participants of a deal. This is a cursor-paginated endpoint. For more information, please refer to our documentation on pagination. * @summary List updates about participants of a deal * @param {number} id The ID of the deal * @param {number} [limit] Items shown per page * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page * @throws {RequiredError} */ getDealParticipantsChangelog(id: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Lists updates about a deal. * @summary List updates about a deal * @param {number} id The ID of the deal * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page * @param {string} [all_changes] Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates. * @param {string} [items] A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change). * @throws {RequiredError} */ getDealUpdates(id: number, start?: number, limit?: number, all_changes?: string, items?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Lists the users permitted to access a deal. * @summary List permitted users * @param {number} id The ID of the deal * @throws {RequiredError} */ getDealUsers(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Returns a summary of all not archived deals. * @summary Get deals summary * @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open = Open, won = Won, lost = Lost. * @param {number} [filter_id] <code>user_id</code> will not be considered. Only deals matching the given filter will be returned. * @param {number} [user_id] Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`. * @param {number} [pipeline_id] Only deals within the given pipeline will be returned * @param {number} [stage_id] Only deals within the given stage will be returned * @throws {RequiredError} */ getDealsSummary(status?: 'open' | 'won' | 'lost', filter_id?: number, user_id?: number, pipeline_id?: number, stage_id?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Returns not archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`. * @summary Get deals timeline * @param {string} start_date The date when the first interval starts. Format: YYYY-MM-DD. * @param {'day' | 'week' | 'month' | 'quarter'} interval The type of the interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>`day`</td><td>Day</td></tr><tr><td>`week`</td><td>A full week (7 days) starting from `start_date`</td></tr><tr><td>`month`</td><td>A full month (depending on the number of days in given month) starting from `start_date`</td></tr><tr><td>`quarter`</td><td>A full quarter (3 months) starting from `start_date`</td></tr></table> * @param {number} amount The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months). * @param {string} field_key The date field key which deals will be retrieved from * @param {number} [user_id] If supplied, only deals matching the given user will be returned * @param {number} [pipeline_id] If supplied, only deals matching the given pipeline will be returned * @param {number} [filter_id] If supplied, only deals matching the given filter will be returned * @param {0 | 1} [exclude_deals] Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned. * @param {string} [totals_convert_currency] The 3-letter currency code of any of the supported currencies. When supplied, `totals_converted` is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to `default_currency` in which case the user\'s default currency is used. * @throws {RequiredError} */ getDealsTimeline(start_date: string, interval: 'day' | 'week' | 'month' | 'quarter', amount: number, field_key: string, user_id?: number, pipeline_id?: number, filter_id?: number, exclude_deals?: 0 | 1, totals_convert_currency?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Merges a deal with another deal. For more information, see the tutorial for merging two deals. * @summary Merge two deals * @param {number} id The ID of the deal * @param {MergeDealsRequest} [MergeDealsRequest] * @throws {RequiredError} */ mergeDeals(id: number, MergeDealsRequest?: MergeDealsRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; }; /** * DealsApi - factory interface * @export */ export declare const DealsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Adds a follower to a deal. * @summary Add a follower to a deal * @param {DealsApiAddDealFollowerRequest} requestParameters Request parameters. * @throws {RequiredError} */ addDealFollower(requestParameters: DealsApiAddDealFollowerRequest): Promise; /** * Adds a participant to a deal. * @summary Add a participant to a deal * @param {DealsApiAddDealParticipantRequest} requestParameters Request parameters. * @throws {RequiredError} */ addDealParticipant(requestParameters: DealsApiAddDealParticipantRequest): Promise; /** * Deletes a follower from a deal. * @summary Delete a follower from a deal * @param {DealsApiDeleteDealFollowerRequest} requestParameters Request parameters. * @throws {RequiredError} */ deleteDealFollower(requestParameters: DealsApiDeleteDealFollowerRequest): Promise; /** * Deletes a participant from a deal. * @summary Delete a participant from a deal * @param {DealsApiDeleteDealParticipantRequest} requestParameters Request parameters. * @throws {RequiredError} */ deleteDealParticipant(requestParameters: DealsApiDeleteDealParticipantRequest): Promise; /** * Duplicates a deal. * @summary Duplicate deal * @param {DealsApiDuplicateDealRequest} requestParameters Request parameters. * @throws {RequiredError} */ duplicateDeal(requestParameters: DealsApiDuplicateDealRequest): Promise; /** * Returns all archived deals. * @summary Get all archived deals * @param {DealsApiGetArchivedDealsRequest} requestParameters Request parameters. * @deprecated * @throws {RequiredError} */ getArchivedDeals(requestParameters?: DealsApiGetArchivedDealsRequest): Promise; /** * Returns a summary of all archived deals. * @summary Get archived deals summary * @param {DealsApiGetArchivedDealsSummaryRequest} requestParameters Request parameters. * @deprecated * @throws {RequiredError} */ getArchivedDealsSummary(requestParameters?: DealsApiGetArchivedDealsSummaryRequest): Promise; /** * Returns archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`. * @summary Get archived deals timeline * @param {DealsApiGetArchivedDealsTimelineRequest} requestParameters Request parameters. * @deprecated * @throws {RequiredError} */ getArchivedDealsTimeline(requestParameters: DealsApiGetArchivedDealsTimelineRequest): Promise; /** * Lists updates about field values of a deal. * @summary List updates about deal field values * @param {DealsApiGetDealChangelogRequest} requestParameters Request parameters. * @throws {RequiredError} */ getDealChangelog(requestParameters: DealsApiGetDealChangelogRequest): Promise; /** * Lists files associated with a deal. * @summary List files attached to a deal * @param {DealsApiGetDealFilesRequest} requestParameters Request parameters. * @throws {RequiredError} */ getDealFiles(requestParameters: DealsApiGetDealFilesRequest): Promise; /** * Lists the followers of a deal. * @summary List followers of a deal * @param {DealsApiGetDealFollowersRequest} requestParameters Request parameters. * @throws {RequiredError} */ getDealFollowers(requestParameters: DealsApiGetDealFollowersRequest): Promise; /** * Lists mail messages associated with a deal. * @summary List mail messages associated with a deal * @param {DealsApiGetDealMailMessagesRequest} requestParameters Request parameters. * @throws {RequiredError} */ getDealMailMessages(requestParameters: DealsApiGetDealMailMessagesRequest): Promise; /** * Lists the participants associated with a deal.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. * @summary List participants of a deal * @param {DealsApiGetDealParticipantsRequest} requestParameters Request parameters. * @throws {RequiredError} */ getDealParticipants(requestParameters: DealsApiGetDealParticipantsRequest): Promise; /** * List updates about participants of a deal. This is a cursor-paginated endpoint. For more information, please refer to our documentation on pagination. * @summary List updates about participants of a deal * @param {DealsApiGetDealParticipantsChangelogRequest} requestParameters Request parameters. * @throws {RequiredError} */ getDealParticipantsChangelog(requestParameters: DealsApiGetDealParticipantsChangelogRequest): Promise; /** * Lists updates about a deal. * @summary List updates about a deal * @param {DealsApiGetDealUpdatesRequest} requestParameters Request parameters. * @throws {RequiredError} */ getDealUpdates(requestParameters: DealsApiGetDealUpdatesRequest): Promise; /** * Lists the users permitted to access a deal. * @summary List permitted users * @param {DealsApiGetDealUsersRequest} requestParameters Request parameters. * @throws {RequiredError} */ getDealUsers(requestParameters: DealsApiGetDealUsersRequest): Promise; /** * Returns a summary of all not archived deals. * @summary Get deals summary * @param {DealsApiGetDealsSummaryRequest} requestParameters Request parameters. * @throws {RequiredError} */ getDealsSummary(requestParameters?: DealsApiGetDealsSummaryRequest): Promise; /** * Returns not archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`. * @summary Get deals timeline * @param {DealsApiGetDealsTimelineRequest} requestParameters Request parameters. * @throws {RequiredError} */ getDealsTimeline(requestParameters: DealsApiGetDealsTimelineRequest): Promise; /** * Merges a deal with another deal. For more information, see the tutorial for merging two deals. * @summary Merge two deals * @param {DealsApiMergeDealsRequest} requestParameters Request parameters. * @throws {RequiredError} */ mergeDeals(requestParameters: DealsApiMergeDealsRequest): Promise; }; /** * Request parameters for addDealFollower operation in DealsApi. * @export * @interface DealsApiAddDealFollowerRequest */ export interface DealsApiAddDealFollowerRequest { /** * The ID of the deal * @type {number} * @memberof DealsApiAddDealFollower */ readonly id: number; /** * * @type {AddDealFollowerRequest} * @memberof DealsApiAddDealFollower */ readonly AddDealFollowerRequest?: AddDealFollowerRequest; } /** * Request parameters for addDealParticipant operation in DealsApi. * @export * @interface DealsApiAddDealParticipantRequest */ export interface DealsApiAddDealParticipantRequest { /** * The ID of the deal * @type {number} * @memberof DealsApiAddDealParticipant */ readonly id: number; /** * * @type {AddDealParticipantRequest} * @memberof DealsApiAddDealParticipant */ readonly AddDealParticipantRequest?: AddDealParticipantRequest; } /** * Request parameters for deleteDealFollower operation in DealsApi. * @export * @interface DealsApiDeleteDealFollowerRequest */ export interface DealsApiDeleteDealFollowerRequest { /** * The ID of the deal * @type {number} * @memberof DealsApiDeleteDealFollower */ readonly id: number; /** * The ID of the relationship between the follower and the deal * @type {number} * @memberof DealsApiDeleteDealFollower */ readonly follower_id: number; } /** * Request parameters for deleteDealParticipant operation in DealsApi. * @export * @interface DealsApiDeleteDealParticipantRequest */ export interface DealsApiDeleteDealParticipantRequest { /** * The ID of the deal * @type {number} * @memberof DealsApiDeleteDealParticipant */ readonly id: number; /** * The ID of the participant of the deal * @type {number} * @memberof DealsApiDeleteDealParticipant */ readonly deal_participant_id: number; } /** * Request parameters for duplicateDeal operation in DealsApi. * @export * @interface DealsApiDuplicateDealRequest */ export interface DealsApiDuplicateDealRequest { /** * The ID of the deal * @type {number} * @memberof DealsApiDuplicateDeal */ readonly id: number; } /** * Request parameters for getArchivedDeals operation in DealsApi. * @export * @interface DealsApiGetArchivedDealsRequest */ export interface DealsApiGetArchivedDealsRequest { /** * If supplied, only deals matching the given user will be returned. However, `filter_id` and `owned_by_you` takes precedence over `user_id` when supplied. * @type {number} * @memberof DealsApiGetArchivedDeals */ readonly user_id?: number; /** * The ID of the filter to use * @type {number} * @memberof DealsApiGetArchivedDeals */ readonly filter_id?: number; /** * If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored. * @type {number} * @memberof DealsApiGetArchivedDeals */ readonly person_id?: number; /** * If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored. * @type {number} * @memberof DealsApiGetArchivedDeals */ readonly org_id?: number; /** * If supplied, only deals linked to the specified product are returned. If filter_id is provided, this is ignored. * @type {number} * @memberof DealsApiGetArchivedDeals */ readonly product_id?: number; /** * If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored. * @type {number} * @memberof DealsApiGetArchivedDeals */ readonly pipeline_id?: number; /** * If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored. * @type {number} * @memberof DealsApiGetArchivedDeals */ readonly stage_id?: number; /** * Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. * @type {'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted'} * @memberof DealsApiGetArchivedDeals */ readonly status?: 'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted'; /** * Pagination start * @type {number} * @memberof DealsApiGetArchivedDeals */ readonly start?: number; /** * Items shown per page * @type {number} * @memberof DealsApiGetArchivedDeals */ readonly limit?: number; /** * The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). * @type {string} * @memberof DealsApiGetArchivedDeals */ readonly sort?: string; /** * When supplied, only deals owned by you are returned. However, `filter_id` takes precedence over `owned_by_you` when both are supplied. * @type {0 | 1} * @memberof DealsApiGetArchivedDeals */ readonly owned_by_you?: 0 | 1; } /** * Request parameters for getArchivedDealsSummary operation in DealsApi. * @export * @interface DealsApiGetArchivedDealsSummaryRequest */ export interface DealsApiGetArchivedDealsSummaryRequest { /** * Only fetch deals with a specific status. open = Open, won = Won, lost = Lost. * @type {'open' | 'won' | 'lost'} * @memberof DealsApiGetArchivedDealsSummary */ readonly status?: 'open' | 'won' | 'lost'; /** * <code>user_id</code> will not be considered. Only deals matching the given filter will be returned. * @type {number} * @memberof DealsApiGetArchivedDealsSummary */ readonly filter_id?: number; /** * Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`. * @type {number} * @memberof DealsApiGetArchivedDealsSummary */ readonly user_id?: number; /** * Only deals within the given pipeline will be returned * @type {number} * @memberof DealsApiGetArchivedDealsSummary */ readonly pipeline_id?: number; /** * Only deals within the given stage will be returned * @type {number} * @memberof DealsApiGetArchivedDealsSummary */ readonly stage_id?: number; } /** * Request parameters for getArchivedDealsTimeline operation in DealsApi. * @export * @interface DealsApiGetArchivedDealsTimelineRequest */ export interface DealsApiGetArchivedDealsTimelineRequest { /** * The date when the first interval starts. Format: YYYY-MM-DD. * @type {string} * @memberof DealsApiGetArchivedDealsTimeline */ readonly start_date: string; /** * The type of the interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>`day`</td><td>Day</td></tr><tr><td>`week`</td><td>A full week (7 days) starting from `start_date`</td></tr><tr><td>`month`</td><td>A full month (depending on the number of days in given month) starting from `start_date`</td></tr><tr><td>`quarter`</td><td>A full quarter (3 months) starting from `start_date`</td></tr></table> * @type {'day' | 'week' | 'month' | 'quarter'} * @memberof DealsApiGetArchivedDealsTimeline */ readonly interval: 'day' | 'week' | 'month' | 'quarter'; /** * The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months). * @type {number} * @memberof DealsApiGetArchivedDealsTimeline */ readonly amount: number; /** * The date field key which deals will be retrieved from * @type {string} * @memberof DealsApiGetArchivedDealsTimeline */ readonly field_key: string; /** * If supplied, only deals matching the given user will be returned * @type {number} * @memberof DealsApiGetArchivedDealsTimeline */ readonly user_id?: number; /** * If supplied, only deals matching the given pipeline will be returned * @type {number} * @memberof DealsApiGetArchivedDealsTimeline */ readonly pipeline_id?: number; /** * If supplied, only deals matching the given filter will be returned * @type {number} * @memberof DealsApiGetArchivedDealsTimeline */ readonly filter_id?: number; /** * Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned. * @type {0 | 1} * @memberof DealsApiGetArchivedDealsTimeline */ readonly exclude_deals?: 0 | 1; /** * The 3-letter currency code of any of the supported currencies. When supplied, `totals_converted` is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to `default_currency` in which case the user\'s default currency is used. * @type {string} * @memberof DealsApiGetArchivedDealsTimeline */ readonly totals_convert_currency?: string; } /** * Request parameters for getDealChangelog operation in DealsApi. * @export * @interface DealsApiGetDealChangelogRequest */ export interface DealsApiGetDealChangelogRequest { /** * The ID of the deal * @type {number} * @memberof DealsApiGetDealChangelog */ readonly id: number; /** * For pagination, the marker (an opaque string value) representing the first item on the next page * @type {string} * @memberof DealsApiGetDealChangelog */ readonly cursor?: string; /** * Items shown per page * @type {number} * @memberof DealsApiGetDealChangelog */ readonly limit?: number; } /** * Request parameters for getDealFiles operation in DealsApi. * @export * @interface DealsApiGetDealFilesRequest */ export interface DealsApiGetDealFilesRequest { /** * The ID of the deal * @type {number} * @memberof DealsApiGetDealFiles */ readonly id: number; /** * Pagination start * @type {number} * @memberof DealsApiGetDealFiles */ readonly start?: number; /** * Items shown per page. Please note that a maximum value of 100 is allowed. * @type {number} * @memberof DealsApiGetDealFiles */ readonly limit?: number; /** * Supported fields: `id`, `update_time` * @type {string} * @memberof DealsApiGetDealFiles */ readonly sort?: string; } /** * Request parameters for getDealFollowers operation in DealsApi. * @export * @interface DealsApiGetDealFollowersRequest */ export interface DealsApiGetDealFollowersRequest { /** * The ID of the deal * @type {number} * @memberof DealsApiGetDealFollowers */ readonly id: number; } /** * Request parameters for getDealMailMessages operation in DealsApi. * @export * @interface DealsApiGetDealMailMessagesRequest */ export interface DealsApiGetDealMailMessagesRequest { /** * The ID of the deal * @type {number} * @memberof DealsApiGetDealMailMessages */ readonly id: number; /** * Pagination start * @type {number} * @memberof DealsApiGetDealMailMessages */ readonly start?: number; /** * Items shown per page * @type {number} * @memberof DealsApiGetDealMailMessages */ readonly limit?: number; } /** * Request parameters for getDealParticipants operation in DealsApi. * @export * @interface DealsApiGetDealParticipantsRequest */ export interface DealsApiGetDealParticipantsRequest { /** * The ID of the deal * @type {number} * @memberof DealsApiGetDealParticipants */ readonly id: number; /** * Pagination start * @type {number} * @memberof DealsApiGetDealParticipants */ readonly start?: number; /** * Items shown per page * @type {number} * @memberof DealsApiGetDealParticipants */ readonly limit?: number; } /** * Request parameters for getDealParticipantsChangelog operation in DealsApi. * @export * @interface DealsApiGetDealParticipantsChangelogRequest */ export interface DealsApiGetDealParticipantsChangelogRequest { /** * The ID of the deal * @type {number} * @memberof DealsApiGetDealParticipantsChangelog */ readonly id: number; /** * Items shown per page * @type {number} * @memberof DealsApiGetDealParticipantsChangelog */ readonly limit?: number; /** * For pagination, the marker (an opaque string value) representing the first item on the next page * @type {string} * @memberof DealsApiGetDealParticipantsChangelog */ readonly cursor?: string; } /** * Request parameters for getDealUpdates operation in DealsApi. * @export * @interface DealsApiGetDealUpdatesRequest */ export interface DealsApiGetDealUpdatesRequest { /** * The ID of the deal * @type {number} * @memberof DealsApiGetDealUpdates */ readonly id: number; /** * Pagination start * @type {number} * @memberof DealsApiGetDealUpdates */ readonly start?: number; /** * Items shown per page * @type {number} * @memberof DealsApiGetDealUpdates */ readonly limit?: number; /** * Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates. * @type {string} * @memberof DealsApiGetDealUpdates */ readonly all_changes?: string; /** * A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change). * @type {string} * @memberof DealsApiGetDealUpdates */ readonly items?: string; } /** * Request parameters for getDealUsers operation in DealsApi. * @export * @interface DealsApiGetDealUsersRequest */ export interface DealsApiGetDealUsersRequest { /** * The ID of the deal * @type {number} * @memberof DealsApiGetDealUsers */ readonly id: number; } /** * Request parameters for getDealsSummary operation in DealsApi. * @export * @interface DealsApiGetDealsSummaryRequest */ export interface DealsApiGetDealsSummaryRequest { /** * Only fetch deals with a specific status. open = Open, won = Won, lost = Lost. * @type {'open' | 'won' | 'lost'} * @memberof DealsApiGetDealsSummary */ readonly status?: 'open' | 'won' | 'lost'; /** * <code>user_id</code> will not be considered. Only deals matching the given filter will be returned. * @type {number} * @memberof DealsApiGetDealsSummary */ readonly filter_id?: number; /** * Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`. * @type {number} * @memberof DealsApiGetDealsSummary */ readonly user_id?: number; /** * Only deals within the given pipeline will be returned * @type {number} * @memberof DealsApiGetDealsSummary */ readonly pipeline_id?: number; /** * Only deals within the given stage will be returned * @type {number} * @memberof DealsApiGetDealsSummary */ readonly stage_id?: number; } /** * Request parameters for getDealsTimeline operation in DealsApi. * @export * @interface DealsApiGetDealsTimelineRequest */ export interface DealsApiGetDealsTimelineRequest { /** * The date when the first interval starts. Format: YYYY-MM-DD. * @type {string} * @memberof DealsApiGetDealsTimeline */ readonly start_date: string; /** * The type of the interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>`day`</td><td>Day</td></tr><tr><td>`week`</td><td>A full week (7 days) starting from `start_date`</td></tr><tr><td>`month`</td><td>A full month (depending on the number of days in given month) starting from `start_date`</td></tr><tr><td>`quarter`</td><td>A full quarter (3 months) starting from `start_date`</td></tr></table> * @type {'day' | 'week' | 'month' | 'quarter'} * @memberof DealsApiGetDealsTimeline */ readonly interval: 'day' | 'week' | 'month' | 'quarter'; /** * The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months). * @type {number} * @memberof DealsApiGetDealsTimeline */ readonly amount: number; /** * The date field key which deals will be retrieved from * @type {string} * @memberof DealsApiGetDealsTimeline */ readonly field_key: string; /** * If supplied, only deals matching the given user will be returned * @type {number} * @memberof DealsApiGetDealsTimeline */ readonly user_id?: number; /** * If supplied, only deals matching the given pipeline will be returned * @type {number} * @memberof DealsApiGetDealsTimeline */ readonly pipeline_id?: number; /** * If supplied, only deals matching the given filter will be returned * @type {number} * @memberof DealsApiGetDealsTimeline */ readonly filter_id?: number; /** * Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned. * @type {0 | 1} * @memberof DealsApiGetDealsTimeline */ readonly exclude_deals?: 0 | 1; /** * The 3-letter currency code of any of the supported currencies. When supplied, `totals_converted` is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to `default_currency` in which case the user\'s default currency is used. * @type {string} * @memberof DealsApiGetDealsTimeline */ readonly totals_convert_currency?: string; } /** * Request parameters for mergeDeals operation in DealsApi. * @export * @interface DealsApiMergeDealsRequest */ export interface DealsApiMergeDealsRequest { /** * The ID of the deal * @type {number} * @memberof DealsApiMergeDeals */ readonly id: number; /** * * @type {MergeDealsRequest} * @memberof DealsApiMergeDeals */ readonly MergeDealsRequest?: MergeDealsRequest; } /** * DealsApi - object-oriented interface * @export * @class DealsApi * @extends {BaseAPI} */ export declare class DealsApi extends BaseAPI { /** * Adds a follower to a deal. * @summary Add a follower to a deal * @param {DealsApiAddDealFollowerRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof DealsApi */ addDealFollower(requestParameters: DealsApiAddDealFollowerRequest): Promise; /** * Adds a participant to a deal. * @summary Add a participant to a deal * @param {DealsApiAddDealParticipantRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof DealsApi */ addDealParticipant(requestParameters: DealsApiAddDealParticipantRequest): Promise; /** * Deletes a follower from a deal. * @summary Delete a follower from a deal * @param {DealsApiDeleteDealFollowerRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof DealsApi */ deleteDealFollower(requestParameters: DealsApiDeleteDealFollowerRequest): Promise; /** * Deletes a participant from a deal. * @summary Delete a participant from a deal * @param {DealsApiDeleteDealParticipantRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof DealsApi */ deleteDealParticipant(requestParameters: DealsApiDeleteDealParticipantRequest): Promise; /** * Duplicates a deal. * @summary Duplicate deal * @param {DealsApiDuplicateDealRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof DealsApi */ duplicateDeal(requestParameters: DealsApiDuplicateDealRequest): Promise; /** * Returns all archived deals. * @summary Get all archived deals * @param {DealsApiGetArchivedDealsRequest} requestParameters Request parameters. * @deprecated * @throws {RequiredError} * @memberof DealsApi */ getArchivedDeals(requestParameters?: DealsApiGetArchivedDealsRequest): Promise; /** * Returns a summary of all archived deals. * @summary Get archived deals summary * @param {DealsApiGetArchivedDealsSummaryRequest} requestParameters Request parameters. * @deprecated * @throws {RequiredError} * @memberof DealsApi */ getArchivedDealsSummary(requestParameters?: DealsApiGetArchivedDealsSummaryRequest): Promise; /** * Returns archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`. * @summary Get archived deals timeline * @param {DealsApiGetArchivedDealsTimelineRequest} requestParameters Request parameters. * @deprecated * @throws {RequiredError} * @memberof DealsApi */ getArchivedDealsTimeline(requestParameters: DealsApiGetArchivedDealsTimelineRequest): Promise; /** * Lists updates about field values of a deal. * @summary List updates about deal field values * @param {DealsApiGetDealChangelogRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof DealsApi */ getDealChangelog(requestParameters: DealsApiGetDealChangelogRequest): Promise; /** * Lists files associated with a deal. * @summary List files attached to a deal * @param {DealsApiGetDealFilesRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof DealsApi */ getDealFiles(requestParameters: DealsApiGetDealFilesRequest): Promise; /** * Lists the followers of a deal. * @summary List followers of a deal * @param {DealsApiGetDealFollowersRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof DealsApi */ getDealFollowers(requestParameters: DealsApiGetDealFollowersRequest): Promise; /** * Lists mail messages associated with a deal. * @summary List mail messages associated with a deal * @param {DealsApiGetDealMailMessagesRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof DealsApi */ getDealMailMessages(requestParameters: DealsApiGetDealMailMessagesRequest): Promise; /** * Lists the participants associated with a deal.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. * @summary List participants of a deal * @param {DealsApiGetDealParticipantsRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof DealsApi */ getDealParticipants(requestParameters: DealsApiGetDealParticipantsRequest): Promise; /** * List updates about participants of a deal. This is a cursor-paginated endpoint. For more information, please refer to our documentation on pagination. * @summary List updates about participants of a deal * @param {DealsApiGetDealParticipantsChangelogRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof DealsApi */ getDealParticipantsChangelog(requestParameters: DealsApiGetDealParticipantsChangelogRequest): Promise; /** * Lists updates about a deal. * @summary List updates about a deal * @param {DealsApiGetDealUpdatesRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof DealsApi */ getDealUpdates(requestParameters: DealsApiGetDealUpdatesRequest): Promise; /** * Lists the users permitted to access a deal. * @summary List permitted users * @param {DealsApiGetDealUsersRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof DealsApi */ getDealUsers(requestParameters: DealsApiGetDealUsersRequest): Promise; /** * Returns a summary of all not archived deals. * @summary Get deals summary * @param {DealsApiGetDealsSummaryRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof DealsApi */ getDealsSummary(requestParameters?: DealsApiGetDealsSummaryRequest): Promise; /** * Returns not archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`. * @summary Get deals timeline * @param {DealsApiGetDealsTimelineRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof DealsApi */ getDealsTimeline(requestParameters: DealsApiGetDealsTimelineRequest): Promise; /** * Merges a deal with another deal. For more information, see the tutorial for merging two deals. * @summary Merge two deals * @param {DealsApiMergeDealsRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof DealsApi */ mergeDeals(requestParameters: DealsApiMergeDealsRequest): Promise; }