pipedrive 25.0.0 → 26.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/esm/versions/v1/api/activities-api.d.ts +40 -40
- package/dist/esm/versions/v1/api/activities-api.js +40 -40
- package/dist/esm/versions/v1/api/deals-api.d.ts +410 -88
- package/dist/esm/versions/v1/api/deals-api.js +417 -88
- package/dist/esm/versions/v1/api/item-search-api.d.ts +8 -8
- package/dist/esm/versions/v1/api/item-search-api.js +8 -8
- package/dist/esm/versions/v1/api/leads-api.d.ts +100 -14
- package/dist/esm/versions/v1/api/leads-api.js +107 -14
- package/dist/esm/versions/v1/api/notes-api.d.ts +18 -2
- package/dist/esm/versions/v1/api/notes-api.js +15 -5
- package/dist/esm/versions/v1/api/organizations-api.d.ts +68 -68
- package/dist/esm/versions/v1/api/organizations-api.js +68 -68
- package/dist/esm/versions/v1/api/persons-api.d.ts +56 -56
- package/dist/esm/versions/v1/api/persons-api.js +56 -56
- package/dist/esm/versions/v1/api/pipelines-api.d.ts +28 -28
- package/dist/esm/versions/v1/api/pipelines-api.js +28 -28
- package/dist/esm/versions/v1/api/products-api.d.ts +24 -24
- package/dist/esm/versions/v1/api/products-api.js +24 -24
- package/dist/esm/versions/v1/api/stages-api.d.ts +36 -36
- package/dist/esm/versions/v1/api/stages-api.js +36 -36
- package/dist/esm/versions/v1/base.d.ts +2 -3
- package/dist/esm/versions/v1/configuration.d.ts +2 -2
- package/dist/esm/versions/v1/models/add-note-request-all-of.d.ts +9 -4
- package/dist/esm/versions/v1/models/add-note-request-all-of1.d.ts +10 -0
- package/dist/esm/versions/v1/models/add-note-request-all-of1.js +4 -0
- package/dist/esm/versions/v1/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -0
- package/dist/esm/versions/v1/models/index.d.ts +1 -0
- package/dist/esm/versions/v1/models/index.js +1 -0
- package/dist/esm/versions/v1/models/note-project.d.ts +23 -0
- package/dist/esm/versions/v1/models/note-project.js +14 -0
- package/dist/esm/versions/v1/models/note-request-all-of1.d.ts +5 -0
- package/dist/esm/versions/v1/models/note.d.ts +16 -0
- package/dist/esm/versions/v2/api/activities-api.d.ts +15 -7
- package/dist/esm/versions/v2/api/activities-api.js +12 -7
- package/dist/esm/versions/v2/api/beta-api.d.ts +212 -0
- package/dist/esm/versions/v2/api/beta-api.js +286 -0
- package/dist/esm/versions/v2/api/deals-api.d.ts +272 -4
- package/dist/esm/versions/v2/api/deals-api.js +288 -4
- package/dist/esm/versions/v2/api/leads-api.d.ts +111 -0
- package/dist/esm/versions/v2/api/leads-api.js +146 -1
- package/dist/esm/versions/v2/api/persons-api.d.ts +8 -8
- package/dist/esm/versions/v2/api/persons-api.js +8 -8
- package/dist/esm/versions/v2/api/products-api.js +1 -1
- package/dist/esm/versions/v2/base.d.ts +2 -3
- package/dist/esm/versions/v2/configuration.d.ts +2 -2
- package/dist/esm/versions/v2/models/activity-item.d.ts +5 -0
- package/dist/esm/versions/v2/models/activity-item1.d.ts +5 -0
- package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response-data.d.ts +23 -0
- package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response-data.js +14 -0
- package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response.d.ts +34 -0
- package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response.js +14 -0
- package/dist/esm/versions/v2/models/add-convert-lead-to-deal-response.d.ts +34 -0
- package/dist/esm/versions/v2/models/add-convert-lead-to-deal-response.js +14 -0
- package/dist/esm/versions/v2/models/add-person-request.d.ts +12 -0
- package/dist/esm/versions/v2/models/add-person-request.js +6 -1
- package/dist/esm/versions/v2/models/convert-lead-to-deal-request.d.ts +28 -0
- package/dist/esm/versions/v2/models/convert-lead-to-deal-request.js +14 -0
- package/dist/esm/versions/v2/models/deal-item.d.ts +5 -0
- package/dist/esm/versions/v2/models/deal-item1.d.ts +5 -0
- package/dist/esm/versions/v2/models/get-convert-response.d.ts +43 -0
- package/dist/esm/versions/v2/models/get-convert-response.js +14 -0
- package/dist/esm/versions/v2/models/get-convert-response1-data.d.ts +46 -0
- package/dist/esm/versions/v2/models/get-convert-response1-data.js +20 -0
- package/dist/esm/versions/v2/models/get-convert-response1.d.ts +34 -0
- package/dist/esm/versions/v2/models/get-convert-response1.js +14 -0
- package/dist/esm/versions/v2/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -0
- package/dist/esm/versions/v2/models/index.d.ts +7 -0
- package/dist/esm/versions/v2/models/index.js +7 -0
- package/dist/esm/versions/v2/models/update-person-request.d.ts +12 -0
- package/dist/esm/versions/v2/models/update-person-request.js +6 -1
- package/dist/versions/v1/api/activities-api.d.ts +40 -40
- package/dist/versions/v1/api/activities-api.js +40 -40
- package/dist/versions/v1/api/deals-api.d.ts +410 -88
- package/dist/versions/v1/api/deals-api.js +417 -88
- package/dist/versions/v1/api/item-search-api.d.ts +8 -8
- package/dist/versions/v1/api/item-search-api.js +8 -8
- package/dist/versions/v1/api/leads-api.d.ts +100 -14
- package/dist/versions/v1/api/leads-api.js +107 -14
- package/dist/versions/v1/api/notes-api.d.ts +18 -2
- package/dist/versions/v1/api/notes-api.js +15 -5
- package/dist/versions/v1/api/organizations-api.d.ts +68 -68
- package/dist/versions/v1/api/organizations-api.js +68 -68
- package/dist/versions/v1/api/persons-api.d.ts +56 -56
- package/dist/versions/v1/api/persons-api.js +56 -56
- package/dist/versions/v1/api/pipelines-api.d.ts +28 -28
- package/dist/versions/v1/api/pipelines-api.js +28 -28
- package/dist/versions/v1/api/products-api.d.ts +24 -24
- package/dist/versions/v1/api/products-api.js +24 -24
- package/dist/versions/v1/api/stages-api.d.ts +36 -36
- package/dist/versions/v1/api/stages-api.js +36 -36
- package/dist/versions/v1/base.d.ts +2 -3
- package/dist/versions/v1/configuration.d.ts +2 -2
- package/dist/versions/v1/models/add-note-request-all-of.d.ts +9 -4
- package/dist/versions/v1/models/add-note-request-all-of1.d.ts +10 -0
- package/dist/versions/v1/models/add-note-request-all-of1.js +5 -1
- package/dist/versions/v1/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -0
- package/dist/versions/v1/models/index.d.ts +1 -0
- package/dist/versions/v1/models/index.js +1 -0
- package/dist/versions/v1/models/note-project.d.ts +23 -0
- package/dist/versions/v1/models/note-project.js +15 -0
- package/dist/versions/v1/models/note-request-all-of1.d.ts +5 -0
- package/dist/versions/v1/models/note.d.ts +16 -0
- package/dist/versions/v2/api/activities-api.d.ts +15 -7
- package/dist/versions/v2/api/activities-api.js +12 -7
- package/dist/versions/v2/api/beta-api.d.ts +212 -0
- package/dist/versions/v2/api/beta-api.js +286 -0
- package/dist/versions/v2/api/deals-api.d.ts +272 -4
- package/dist/versions/v2/api/deals-api.js +288 -4
- package/dist/versions/v2/api/leads-api.d.ts +111 -0
- package/dist/versions/v2/api/leads-api.js +145 -0
- package/dist/versions/v2/api/persons-api.d.ts +8 -8
- package/dist/versions/v2/api/persons-api.js +8 -8
- package/dist/versions/v2/api/products-api.js +1 -1
- package/dist/versions/v2/base.d.ts +2 -3
- package/dist/versions/v2/configuration.d.ts +2 -2
- package/dist/versions/v2/models/activity-item.d.ts +5 -0
- package/dist/versions/v2/models/activity-item1.d.ts +5 -0
- package/dist/versions/v2/models/add-convert-deal-to-lead-response-data.d.ts +23 -0
- package/dist/versions/v2/models/add-convert-deal-to-lead-response-data.js +15 -0
- package/dist/versions/v2/models/add-convert-deal-to-lead-response.d.ts +34 -0
- package/dist/versions/v2/models/add-convert-deal-to-lead-response.js +15 -0
- package/dist/versions/v2/models/add-convert-lead-to-deal-response.d.ts +34 -0
- package/dist/versions/v2/models/add-convert-lead-to-deal-response.js +15 -0
- package/dist/versions/v2/models/add-person-request.d.ts +12 -0
- package/dist/versions/v2/models/add-person-request.js +7 -0
- package/dist/versions/v2/models/convert-lead-to-deal-request.d.ts +28 -0
- package/dist/versions/v2/models/convert-lead-to-deal-request.js +15 -0
- package/dist/versions/v2/models/deal-item.d.ts +5 -0
- package/dist/versions/v2/models/deal-item1.d.ts +5 -0
- package/dist/versions/v2/models/get-convert-response.d.ts +43 -0
- package/dist/versions/v2/models/get-convert-response.js +15 -0
- package/dist/versions/v2/models/get-convert-response1-data.d.ts +46 -0
- package/dist/versions/v2/models/get-convert-response1-data.js +23 -0
- package/dist/versions/v2/models/get-convert-response1.d.ts +34 -0
- package/dist/versions/v2/models/get-convert-response1.js +15 -0
- package/dist/versions/v2/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -0
- package/dist/versions/v2/models/index.d.ts +7 -0
- package/dist/versions/v2/models/index.js +7 -0
- package/dist/versions/v2/models/update-person-request.d.ts +12 -0
- package/dist/versions/v2/models/update-person-request.js +7 -0
- package/package.json +1 -1
@@ -57,7 +57,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
57
57
|
* Adds a new deal. All deals created through the Pipedrive API will have a `origin` set to `API`. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the dealFields and look for `key` values. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/creating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">adding a deal</a>.
|
58
58
|
* @summary Add a deal
|
59
59
|
* @param {AddDealRequest} [AddDealRequest]
|
60
|
-
|
60
|
+
* @deprecated
|
61
61
|
* @throws {RequiredError}
|
62
62
|
*/
|
63
63
|
addDeal: (AddDealRequest?: AddDealRequest) => Promise<RequestArgs>;
|
@@ -84,7 +84,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
84
84
|
* @summary Add a product to a deal
|
85
85
|
* @param {number} id The ID of the deal
|
86
86
|
* @param {AddDealProductRequest} [AddDealProductRequest]
|
87
|
-
|
87
|
+
* @deprecated
|
88
88
|
* @throws {RequiredError}
|
89
89
|
*/
|
90
90
|
addDealProduct: (id: number, AddDealProductRequest?: AddDealProductRequest) => Promise<RequestArgs>;
|
@@ -92,7 +92,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
92
92
|
* Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
|
93
93
|
* @summary Delete a deal
|
94
94
|
* @param {number} id The ID of the deal
|
95
|
-
|
95
|
+
* @deprecated
|
96
96
|
* @throws {RequiredError}
|
97
97
|
*/
|
98
98
|
deleteDeal: (id: number) => Promise<RequestArgs>;
|
@@ -119,15 +119,15 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
119
119
|
* @summary Delete an attached product from a deal
|
120
120
|
* @param {number} id The ID of the deal
|
121
121
|
* @param {number} product_attachment_id The product attachment ID
|
122
|
-
|
122
|
+
* @deprecated
|
123
123
|
* @throws {RequiredError}
|
124
124
|
*/
|
125
125
|
deleteDealProduct: (id: number, product_attachment_id: number) => Promise<RequestArgs>;
|
126
126
|
/**
|
127
|
-
* Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.
|
127
|
+
* Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#deleteDeal\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/deals/{id}</a> instead.
|
128
128
|
* @summary Delete multiple deals in bulk
|
129
129
|
* @param {string} ids The comma-separated IDs that will be deleted
|
130
|
-
|
130
|
+
* @deprecated
|
131
131
|
* @throws {RequiredError}
|
132
132
|
*/
|
133
133
|
deleteDeals: (ids: string) => Promise<RequestArgs>;
|
@@ -139,23 +139,70 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
139
139
|
* @throws {RequiredError}
|
140
140
|
*/
|
141
141
|
duplicateDeal: (id: number) => Promise<RequestArgs>;
|
142
|
+
/**
|
143
|
+
* Returns all archived deals.
|
144
|
+
* @summary Get all archived deals
|
145
|
+
* @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.
|
146
|
+
* @param {number} [filter_id] The ID of the filter to use
|
147
|
+
* @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
|
148
|
+
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
149
|
+
* @param {number} [product_id] If supplied, only deals linked to the specified product are returned. If filter_id is provided, this is ignored.
|
150
|
+
* @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
|
151
|
+
* @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
|
152
|
+
* @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.
|
153
|
+
* @param {number} [start] Pagination start
|
154
|
+
* @param {number} [limit] Items shown per page
|
155
|
+
* @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).
|
156
|
+
* @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.
|
157
|
+
* @deprecated
|
158
|
+
* @throws {RequiredError}
|
159
|
+
*/
|
160
|
+
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<RequestArgs>;
|
161
|
+
/**
|
162
|
+
* Returns a summary of all archived deals.
|
163
|
+
* @summary Get archived deals summary
|
164
|
+
* @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.
|
165
|
+
* @param {number} [filter_id] <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
|
166
|
+
* @param {number} [user_id] Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.
|
167
|
+
* @param {number} [pipeline_id] Only deals within the given pipeline will be returned
|
168
|
+
* @param {number} [stage_id] Only deals within the given stage will be returned
|
169
|
+
* @deprecated
|
170
|
+
* @throws {RequiredError}
|
171
|
+
*/
|
172
|
+
getArchivedDealsSummary: (status?: 'open' | 'won' | 'lost', filter_id?: number, user_id?: number, pipeline_id?: number, stage_id?: number) => Promise<RequestArgs>;
|
173
|
+
/**
|
174
|
+
* 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`.
|
175
|
+
* @summary Get archived deals timeline
|
176
|
+
* @param {string} start_date The date when the first interval starts. Format: YYYY-MM-DD.
|
177
|
+
* @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>
|
178
|
+
* @param {number} amount The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months).
|
179
|
+
* @param {string} field_key The date field key which deals will be retrieved from
|
180
|
+
* @param {number} [user_id] If supplied, only deals matching the given user will be returned
|
181
|
+
* @param {number} [pipeline_id] If supplied, only deals matching the given pipeline will be returned
|
182
|
+
* @param {number} [filter_id] If supplied, only deals matching the given filter will be returned
|
183
|
+
* @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.
|
184
|
+
* @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.
|
185
|
+
* @deprecated
|
186
|
+
* @throws {RequiredError}
|
187
|
+
*/
|
188
|
+
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<RequestArgs>;
|
142
189
|
/**
|
143
190
|
* Returns the details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of dealFields. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-details-of-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">getting details of a deal</a>.
|
144
191
|
* @summary Get details of a deal
|
145
192
|
* @param {number} id The ID of the deal
|
146
|
-
|
193
|
+
* @deprecated
|
147
194
|
* @throws {RequiredError}
|
148
195
|
*/
|
149
196
|
getDeal: (id: number) => Promise<RequestArgs>;
|
150
197
|
/**
|
151
|
-
* Lists activities associated with a deal.
|
198
|
+
* Lists activities associated with a deal. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivities\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/activities?deal_id={id}</a> instead.
|
152
199
|
* @summary List activities associated with a deal
|
153
200
|
* @param {number} id The ID of the deal
|
154
201
|
* @param {number} [start] Pagination start
|
155
202
|
* @param {number} [limit] Items shown per page
|
156
203
|
* @param {0 | 1} [done] Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted, returns both Done and Not done activities.
|
157
204
|
* @param {string} [exclude] A comma-separated string of activity IDs to exclude from result
|
158
|
-
|
205
|
+
* @deprecated
|
159
206
|
* @throws {RequiredError}
|
160
207
|
*/
|
161
208
|
getDealActivities: (id: number, start?: number, limit?: number, done?: 0 | 1, exclude?: string) => Promise<RequestArgs>;
|
@@ -219,12 +266,12 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
219
266
|
*/
|
220
267
|
getDealParticipantsChangelog: (id: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
221
268
|
/**
|
222
|
-
* Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.<br>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.
|
269
|
+
* Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.<br>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. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersons\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/persons?deal_id={id}</a> instead.
|
223
270
|
* @summary List all persons associated with a deal
|
224
271
|
* @param {number} id The ID of the deal
|
225
272
|
* @param {number} [start] Pagination start
|
226
273
|
* @param {number} [limit] Items shown per page
|
227
|
-
|
274
|
+
* @deprecated
|
228
275
|
* @throws {RequiredError}
|
229
276
|
*/
|
230
277
|
getDealPersons: (id: number, start?: number, limit?: number) => Promise<RequestArgs>;
|
@@ -235,7 +282,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
235
282
|
* @param {number} [start] Pagination start
|
236
283
|
* @param {number} [limit] Items shown per page
|
237
284
|
* @param {0 | 1} [include_product_data] Whether to fetch product data along with each attached product (1) or not (0, default)
|
238
|
-
|
285
|
+
* @deprecated
|
239
286
|
* @throws {RequiredError}
|
240
287
|
*/
|
241
288
|
getDealProducts: (id: number, start?: number, limit?: number, include_product_data?: 0 | 1) => Promise<RequestArgs>;
|
@@ -260,7 +307,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
260
307
|
*/
|
261
308
|
getDealUsers: (id: number) => Promise<RequestArgs>;
|
262
309
|
/**
|
263
|
-
* Returns all deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
|
310
|
+
* Returns all not archived deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
|
264
311
|
* @summary Get all deals
|
265
312
|
* @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.
|
266
313
|
* @param {number} [filter_id] The ID of the filter to use
|
@@ -270,13 +317,13 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
270
317
|
* @param {number} [limit] Items shown per page
|
271
318
|
* @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).
|
272
319
|
* @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.
|
273
|
-
|
320
|
+
* @deprecated
|
274
321
|
* @throws {RequiredError}
|
275
322
|
*/
|
276
323
|
getDeals: (user_id?: number, filter_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<RequestArgs>;
|
277
324
|
/**
|
278
|
-
* Returns all deals.
|
279
|
-
* @summary Get all deals
|
325
|
+
* Returns all deals. Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeals\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/deals</a> instead.
|
326
|
+
* @summary Get all deals collection
|
280
327
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
281
328
|
* @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.
|
282
329
|
* @param {string} [since] The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
|
@@ -284,12 +331,12 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
284
331
|
* @param {number} [user_id] If supplied, only deals matching the given user will be returned
|
285
332
|
* @param {number} [stage_id] If supplied, only deals within the given stage will be returned
|
286
333
|
* @param {'open' | 'won' | 'lost' | '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.
|
287
|
-
|
334
|
+
* @deprecated
|
288
335
|
* @throws {RequiredError}
|
289
336
|
*/
|
290
337
|
getDealsCollection: (cursor?: string, limit?: number, since?: string, until?: string, user_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted') => Promise<RequestArgs>;
|
291
338
|
/**
|
292
|
-
* Returns a summary of all
|
339
|
+
* Returns a summary of all not archived deals.
|
293
340
|
* @summary Get deals summary
|
294
341
|
* @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.
|
295
342
|
* @param {number} [filter_id] <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
|
@@ -301,7 +348,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
301
348
|
*/
|
302
349
|
getDealsSummary: (status?: 'open' | 'won' | 'lost', filter_id?: number, user_id?: number, pipeline_id?: number, stage_id?: number) => Promise<RequestArgs>;
|
303
350
|
/**
|
304
|
-
* Returns 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`.
|
351
|
+
* 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`.
|
305
352
|
* @summary Get deals timeline
|
306
353
|
* @param {string} start_date The date when the first interval starts. Format: YYYY-MM-DD.
|
307
354
|
* @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>
|
@@ -337,7 +384,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
337
384
|
* @param {'deal.cc_email'} [include_fields] Supports including optional fields in the results which are not provided by default
|
338
385
|
* @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
|
339
386
|
* @param {number} [limit] Items shown per page
|
340
|
-
|
387
|
+
* @deprecated
|
341
388
|
* @throws {RequiredError}
|
342
389
|
*/
|
343
390
|
searchDeals: (term: string, fields?: 'custom_fields' | 'notes' | 'title', exact_match?: boolean, person_id?: number, organization_id?: number, status?: 'open' | 'won' | 'lost', include_fields?: 'deal.cc_email', start?: number, limit?: number) => Promise<RequestArgs>;
|
@@ -346,7 +393,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
346
393
|
* @summary Update a deal
|
347
394
|
* @param {number} id The ID of the deal
|
348
395
|
* @param {UpdateDealRequest} [UpdateDealRequest]
|
349
|
-
|
396
|
+
* @deprecated
|
350
397
|
* @throws {RequiredError}
|
351
398
|
*/
|
352
399
|
updateDeal: (id: number, UpdateDealRequest?: UpdateDealRequest) => Promise<RequestArgs>;
|
@@ -356,7 +403,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
356
403
|
* @param {number} id The ID of the deal
|
357
404
|
* @param {number} product_attachment_id The ID of the deal-product (the ID of the product attached to the deal)
|
358
405
|
* @param {UpdateDealProductRequest} [UpdateDealProductRequest]
|
359
|
-
|
406
|
+
* @deprecated
|
360
407
|
* @throws {RequiredError}
|
361
408
|
*/
|
362
409
|
updateDealProduct: (id: number, product_attachment_id: number, UpdateDealProductRequest?: UpdateDealProductRequest) => Promise<RequestArgs>;
|
@@ -370,7 +417,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
370
417
|
* Adds a new deal. All deals created through the Pipedrive API will have a `origin` set to `API`. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the dealFields and look for `key` values. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/creating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">adding a deal</a>.
|
371
418
|
* @summary Add a deal
|
372
419
|
* @param {AddDealRequest} [AddDealRequest]
|
373
|
-
|
420
|
+
* @deprecated
|
374
421
|
* @throws {RequiredError}
|
375
422
|
*/
|
376
423
|
addDeal(AddDealRequest?: AddDealRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAddedDealResponse>>;
|
@@ -397,7 +444,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
397
444
|
* @summary Add a product to a deal
|
398
445
|
* @param {number} id The ID of the deal
|
399
446
|
* @param {AddDealProductRequest} [AddDealProductRequest]
|
400
|
-
|
447
|
+
* @deprecated
|
401
448
|
* @throws {RequiredError}
|
402
449
|
*/
|
403
450
|
addDealProduct(id: number, AddDealProductRequest?: AddDealProductRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAddProductAttachmentDetailsResponse>>;
|
@@ -405,7 +452,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
405
452
|
* Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
|
406
453
|
* @summary Delete a deal
|
407
454
|
* @param {number} id The ID of the deal
|
408
|
-
|
455
|
+
* @deprecated
|
409
456
|
* @throws {RequiredError}
|
410
457
|
*/
|
411
458
|
deleteDeal(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteDealResponse>>;
|
@@ -432,15 +479,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
432
479
|
* @summary Delete an attached product from a deal
|
433
480
|
* @param {number} id The ID of the deal
|
434
481
|
* @param {number} product_attachment_id The product attachment ID
|
435
|
-
|
482
|
+
* @deprecated
|
436
483
|
* @throws {RequiredError}
|
437
484
|
*/
|
438
485
|
deleteDealProduct(id: number, product_attachment_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteDealProductResponse>>;
|
439
486
|
/**
|
440
|
-
* Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.
|
487
|
+
* Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#deleteDeal\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/deals/{id}</a> instead.
|
441
488
|
* @summary Delete multiple deals in bulk
|
442
489
|
* @param {string} ids The comma-separated IDs that will be deleted
|
443
|
-
|
490
|
+
* @deprecated
|
444
491
|
* @throws {RequiredError}
|
445
492
|
*/
|
446
493
|
deleteDeals(ids: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteDealsResponse>>;
|
@@ -452,23 +499,70 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
452
499
|
* @throws {RequiredError}
|
453
500
|
*/
|
454
501
|
duplicateDeal(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDuplicatedDealResponse>>;
|
502
|
+
/**
|
503
|
+
* Returns all archived deals.
|
504
|
+
* @summary Get all archived deals
|
505
|
+
* @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.
|
506
|
+
* @param {number} [filter_id] The ID of the filter to use
|
507
|
+
* @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
|
508
|
+
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
509
|
+
* @param {number} [product_id] If supplied, only deals linked to the specified product are returned. If filter_id is provided, this is ignored.
|
510
|
+
* @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
|
511
|
+
* @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
|
512
|
+
* @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.
|
513
|
+
* @param {number} [start] Pagination start
|
514
|
+
* @param {number} [limit] Items shown per page
|
515
|
+
* @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).
|
516
|
+
* @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.
|
517
|
+
* @deprecated
|
518
|
+
* @throws {RequiredError}
|
519
|
+
*/
|
520
|
+
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<GetDealsResponse>>;
|
521
|
+
/**
|
522
|
+
* Returns a summary of all archived deals.
|
523
|
+
* @summary Get archived deals summary
|
524
|
+
* @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.
|
525
|
+
* @param {number} [filter_id] <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
|
526
|
+
* @param {number} [user_id] Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.
|
527
|
+
* @param {number} [pipeline_id] Only deals within the given pipeline will be returned
|
528
|
+
* @param {number} [stage_id] Only deals within the given stage will be returned
|
529
|
+
* @deprecated
|
530
|
+
* @throws {RequiredError}
|
531
|
+
*/
|
532
|
+
getArchivedDealsSummary(status?: 'open' | 'won' | 'lost', filter_id?: number, user_id?: number, pipeline_id?: number, stage_id?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsSummaryResponse>>;
|
533
|
+
/**
|
534
|
+
* 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`.
|
535
|
+
* @summary Get archived deals timeline
|
536
|
+
* @param {string} start_date The date when the first interval starts. Format: YYYY-MM-DD.
|
537
|
+
* @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>
|
538
|
+
* @param {number} amount The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months).
|
539
|
+
* @param {string} field_key The date field key which deals will be retrieved from
|
540
|
+
* @param {number} [user_id] If supplied, only deals matching the given user will be returned
|
541
|
+
* @param {number} [pipeline_id] If supplied, only deals matching the given pipeline will be returned
|
542
|
+
* @param {number} [filter_id] If supplied, only deals matching the given filter will be returned
|
543
|
+
* @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.
|
544
|
+
* @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.
|
545
|
+
* @deprecated
|
546
|
+
* @throws {RequiredError}
|
547
|
+
*/
|
548
|
+
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<GetDealsTimelineResponse>>;
|
455
549
|
/**
|
456
550
|
* Returns the details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of dealFields. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-details-of-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">getting details of a deal</a>.
|
457
551
|
* @summary Get details of a deal
|
458
552
|
* @param {number} id The ID of the deal
|
459
|
-
|
553
|
+
* @deprecated
|
460
554
|
* @throws {RequiredError}
|
461
555
|
*/
|
462
556
|
getDeal(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealResponse>>;
|
463
557
|
/**
|
464
|
-
* Lists activities associated with a deal.
|
558
|
+
* Lists activities associated with a deal. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivities\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/activities?deal_id={id}</a> instead.
|
465
559
|
* @summary List activities associated with a deal
|
466
560
|
* @param {number} id The ID of the deal
|
467
561
|
* @param {number} [start] Pagination start
|
468
562
|
* @param {number} [limit] Items shown per page
|
469
563
|
* @param {0 | 1} [done] Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted, returns both Done and Not done activities.
|
470
564
|
* @param {string} [exclude] A comma-separated string of activity IDs to exclude from result
|
471
|
-
|
565
|
+
* @deprecated
|
472
566
|
* @throws {RequiredError}
|
473
567
|
*/
|
474
568
|
getDealActivities(id: number, start?: number, limit?: number, done?: 0 | 1, exclude?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealActivitiesResponse>>;
|
@@ -532,12 +626,12 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
532
626
|
*/
|
533
627
|
getDealParticipantsChangelog(id: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetParticipantsChangelogResponse>>;
|
534
628
|
/**
|
535
|
-
* Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.<br>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.
|
629
|
+
* Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.<br>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. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersons\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/persons?deal_id={id}</a> instead.
|
536
630
|
* @summary List all persons associated with a deal
|
537
631
|
* @param {number} id The ID of the deal
|
538
632
|
* @param {number} [start] Pagination start
|
539
633
|
* @param {number} [limit] Items shown per page
|
540
|
-
|
634
|
+
* @deprecated
|
541
635
|
* @throws {RequiredError}
|
542
636
|
*/
|
543
637
|
getDealPersons(id: number, start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonsResponse>>;
|
@@ -548,7 +642,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
548
642
|
* @param {number} [start] Pagination start
|
549
643
|
* @param {number} [limit] Items shown per page
|
550
644
|
* @param {0 | 1} [include_product_data] Whether to fetch product data along with each attached product (1) or not (0, default)
|
551
|
-
|
645
|
+
* @deprecated
|
552
646
|
* @throws {RequiredError}
|
553
647
|
*/
|
554
648
|
getDealProducts(id: number, start?: number, limit?: number, include_product_data?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductsResponse>>;
|
@@ -573,7 +667,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
573
667
|
*/
|
574
668
|
getDealUsers(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPermittedUsersResponse>>;
|
575
669
|
/**
|
576
|
-
* Returns all deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
|
670
|
+
* Returns all not archived deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
|
577
671
|
* @summary Get all deals
|
578
672
|
* @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.
|
579
673
|
* @param {number} [filter_id] The ID of the filter to use
|
@@ -583,13 +677,13 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
583
677
|
* @param {number} [limit] Items shown per page
|
584
678
|
* @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).
|
585
679
|
* @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.
|
586
|
-
|
680
|
+
* @deprecated
|
587
681
|
* @throws {RequiredError}
|
588
682
|
*/
|
589
683
|
getDeals(user_id?: number, filter_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<GetDealsResponse>>;
|
590
684
|
/**
|
591
|
-
* Returns all deals.
|
592
|
-
* @summary Get all deals
|
685
|
+
* Returns all deals. Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeals\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/deals</a> instead.
|
686
|
+
* @summary Get all deals collection
|
593
687
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
594
688
|
* @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.
|
595
689
|
* @param {string} [since] The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
|
@@ -597,12 +691,12 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
597
691
|
* @param {number} [user_id] If supplied, only deals matching the given user will be returned
|
598
692
|
* @param {number} [stage_id] If supplied, only deals within the given stage will be returned
|
599
693
|
* @param {'open' | 'won' | 'lost' | '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.
|
600
|
-
|
694
|
+
* @deprecated
|
601
695
|
* @throws {RequiredError}
|
602
696
|
*/
|
603
697
|
getDealsCollection(cursor?: string, limit?: number, since?: string, until?: string, user_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsCollectionResponse>>;
|
604
698
|
/**
|
605
|
-
* Returns a summary of all
|
699
|
+
* Returns a summary of all not archived deals.
|
606
700
|
* @summary Get deals summary
|
607
701
|
* @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.
|
608
702
|
* @param {number} [filter_id] <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
|
@@ -614,7 +708,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
614
708
|
*/
|
615
709
|
getDealsSummary(status?: 'open' | 'won' | 'lost', filter_id?: number, user_id?: number, pipeline_id?: number, stage_id?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsSummaryResponse>>;
|
616
710
|
/**
|
617
|
-
* Returns 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`.
|
711
|
+
* 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`.
|
618
712
|
* @summary Get deals timeline
|
619
713
|
* @param {string} start_date The date when the first interval starts. Format: YYYY-MM-DD.
|
620
714
|
* @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>
|
@@ -650,7 +744,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
650
744
|
* @param {'deal.cc_email'} [include_fields] Supports including optional fields in the results which are not provided by default
|
651
745
|
* @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
|
652
746
|
* @param {number} [limit] Items shown per page
|
653
|
-
|
747
|
+
* @deprecated
|
654
748
|
* @throws {RequiredError}
|
655
749
|
*/
|
656
750
|
searchDeals(term: string, fields?: 'custom_fields' | 'notes' | 'title', exact_match?: boolean, person_id?: number, organization_id?: number, status?: 'open' | 'won' | 'lost', include_fields?: 'deal.cc_email', start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealSearchResponse>>;
|
@@ -659,7 +753,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
659
753
|
* @summary Update a deal
|
660
754
|
* @param {number} id The ID of the deal
|
661
755
|
* @param {UpdateDealRequest} [UpdateDealRequest]
|
662
|
-
|
756
|
+
* @deprecated
|
663
757
|
* @throws {RequiredError}
|
664
758
|
*/
|
665
759
|
updateDeal(id: number, UpdateDealRequest?: UpdateDealRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAddedDealResponse>>;
|
@@ -669,7 +763,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
669
763
|
* @param {number} id The ID of the deal
|
670
764
|
* @param {number} product_attachment_id The ID of the deal-product (the ID of the product attached to the deal)
|
671
765
|
* @param {UpdateDealProductRequest} [UpdateDealProductRequest]
|
672
|
-
|
766
|
+
* @deprecated
|
673
767
|
* @throws {RequiredError}
|
674
768
|
*/
|
675
769
|
updateDealProduct(id: number, product_attachment_id: number, UpdateDealProductRequest?: UpdateDealProductRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductAttachmentDetailsResponse>>;
|
@@ -683,7 +777,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
683
777
|
* Adds a new deal. All deals created through the Pipedrive API will have a `origin` set to `API`. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the dealFields and look for `key` values. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/creating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">adding a deal</a>.
|
684
778
|
* @summary Add a deal
|
685
779
|
* @param {DealsApiAddDealRequest} requestParameters Request parameters.
|
686
|
-
|
780
|
+
* @deprecated
|
687
781
|
* @throws {RequiredError}
|
688
782
|
*/
|
689
783
|
addDeal(requestParameters?: DealsApiAddDealRequest): Promise<GetAddedDealResponse>;
|
@@ -707,7 +801,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
707
801
|
* Adds a product to a deal, creating a new item called a deal-product.
|
708
802
|
* @summary Add a product to a deal
|
709
803
|
* @param {DealsApiAddDealProductRequest} requestParameters Request parameters.
|
710
|
-
|
804
|
+
* @deprecated
|
711
805
|
* @throws {RequiredError}
|
712
806
|
*/
|
713
807
|
addDealProduct(requestParameters: DealsApiAddDealProductRequest): Promise<GetAddProductAttachmentDetailsResponse>;
|
@@ -715,7 +809,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
715
809
|
* Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
|
716
810
|
* @summary Delete a deal
|
717
811
|
* @param {DealsApiDeleteDealRequest} requestParameters Request parameters.
|
718
|
-
|
812
|
+
* @deprecated
|
719
813
|
* @throws {RequiredError}
|
720
814
|
*/
|
721
815
|
deleteDeal(requestParameters: DealsApiDeleteDealRequest): Promise<DeleteDealResponse>;
|
@@ -739,15 +833,15 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
739
833
|
* Deletes a product attachment from a deal, using the `product_attachment_id` Not possible to delete the attached product if the deal has installments associated and the product is the last one enabled
|
740
834
|
* @summary Delete an attached product from a deal
|
741
835
|
* @param {DealsApiDeleteDealProductRequest} requestParameters Request parameters.
|
742
|
-
|
836
|
+
* @deprecated
|
743
837
|
* @throws {RequiredError}
|
744
838
|
*/
|
745
839
|
deleteDealProduct(requestParameters: DealsApiDeleteDealProductRequest): Promise<DeleteDealProductResponse>;
|
746
840
|
/**
|
747
|
-
* Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.
|
841
|
+
* Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#deleteDeal\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/deals/{id}</a> instead.
|
748
842
|
* @summary Delete multiple deals in bulk
|
749
843
|
* @param {DealsApiDeleteDealsRequest} requestParameters Request parameters.
|
750
|
-
|
844
|
+
* @deprecated
|
751
845
|
* @throws {RequiredError}
|
752
846
|
*/
|
753
847
|
deleteDeals(requestParameters: DealsApiDeleteDealsRequest): Promise<DeleteDealsResponse>;
|
@@ -759,19 +853,43 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
759
853
|
* @throws {RequiredError}
|
760
854
|
*/
|
761
855
|
duplicateDeal(requestParameters: DealsApiDuplicateDealRequest): Promise<GetDuplicatedDealResponse>;
|
856
|
+
/**
|
857
|
+
* Returns all archived deals.
|
858
|
+
* @summary Get all archived deals
|
859
|
+
* @param {DealsApiGetArchivedDealsRequest} requestParameters Request parameters.
|
860
|
+
* @deprecated
|
861
|
+
* @throws {RequiredError}
|
862
|
+
*/
|
863
|
+
getArchivedDeals(requestParameters?: DealsApiGetArchivedDealsRequest): Promise<GetDealsResponse>;
|
864
|
+
/**
|
865
|
+
* Returns a summary of all archived deals.
|
866
|
+
* @summary Get archived deals summary
|
867
|
+
* @param {DealsApiGetArchivedDealsSummaryRequest} requestParameters Request parameters.
|
868
|
+
* @deprecated
|
869
|
+
* @throws {RequiredError}
|
870
|
+
*/
|
871
|
+
getArchivedDealsSummary(requestParameters?: DealsApiGetArchivedDealsSummaryRequest): Promise<GetDealsSummaryResponse>;
|
872
|
+
/**
|
873
|
+
* 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`.
|
874
|
+
* @summary Get archived deals timeline
|
875
|
+
* @param {DealsApiGetArchivedDealsTimelineRequest} requestParameters Request parameters.
|
876
|
+
* @deprecated
|
877
|
+
* @throws {RequiredError}
|
878
|
+
*/
|
879
|
+
getArchivedDealsTimeline(requestParameters: DealsApiGetArchivedDealsTimelineRequest): Promise<GetDealsTimelineResponse>;
|
762
880
|
/**
|
763
881
|
* Returns the details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of dealFields. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-details-of-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">getting details of a deal</a>.
|
764
882
|
* @summary Get details of a deal
|
765
883
|
* @param {DealsApiGetDealRequest} requestParameters Request parameters.
|
766
|
-
|
884
|
+
* @deprecated
|
767
885
|
* @throws {RequiredError}
|
768
886
|
*/
|
769
887
|
getDeal(requestParameters: DealsApiGetDealRequest): Promise<GetDealResponse>;
|
770
888
|
/**
|
771
|
-
* Lists activities associated with a deal.
|
889
|
+
* Lists activities associated with a deal. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivities\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/activities?deal_id={id}</a> instead.
|
772
890
|
* @summary List activities associated with a deal
|
773
891
|
* @param {DealsApiGetDealActivitiesRequest} requestParameters Request parameters.
|
774
|
-
|
892
|
+
* @deprecated
|
775
893
|
* @throws {RequiredError}
|
776
894
|
*/
|
777
895
|
getDealActivities(requestParameters: DealsApiGetDealActivitiesRequest): Promise<GetDealActivitiesResponse>;
|
@@ -824,10 +942,10 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
824
942
|
*/
|
825
943
|
getDealParticipantsChangelog(requestParameters: DealsApiGetDealParticipantsChangelogRequest): Promise<GetParticipantsChangelogResponse>;
|
826
944
|
/**
|
827
|
-
* Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.<br>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.
|
945
|
+
* Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.<br>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. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersons\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/persons?deal_id={id}</a> instead.
|
828
946
|
* @summary List all persons associated with a deal
|
829
947
|
* @param {DealsApiGetDealPersonsRequest} requestParameters Request parameters.
|
830
|
-
|
948
|
+
* @deprecated
|
831
949
|
* @throws {RequiredError}
|
832
950
|
*/
|
833
951
|
getDealPersons(requestParameters: DealsApiGetDealPersonsRequest): Promise<GetPersonsResponse>;
|
@@ -835,7 +953,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
835
953
|
* Lists products attached to a deal.
|
836
954
|
* @summary List products attached to a deal
|
837
955
|
* @param {DealsApiGetDealProductsRequest} requestParameters Request parameters.
|
838
|
-
|
956
|
+
* @deprecated
|
839
957
|
* @throws {RequiredError}
|
840
958
|
*/
|
841
959
|
getDealProducts(requestParameters: DealsApiGetDealProductsRequest): Promise<GetProductsResponse>;
|
@@ -856,23 +974,23 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
856
974
|
*/
|
857
975
|
getDealUsers(requestParameters: DealsApiGetDealUsersRequest): Promise<GetPermittedUsersResponse>;
|
858
976
|
/**
|
859
|
-
* Returns all deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
|
977
|
+
* Returns all not archived deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
|
860
978
|
* @summary Get all deals
|
861
979
|
* @param {DealsApiGetDealsRequest} requestParameters Request parameters.
|
862
|
-
|
980
|
+
* @deprecated
|
863
981
|
* @throws {RequiredError}
|
864
982
|
*/
|
865
983
|
getDeals(requestParameters?: DealsApiGetDealsRequest): Promise<GetDealsResponse>;
|
866
984
|
/**
|
867
|
-
* Returns all deals.
|
868
|
-
* @summary Get all deals
|
985
|
+
* Returns all deals. Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeals\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/deals</a> instead.
|
986
|
+
* @summary Get all deals collection
|
869
987
|
* @param {DealsApiGetDealsCollectionRequest} requestParameters Request parameters.
|
870
|
-
|
988
|
+
* @deprecated
|
871
989
|
* @throws {RequiredError}
|
872
990
|
*/
|
873
991
|
getDealsCollection(requestParameters?: DealsApiGetDealsCollectionRequest): Promise<GetDealsCollectionResponse>;
|
874
992
|
/**
|
875
|
-
* Returns a summary of all
|
993
|
+
* Returns a summary of all not archived deals.
|
876
994
|
* @summary Get deals summary
|
877
995
|
* @param {DealsApiGetDealsSummaryRequest} requestParameters Request parameters.
|
878
996
|
|
@@ -880,7 +998,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
880
998
|
*/
|
881
999
|
getDealsSummary(requestParameters?: DealsApiGetDealsSummaryRequest): Promise<GetDealsSummaryResponse>;
|
882
1000
|
/**
|
883
|
-
* Returns 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`.
|
1001
|
+
* 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`.
|
884
1002
|
* @summary Get deals timeline
|
885
1003
|
* @param {DealsApiGetDealsTimelineRequest} requestParameters Request parameters.
|
886
1004
|
|
@@ -899,7 +1017,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
899
1017
|
* Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID.
|
900
1018
|
* @summary Search deals
|
901
1019
|
* @param {DealsApiSearchDealsRequest} requestParameters Request parameters.
|
902
|
-
|
1020
|
+
* @deprecated
|
903
1021
|
* @throws {RequiredError}
|
904
1022
|
*/
|
905
1023
|
searchDeals(requestParameters: DealsApiSearchDealsRequest): Promise<GetDealSearchResponse>;
|
@@ -907,7 +1025,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
907
1025
|
* Updates the properties of a deal. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/updating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">updating a deal</a>.
|
908
1026
|
* @summary Update a deal
|
909
1027
|
* @param {DealsApiUpdateDealRequest} requestParameters Request parameters.
|
910
|
-
|
1028
|
+
* @deprecated
|
911
1029
|
* @throws {RequiredError}
|
912
1030
|
*/
|
913
1031
|
updateDeal(requestParameters: DealsApiUpdateDealRequest): Promise<GetAddedDealResponse>;
|
@@ -915,7 +1033,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
915
1033
|
* Updates the details of the product that has been attached to a deal.
|
916
1034
|
* @summary Update the product attached to a deal
|
917
1035
|
* @param {DealsApiUpdateDealProductRequest} requestParameters Request parameters.
|
918
|
-
|
1036
|
+
* @deprecated
|
919
1037
|
* @throws {RequiredError}
|
920
1038
|
*/
|
921
1039
|
updateDealProduct(requestParameters: DealsApiUpdateDealProductRequest): Promise<GetProductAttachmentDetailsResponse>;
|
@@ -1086,6 +1204,183 @@ export interface DealsApiDuplicateDealRequest {
|
|
1086
1204
|
*/
|
1087
1205
|
readonly id: number;
|
1088
1206
|
}
|
1207
|
+
/**
|
1208
|
+
* Request parameters for getArchivedDeals operation in DealsApi.
|
1209
|
+
* @export
|
1210
|
+
* @interface DealsApiGetArchivedDealsRequest
|
1211
|
+
*/
|
1212
|
+
export interface DealsApiGetArchivedDealsRequest {
|
1213
|
+
/**
|
1214
|
+
* 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.
|
1215
|
+
* @type {number}
|
1216
|
+
* @memberof DealsApiGetArchivedDeals
|
1217
|
+
*/
|
1218
|
+
readonly user_id?: number;
|
1219
|
+
/**
|
1220
|
+
* The ID of the filter to use
|
1221
|
+
* @type {number}
|
1222
|
+
* @memberof DealsApiGetArchivedDeals
|
1223
|
+
*/
|
1224
|
+
readonly filter_id?: number;
|
1225
|
+
/**
|
1226
|
+
* If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
|
1227
|
+
* @type {number}
|
1228
|
+
* @memberof DealsApiGetArchivedDeals
|
1229
|
+
*/
|
1230
|
+
readonly person_id?: number;
|
1231
|
+
/**
|
1232
|
+
* If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
1233
|
+
* @type {number}
|
1234
|
+
* @memberof DealsApiGetArchivedDeals
|
1235
|
+
*/
|
1236
|
+
readonly org_id?: number;
|
1237
|
+
/**
|
1238
|
+
* If supplied, only deals linked to the specified product are returned. If filter_id is provided, this is ignored.
|
1239
|
+
* @type {number}
|
1240
|
+
* @memberof DealsApiGetArchivedDeals
|
1241
|
+
*/
|
1242
|
+
readonly product_id?: number;
|
1243
|
+
/**
|
1244
|
+
* If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
|
1245
|
+
* @type {number}
|
1246
|
+
* @memberof DealsApiGetArchivedDeals
|
1247
|
+
*/
|
1248
|
+
readonly pipeline_id?: number;
|
1249
|
+
/**
|
1250
|
+
* If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
|
1251
|
+
* @type {number}
|
1252
|
+
* @memberof DealsApiGetArchivedDeals
|
1253
|
+
*/
|
1254
|
+
readonly stage_id?: number;
|
1255
|
+
/**
|
1256
|
+
* 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.
|
1257
|
+
* @type {'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted'}
|
1258
|
+
* @memberof DealsApiGetArchivedDeals
|
1259
|
+
*/
|
1260
|
+
readonly status?: 'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted';
|
1261
|
+
/**
|
1262
|
+
* Pagination start
|
1263
|
+
* @type {number}
|
1264
|
+
* @memberof DealsApiGetArchivedDeals
|
1265
|
+
*/
|
1266
|
+
readonly start?: number;
|
1267
|
+
/**
|
1268
|
+
* Items shown per page
|
1269
|
+
* @type {number}
|
1270
|
+
* @memberof DealsApiGetArchivedDeals
|
1271
|
+
*/
|
1272
|
+
readonly limit?: number;
|
1273
|
+
/**
|
1274
|
+
* 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).
|
1275
|
+
* @type {string}
|
1276
|
+
* @memberof DealsApiGetArchivedDeals
|
1277
|
+
*/
|
1278
|
+
readonly sort?: string;
|
1279
|
+
/**
|
1280
|
+
* When supplied, only deals owned by you are returned. However, `filter_id` takes precedence over `owned_by_you` when both are supplied.
|
1281
|
+
* @type {0 | 1}
|
1282
|
+
* @memberof DealsApiGetArchivedDeals
|
1283
|
+
*/
|
1284
|
+
readonly owned_by_you?: 0 | 1;
|
1285
|
+
}
|
1286
|
+
/**
|
1287
|
+
* Request parameters for getArchivedDealsSummary operation in DealsApi.
|
1288
|
+
* @export
|
1289
|
+
* @interface DealsApiGetArchivedDealsSummaryRequest
|
1290
|
+
*/
|
1291
|
+
export interface DealsApiGetArchivedDealsSummaryRequest {
|
1292
|
+
/**
|
1293
|
+
* Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.
|
1294
|
+
* @type {'open' | 'won' | 'lost'}
|
1295
|
+
* @memberof DealsApiGetArchivedDealsSummary
|
1296
|
+
*/
|
1297
|
+
readonly status?: 'open' | 'won' | 'lost';
|
1298
|
+
/**
|
1299
|
+
* <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
|
1300
|
+
* @type {number}
|
1301
|
+
* @memberof DealsApiGetArchivedDealsSummary
|
1302
|
+
*/
|
1303
|
+
readonly filter_id?: number;
|
1304
|
+
/**
|
1305
|
+
* Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.
|
1306
|
+
* @type {number}
|
1307
|
+
* @memberof DealsApiGetArchivedDealsSummary
|
1308
|
+
*/
|
1309
|
+
readonly user_id?: number;
|
1310
|
+
/**
|
1311
|
+
* Only deals within the given pipeline will be returned
|
1312
|
+
* @type {number}
|
1313
|
+
* @memberof DealsApiGetArchivedDealsSummary
|
1314
|
+
*/
|
1315
|
+
readonly pipeline_id?: number;
|
1316
|
+
/**
|
1317
|
+
* Only deals within the given stage will be returned
|
1318
|
+
* @type {number}
|
1319
|
+
* @memberof DealsApiGetArchivedDealsSummary
|
1320
|
+
*/
|
1321
|
+
readonly stage_id?: number;
|
1322
|
+
}
|
1323
|
+
/**
|
1324
|
+
* Request parameters for getArchivedDealsTimeline operation in DealsApi.
|
1325
|
+
* @export
|
1326
|
+
* @interface DealsApiGetArchivedDealsTimelineRequest
|
1327
|
+
*/
|
1328
|
+
export interface DealsApiGetArchivedDealsTimelineRequest {
|
1329
|
+
/**
|
1330
|
+
* The date when the first interval starts. Format: YYYY-MM-DD.
|
1331
|
+
* @type {string}
|
1332
|
+
* @memberof DealsApiGetArchivedDealsTimeline
|
1333
|
+
*/
|
1334
|
+
readonly start_date: string;
|
1335
|
+
/**
|
1336
|
+
* 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>
|
1337
|
+
* @type {'day' | 'week' | 'month' | 'quarter'}
|
1338
|
+
* @memberof DealsApiGetArchivedDealsTimeline
|
1339
|
+
*/
|
1340
|
+
readonly interval: 'day' | 'week' | 'month' | 'quarter';
|
1341
|
+
/**
|
1342
|
+
* The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months).
|
1343
|
+
* @type {number}
|
1344
|
+
* @memberof DealsApiGetArchivedDealsTimeline
|
1345
|
+
*/
|
1346
|
+
readonly amount: number;
|
1347
|
+
/**
|
1348
|
+
* The date field key which deals will be retrieved from
|
1349
|
+
* @type {string}
|
1350
|
+
* @memberof DealsApiGetArchivedDealsTimeline
|
1351
|
+
*/
|
1352
|
+
readonly field_key: string;
|
1353
|
+
/**
|
1354
|
+
* If supplied, only deals matching the given user will be returned
|
1355
|
+
* @type {number}
|
1356
|
+
* @memberof DealsApiGetArchivedDealsTimeline
|
1357
|
+
*/
|
1358
|
+
readonly user_id?: number;
|
1359
|
+
/**
|
1360
|
+
* If supplied, only deals matching the given pipeline will be returned
|
1361
|
+
* @type {number}
|
1362
|
+
* @memberof DealsApiGetArchivedDealsTimeline
|
1363
|
+
*/
|
1364
|
+
readonly pipeline_id?: number;
|
1365
|
+
/**
|
1366
|
+
* If supplied, only deals matching the given filter will be returned
|
1367
|
+
* @type {number}
|
1368
|
+
* @memberof DealsApiGetArchivedDealsTimeline
|
1369
|
+
*/
|
1370
|
+
readonly filter_id?: number;
|
1371
|
+
/**
|
1372
|
+
* Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned.
|
1373
|
+
* @type {0 | 1}
|
1374
|
+
* @memberof DealsApiGetArchivedDealsTimeline
|
1375
|
+
*/
|
1376
|
+
readonly exclude_deals?: 0 | 1;
|
1377
|
+
/**
|
1378
|
+
* 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.
|
1379
|
+
* @type {string}
|
1380
|
+
* @memberof DealsApiGetArchivedDealsTimeline
|
1381
|
+
*/
|
1382
|
+
readonly totals_convert_currency?: string;
|
1383
|
+
}
|
1089
1384
|
/**
|
1090
1385
|
* Request parameters for getDeal operation in DealsApi.
|
1091
1386
|
* @export
|
@@ -1723,7 +2018,7 @@ export declare class DealsApi extends BaseAPI {
|
|
1723
2018
|
* Adds a new deal. All deals created through the Pipedrive API will have a `origin` set to `API`. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the dealFields and look for `key` values. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/creating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">adding a deal</a>.
|
1724
2019
|
* @summary Add a deal
|
1725
2020
|
* @param {DealsApiAddDealRequest} requestParameters Request parameters.
|
1726
|
-
|
2021
|
+
* @deprecated
|
1727
2022
|
* @throws {RequiredError}
|
1728
2023
|
* @memberof DealsApi
|
1729
2024
|
*/
|
@@ -1750,7 +2045,7 @@ export declare class DealsApi extends BaseAPI {
|
|
1750
2045
|
* Adds a product to a deal, creating a new item called a deal-product.
|
1751
2046
|
* @summary Add a product to a deal
|
1752
2047
|
* @param {DealsApiAddDealProductRequest} requestParameters Request parameters.
|
1753
|
-
|
2048
|
+
* @deprecated
|
1754
2049
|
* @throws {RequiredError}
|
1755
2050
|
* @memberof DealsApi
|
1756
2051
|
*/
|
@@ -1759,7 +2054,7 @@ export declare class DealsApi extends BaseAPI {
|
|
1759
2054
|
* Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
|
1760
2055
|
* @summary Delete a deal
|
1761
2056
|
* @param {DealsApiDeleteDealRequest} requestParameters Request parameters.
|
1762
|
-
|
2057
|
+
* @deprecated
|
1763
2058
|
* @throws {RequiredError}
|
1764
2059
|
* @memberof DealsApi
|
1765
2060
|
*/
|
@@ -1786,16 +2081,16 @@ export declare class DealsApi extends BaseAPI {
|
|
1786
2081
|
* Deletes a product attachment from a deal, using the `product_attachment_id` Not possible to delete the attached product if the deal has installments associated and the product is the last one enabled
|
1787
2082
|
* @summary Delete an attached product from a deal
|
1788
2083
|
* @param {DealsApiDeleteDealProductRequest} requestParameters Request parameters.
|
1789
|
-
|
2084
|
+
* @deprecated
|
1790
2085
|
* @throws {RequiredError}
|
1791
2086
|
* @memberof DealsApi
|
1792
2087
|
*/
|
1793
2088
|
deleteDealProduct(requestParameters: DealsApiDeleteDealProductRequest): Promise<DeleteDealProductResponse>;
|
1794
2089
|
/**
|
1795
|
-
* Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.
|
2090
|
+
* Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#deleteDeal\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/deals/{id}</a> instead.
|
1796
2091
|
* @summary Delete multiple deals in bulk
|
1797
2092
|
* @param {DealsApiDeleteDealsRequest} requestParameters Request parameters.
|
1798
|
-
|
2093
|
+
* @deprecated
|
1799
2094
|
* @throws {RequiredError}
|
1800
2095
|
* @memberof DealsApi
|
1801
2096
|
*/
|
@@ -1809,20 +2104,47 @@ export declare class DealsApi extends BaseAPI {
|
|
1809
2104
|
* @memberof DealsApi
|
1810
2105
|
*/
|
1811
2106
|
duplicateDeal(requestParameters: DealsApiDuplicateDealRequest): Promise<GetDuplicatedDealResponse>;
|
2107
|
+
/**
|
2108
|
+
* Returns all archived deals.
|
2109
|
+
* @summary Get all archived deals
|
2110
|
+
* @param {DealsApiGetArchivedDealsRequest} requestParameters Request parameters.
|
2111
|
+
* @deprecated
|
2112
|
+
* @throws {RequiredError}
|
2113
|
+
* @memberof DealsApi
|
2114
|
+
*/
|
2115
|
+
getArchivedDeals(requestParameters?: DealsApiGetArchivedDealsRequest): Promise<GetDealsResponse>;
|
2116
|
+
/**
|
2117
|
+
* Returns a summary of all archived deals.
|
2118
|
+
* @summary Get archived deals summary
|
2119
|
+
* @param {DealsApiGetArchivedDealsSummaryRequest} requestParameters Request parameters.
|
2120
|
+
* @deprecated
|
2121
|
+
* @throws {RequiredError}
|
2122
|
+
* @memberof DealsApi
|
2123
|
+
*/
|
2124
|
+
getArchivedDealsSummary(requestParameters?: DealsApiGetArchivedDealsSummaryRequest): Promise<GetDealsSummaryResponse>;
|
2125
|
+
/**
|
2126
|
+
* 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`.
|
2127
|
+
* @summary Get archived deals timeline
|
2128
|
+
* @param {DealsApiGetArchivedDealsTimelineRequest} requestParameters Request parameters.
|
2129
|
+
* @deprecated
|
2130
|
+
* @throws {RequiredError}
|
2131
|
+
* @memberof DealsApi
|
2132
|
+
*/
|
2133
|
+
getArchivedDealsTimeline(requestParameters: DealsApiGetArchivedDealsTimelineRequest): Promise<GetDealsTimelineResponse>;
|
1812
2134
|
/**
|
1813
2135
|
* Returns the details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of dealFields. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-details-of-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">getting details of a deal</a>.
|
1814
2136
|
* @summary Get details of a deal
|
1815
2137
|
* @param {DealsApiGetDealRequest} requestParameters Request parameters.
|
1816
|
-
|
2138
|
+
* @deprecated
|
1817
2139
|
* @throws {RequiredError}
|
1818
2140
|
* @memberof DealsApi
|
1819
2141
|
*/
|
1820
2142
|
getDeal(requestParameters: DealsApiGetDealRequest): Promise<GetDealResponse>;
|
1821
2143
|
/**
|
1822
|
-
* Lists activities associated with a deal.
|
2144
|
+
* Lists activities associated with a deal. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivities\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/activities?deal_id={id}</a> instead.
|
1823
2145
|
* @summary List activities associated with a deal
|
1824
2146
|
* @param {DealsApiGetDealActivitiesRequest} requestParameters Request parameters.
|
1825
|
-
|
2147
|
+
* @deprecated
|
1826
2148
|
* @throws {RequiredError}
|
1827
2149
|
* @memberof DealsApi
|
1828
2150
|
*/
|
@@ -1882,10 +2204,10 @@ export declare class DealsApi extends BaseAPI {
|
|
1882
2204
|
*/
|
1883
2205
|
getDealParticipantsChangelog(requestParameters: DealsApiGetDealParticipantsChangelogRequest): Promise<GetParticipantsChangelogResponse>;
|
1884
2206
|
/**
|
1885
|
-
* Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.<br>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.
|
2207
|
+
* Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.<br>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. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersons\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/persons?deal_id={id}</a> instead.
|
1886
2208
|
* @summary List all persons associated with a deal
|
1887
2209
|
* @param {DealsApiGetDealPersonsRequest} requestParameters Request parameters.
|
1888
|
-
|
2210
|
+
* @deprecated
|
1889
2211
|
* @throws {RequiredError}
|
1890
2212
|
* @memberof DealsApi
|
1891
2213
|
*/
|
@@ -1894,7 +2216,7 @@ export declare class DealsApi extends BaseAPI {
|
|
1894
2216
|
* Lists products attached to a deal.
|
1895
2217
|
* @summary List products attached to a deal
|
1896
2218
|
* @param {DealsApiGetDealProductsRequest} requestParameters Request parameters.
|
1897
|
-
|
2219
|
+
* @deprecated
|
1898
2220
|
* @throws {RequiredError}
|
1899
2221
|
* @memberof DealsApi
|
1900
2222
|
*/
|
@@ -1918,25 +2240,25 @@ export declare class DealsApi extends BaseAPI {
|
|
1918
2240
|
*/
|
1919
2241
|
getDealUsers(requestParameters: DealsApiGetDealUsersRequest): Promise<import("../models").BaseResponse1>;
|
1920
2242
|
/**
|
1921
|
-
* Returns all deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
|
2243
|
+
* Returns all not archived deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
|
1922
2244
|
* @summary Get all deals
|
1923
2245
|
* @param {DealsApiGetDealsRequest} requestParameters Request parameters.
|
1924
|
-
|
2246
|
+
* @deprecated
|
1925
2247
|
* @throws {RequiredError}
|
1926
2248
|
* @memberof DealsApi
|
1927
2249
|
*/
|
1928
2250
|
getDeals(requestParameters?: DealsApiGetDealsRequest): Promise<GetDealsResponse>;
|
1929
2251
|
/**
|
1930
|
-
* Returns all deals.
|
1931
|
-
* @summary Get all deals
|
2252
|
+
* Returns all deals. Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeals\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/deals</a> instead.
|
2253
|
+
* @summary Get all deals collection
|
1932
2254
|
* @param {DealsApiGetDealsCollectionRequest} requestParameters Request parameters.
|
1933
|
-
|
2255
|
+
* @deprecated
|
1934
2256
|
* @throws {RequiredError}
|
1935
2257
|
* @memberof DealsApi
|
1936
2258
|
*/
|
1937
2259
|
getDealsCollection(requestParameters?: DealsApiGetDealsCollectionRequest): Promise<GetDealsCollectionResponse>;
|
1938
2260
|
/**
|
1939
|
-
* Returns a summary of all
|
2261
|
+
* Returns a summary of all not archived deals.
|
1940
2262
|
* @summary Get deals summary
|
1941
2263
|
* @param {DealsApiGetDealsSummaryRequest} requestParameters Request parameters.
|
1942
2264
|
|
@@ -1945,7 +2267,7 @@ export declare class DealsApi extends BaseAPI {
|
|
1945
2267
|
*/
|
1946
2268
|
getDealsSummary(requestParameters?: DealsApiGetDealsSummaryRequest): Promise<GetDealsSummaryResponse>;
|
1947
2269
|
/**
|
1948
|
-
* Returns 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`.
|
2270
|
+
* 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`.
|
1949
2271
|
* @summary Get deals timeline
|
1950
2272
|
* @param {DealsApiGetDealsTimelineRequest} requestParameters Request parameters.
|
1951
2273
|
|
@@ -1966,7 +2288,7 @@ export declare class DealsApi extends BaseAPI {
|
|
1966
2288
|
* Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID.
|
1967
2289
|
* @summary Search deals
|
1968
2290
|
* @param {DealsApiSearchDealsRequest} requestParameters Request parameters.
|
1969
|
-
|
2291
|
+
* @deprecated
|
1970
2292
|
* @throws {RequiredError}
|
1971
2293
|
* @memberof DealsApi
|
1972
2294
|
*/
|
@@ -1975,7 +2297,7 @@ export declare class DealsApi extends BaseAPI {
|
|
1975
2297
|
* Updates the properties of a deal. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/updating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">updating a deal</a>.
|
1976
2298
|
* @summary Update a deal
|
1977
2299
|
* @param {DealsApiUpdateDealRequest} requestParameters Request parameters.
|
1978
|
-
|
2300
|
+
* @deprecated
|
1979
2301
|
* @throws {RequiredError}
|
1980
2302
|
* @memberof DealsApi
|
1981
2303
|
*/
|
@@ -1984,7 +2306,7 @@ export declare class DealsApi extends BaseAPI {
|
|
1984
2306
|
* Updates the details of the product that has been attached to a deal.
|
1985
2307
|
* @summary Update the product attached to a deal
|
1986
2308
|
* @param {DealsApiUpdateDealProductRequest} requestParameters Request parameters.
|
1987
|
-
|
2309
|
+
* @deprecated
|
1988
2310
|
* @throws {RequiredError}
|
1989
2311
|
* @memberof DealsApi
|
1990
2312
|
*/
|