pipedrive 36.0.1 → 36.1.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/activity-fields-api.d.ts +17 -1
- package/dist/esm/versions/v1/api/activity-fields-api.js +25 -0
- package/dist/esm/versions/v1/api/activity-types-api.d.ts +72 -1
- package/dist/esm/versions/v1/api/activity-types-api.js +107 -0
- package/dist/esm/versions/v1/api/billing-api.d.ts +17 -1
- package/dist/esm/versions/v1/api/billing-api.js +25 -0
- package/dist/esm/versions/v1/api/call-logs-api.d.ts +93 -1
- package/dist/esm/versions/v1/api/call-logs-api.js +137 -0
- package/dist/esm/versions/v1/api/channels-api.d.ts +74 -1
- package/dist/esm/versions/v1/api/channels-api.js +109 -0
- package/dist/esm/versions/v1/api/currencies-api.d.ts +19 -1
- package/dist/esm/versions/v1/api/currencies-api.js +27 -0
- package/dist/esm/versions/v1/api/deal-fields-api.d.ts +111 -1
- package/dist/esm/versions/v1/api/deal-fields-api.js +164 -0
- package/dist/esm/versions/v1/api/deals-api.d.ts +399 -1
- package/dist/esm/versions/v1/api/deals-api.js +569 -0
- package/dist/esm/versions/v1/api/files-api.d.ts +163 -1
- package/dist/esm/versions/v1/api/files-api.js +234 -0
- package/dist/esm/versions/v1/api/filters-api.d.ts +129 -1
- package/dist/esm/versions/v1/api/filters-api.js +191 -0
- package/dist/esm/versions/v1/api/goals-api.d.ts +106 -1
- package/dist/esm/versions/v1/api/goals-api.js +150 -0
- package/dist/esm/versions/v1/api/lead-fields-api.d.ts +20 -1
- package/dist/esm/versions/v1/api/lead-fields-api.js +28 -0
- package/dist/esm/versions/v1/api/lead-labels-api.d.ts +72 -1
- package/dist/esm/versions/v1/api/lead-labels-api.js +107 -0
- package/dist/esm/versions/v1/api/lead-sources-api.d.ts +17 -1
- package/dist/esm/versions/v1/api/lead-sources-api.js +25 -0
- package/dist/esm/versions/v1/api/leads-api.d.ts +166 -1
- package/dist/esm/versions/v1/api/leads-api.js +237 -0
- package/dist/esm/versions/v1/api/legacy-teams-api.d.ts +152 -1
- package/dist/esm/versions/v1/api/legacy-teams-api.js +223 -0
- package/dist/esm/versions/v1/api/mailbox-api.d.ts +117 -1
- package/dist/esm/versions/v1/api/mailbox-api.js +170 -0
- package/dist/esm/versions/v1/api/meetings-api.d.ts +37 -1
- package/dist/esm/versions/v1/api/meetings-api.js +54 -0
- package/dist/esm/versions/v1/api/note-fields-api.d.ts +17 -1
- package/dist/esm/versions/v1/api/note-fields-api.js +25 -0
- package/dist/esm/versions/v1/api/notes-api.d.ts +207 -1
- package/dist/esm/versions/v1/api/notes-api.js +296 -0
- package/dist/esm/versions/v1/api/organization-fields-api.d.ts +111 -1
- package/dist/esm/versions/v1/api/organization-fields-api.js +164 -0
- package/dist/esm/versions/v1/api/organization-relationships-api.d.ts +93 -1
- package/dist/esm/versions/v1/api/organization-relationships-api.js +137 -0
- package/dist/esm/versions/v1/api/organizations-api.d.ts +178 -1
- package/dist/esm/versions/v1/api/organizations-api.js +258 -0
- package/dist/esm/versions/v1/api/permission-sets-api.d.ts +57 -1
- package/dist/esm/versions/v1/api/permission-sets-api.js +83 -0
- package/dist/esm/versions/v1/api/person-fields-api.d.ts +111 -1
- package/dist/esm/versions/v1/api/person-fields-api.js +164 -0
- package/dist/esm/versions/v1/api/persons-api.d.ts +275 -37
- package/dist/esm/versions/v1/api/persons-api.js +370 -24
- package/dist/esm/versions/v1/api/pipelines-api.d.ts +69 -1
- package/dist/esm/versions/v1/api/pipelines-api.js +95 -0
- package/dist/esm/versions/v1/api/product-fields-api.d.ts +111 -1
- package/dist/esm/versions/v1/api/product-fields-api.js +164 -0
- package/dist/esm/versions/v1/api/products-api.d.ts +119 -1
- package/dist/esm/versions/v1/api/products-api.js +172 -0
- package/dist/esm/versions/v1/api/project-boards-api.d.ts +35 -1
- package/dist/esm/versions/v1/api/project-boards-api.js +52 -0
- package/dist/esm/versions/v1/api/project-phases-api.d.ts +37 -1
- package/dist/esm/versions/v1/api/project-phases-api.js +54 -0
- package/dist/esm/versions/v1/api/project-templates-api.d.ts +38 -1
- package/dist/esm/versions/v1/api/project-templates-api.js +55 -0
- package/dist/esm/versions/v1/api/projects-api.d.ts +227 -1
- package/dist/esm/versions/v1/api/projects-api.js +334 -0
- package/dist/esm/versions/v1/api/recents-api.d.ts +22 -1
- package/dist/esm/versions/v1/api/recents-api.js +30 -0
- package/dist/esm/versions/v1/api/roles-api.d.ts +226 -1
- package/dist/esm/versions/v1/api/roles-api.js +333 -0
- package/dist/esm/versions/v1/api/stages-api.d.ts +24 -1
- package/dist/esm/versions/v1/api/stages-api.js +32 -0
- package/dist/esm/versions/v1/api/tasks-api.d.ts +97 -1
- package/dist/esm/versions/v1/api/tasks-api.js +141 -0
- package/dist/esm/versions/v1/api/user-connections-api.d.ts +17 -1
- package/dist/esm/versions/v1/api/user-connections-api.js +25 -0
- package/dist/esm/versions/v1/api/user-settings-api.d.ts +17 -1
- package/dist/esm/versions/v1/api/user-settings-api.js +25 -0
- package/dist/esm/versions/v1/api/users-api.d.ts +181 -1
- package/dist/esm/versions/v1/api/users-api.js +270 -0
- package/dist/esm/versions/v1/api/webhooks-api.d.ts +53 -1
- package/dist/esm/versions/v1/api/webhooks-api.js +79 -0
- package/dist/esm/versions/v1/base.d.ts +17 -0
- package/dist/esm/versions/v1/base.js +22 -0
- package/dist/esm/versions/v1/common.d.ts +1 -1
- package/dist/esm/versions/v1/common.js +7 -4
- package/dist/esm/versions/v2/api/activities-api.d.ts +107 -1
- package/dist/esm/versions/v2/api/activities-api.js +151 -0
- package/dist/esm/versions/v2/api/activity-fields-api.d.ts +40 -1
- package/dist/esm/versions/v2/api/activity-fields-api.js +57 -0
- package/dist/esm/versions/v2/api/beta-api.d.ts +451 -1
- package/dist/esm/versions/v2/api/beta-api.js +666 -0
- package/dist/esm/versions/v2/api/deal-fields-api.d.ts +152 -1
- package/dist/esm/versions/v2/api/deal-fields-api.js +223 -0
- package/dist/esm/versions/v2/api/deal-installments-api.d.ts +81 -1
- package/dist/esm/versions/v2/api/deal-installments-api.js +116 -0
- package/dist/esm/versions/v2/api/deal-products-api.d.ts +141 -1
- package/dist/esm/versions/v2/api/deal-products-api.js +203 -0
- package/dist/esm/versions/v2/api/deals-api.d.ts +363 -1
- package/dist/esm/versions/v2/api/deals-api.js +516 -1
- package/dist/esm/versions/v2/api/item-search-api.d.ts +49 -1
- package/dist/esm/versions/v2/api/item-search-api.js +66 -0
- package/dist/esm/versions/v2/api/leads-api.d.ts +64 -1
- package/dist/esm/versions/v2/api/leads-api.js +90 -0
- package/dist/esm/versions/v2/api/organization-fields-api.d.ts +152 -1
- package/dist/esm/versions/v2/api/organization-fields-api.js +223 -0
- package/dist/esm/versions/v2/api/organizations-api.d.ts +208 -1
- package/dist/esm/versions/v2/api/organizations-api.js +297 -0
- package/dist/esm/versions/v2/api/person-fields-api.d.ts +152 -1
- package/dist/esm/versions/v2/api/person-fields-api.js +223 -0
- package/dist/esm/versions/v2/api/persons-api.d.ts +230 -1
- package/dist/esm/versions/v2/api/persons-api.js +328 -0
- package/dist/esm/versions/v2/api/pipelines-api.d.ts +95 -1
- package/dist/esm/versions/v2/api/pipelines-api.js +139 -0
- package/dist/esm/versions/v2/api/product-fields-api.d.ts +152 -1
- package/dist/esm/versions/v2/api/product-fields-api.js +223 -0
- package/dist/esm/versions/v2/api/products-api.d.ts +371 -1
- package/dist/esm/versions/v2/api/products-api.js +541 -0
- package/dist/esm/versions/v2/api/project-boards-api.d.ts +90 -1
- package/dist/esm/versions/v2/api/project-boards-api.js +134 -0
- package/dist/esm/versions/v2/api/project-fields-api.d.ts +150 -1
- package/dist/esm/versions/v2/api/project-fields-api.js +221 -0
- package/dist/esm/versions/v2/api/project-phases-api.d.ts +92 -1
- package/dist/esm/versions/v2/api/project-phases-api.js +136 -0
- package/dist/esm/versions/v2/api/project-templates-api.d.ts +38 -1
- package/dist/esm/versions/v2/api/project-templates-api.js +55 -0
- package/dist/esm/versions/v2/api/projects-api.d.ts +201 -1
- package/dist/esm/versions/v2/api/projects-api.js +290 -0
- package/dist/esm/versions/v2/api/stages-api.d.ts +96 -1
- package/dist/esm/versions/v2/api/stages-api.js +140 -0
- package/dist/esm/versions/v2/api/tasks-api.d.ts +98 -1
- package/dist/esm/versions/v2/api/tasks-api.js +142 -0
- package/dist/esm/versions/v2/api/users-api.d.ts +21 -1
- package/dist/esm/versions/v2/api/users-api.js +29 -0
- package/dist/esm/versions/v2/base.d.ts +17 -0
- package/dist/esm/versions/v2/base.js +22 -0
- package/dist/esm/versions/v2/common.d.ts +1 -1
- package/dist/esm/versions/v2/common.js +7 -4
- package/dist/versions/v1/api/activity-fields-api.d.ts +17 -1
- package/dist/versions/v1/api/activity-fields-api.js +25 -0
- package/dist/versions/v1/api/activity-types-api.d.ts +72 -1
- package/dist/versions/v1/api/activity-types-api.js +107 -0
- package/dist/versions/v1/api/billing-api.d.ts +17 -1
- package/dist/versions/v1/api/billing-api.js +25 -0
- package/dist/versions/v1/api/call-logs-api.d.ts +93 -1
- package/dist/versions/v1/api/call-logs-api.js +137 -0
- package/dist/versions/v1/api/channels-api.d.ts +74 -1
- package/dist/versions/v1/api/channels-api.js +109 -0
- package/dist/versions/v1/api/currencies-api.d.ts +19 -1
- package/dist/versions/v1/api/currencies-api.js +27 -0
- package/dist/versions/v1/api/deal-fields-api.d.ts +111 -1
- package/dist/versions/v1/api/deal-fields-api.js +164 -0
- package/dist/versions/v1/api/deals-api.d.ts +399 -1
- package/dist/versions/v1/api/deals-api.js +569 -0
- package/dist/versions/v1/api/files-api.d.ts +163 -1
- package/dist/versions/v1/api/files-api.js +234 -0
- package/dist/versions/v1/api/filters-api.d.ts +129 -1
- package/dist/versions/v1/api/filters-api.js +191 -0
- package/dist/versions/v1/api/goals-api.d.ts +106 -1
- package/dist/versions/v1/api/goals-api.js +150 -0
- package/dist/versions/v1/api/lead-fields-api.d.ts +20 -1
- package/dist/versions/v1/api/lead-fields-api.js +28 -0
- package/dist/versions/v1/api/lead-labels-api.d.ts +72 -1
- package/dist/versions/v1/api/lead-labels-api.js +107 -0
- package/dist/versions/v1/api/lead-sources-api.d.ts +17 -1
- package/dist/versions/v1/api/lead-sources-api.js +25 -0
- package/dist/versions/v1/api/leads-api.d.ts +166 -1
- package/dist/versions/v1/api/leads-api.js +237 -0
- package/dist/versions/v1/api/legacy-teams-api.d.ts +152 -1
- package/dist/versions/v1/api/legacy-teams-api.js +223 -0
- package/dist/versions/v1/api/mailbox-api.d.ts +117 -1
- package/dist/versions/v1/api/mailbox-api.js +170 -0
- package/dist/versions/v1/api/meetings-api.d.ts +37 -1
- package/dist/versions/v1/api/meetings-api.js +54 -0
- package/dist/versions/v1/api/note-fields-api.d.ts +17 -1
- package/dist/versions/v1/api/note-fields-api.js +25 -0
- package/dist/versions/v1/api/notes-api.d.ts +207 -1
- package/dist/versions/v1/api/notes-api.js +296 -0
- package/dist/versions/v1/api/organization-fields-api.d.ts +111 -1
- package/dist/versions/v1/api/organization-fields-api.js +164 -0
- package/dist/versions/v1/api/organization-relationships-api.d.ts +93 -1
- package/dist/versions/v1/api/organization-relationships-api.js +137 -0
- package/dist/versions/v1/api/organizations-api.d.ts +178 -1
- package/dist/versions/v1/api/organizations-api.js +258 -0
- package/dist/versions/v1/api/permission-sets-api.d.ts +57 -1
- package/dist/versions/v1/api/permission-sets-api.js +83 -0
- package/dist/versions/v1/api/person-fields-api.d.ts +111 -1
- package/dist/versions/v1/api/person-fields-api.js +164 -0
- package/dist/versions/v1/api/persons-api.d.ts +275 -37
- package/dist/versions/v1/api/persons-api.js +370 -24
- package/dist/versions/v1/api/pipelines-api.d.ts +69 -1
- package/dist/versions/v1/api/pipelines-api.js +95 -0
- package/dist/versions/v1/api/product-fields-api.d.ts +111 -1
- package/dist/versions/v1/api/product-fields-api.js +164 -0
- package/dist/versions/v1/api/products-api.d.ts +119 -1
- package/dist/versions/v1/api/products-api.js +172 -0
- package/dist/versions/v1/api/project-boards-api.d.ts +35 -1
- package/dist/versions/v1/api/project-boards-api.js +52 -0
- package/dist/versions/v1/api/project-phases-api.d.ts +37 -1
- package/dist/versions/v1/api/project-phases-api.js +54 -0
- package/dist/versions/v1/api/project-templates-api.d.ts +38 -1
- package/dist/versions/v1/api/project-templates-api.js +55 -0
- package/dist/versions/v1/api/projects-api.d.ts +227 -1
- package/dist/versions/v1/api/projects-api.js +334 -0
- package/dist/versions/v1/api/recents-api.d.ts +22 -1
- package/dist/versions/v1/api/recents-api.js +30 -0
- package/dist/versions/v1/api/roles-api.d.ts +226 -1
- package/dist/versions/v1/api/roles-api.js +333 -0
- package/dist/versions/v1/api/stages-api.d.ts +24 -1
- package/dist/versions/v1/api/stages-api.js +32 -0
- package/dist/versions/v1/api/tasks-api.d.ts +97 -1
- package/dist/versions/v1/api/tasks-api.js +141 -0
- package/dist/versions/v1/api/user-connections-api.d.ts +17 -1
- package/dist/versions/v1/api/user-connections-api.js +25 -0
- package/dist/versions/v1/api/user-settings-api.d.ts +17 -1
- package/dist/versions/v1/api/user-settings-api.js +25 -0
- package/dist/versions/v1/api/users-api.d.ts +181 -1
- package/dist/versions/v1/api/users-api.js +270 -0
- package/dist/versions/v1/api/webhooks-api.d.ts +53 -1
- package/dist/versions/v1/api/webhooks-api.js +79 -0
- package/dist/versions/v1/base.d.ts +17 -0
- package/dist/versions/v1/base.js +24 -1
- package/dist/versions/v1/common.d.ts +1 -1
- package/dist/versions/v1/common.js +6 -3
- package/dist/versions/v2/api/activities-api.d.ts +107 -1
- package/dist/versions/v2/api/activities-api.js +151 -0
- package/dist/versions/v2/api/activity-fields-api.d.ts +40 -1
- package/dist/versions/v2/api/activity-fields-api.js +57 -0
- package/dist/versions/v2/api/beta-api.d.ts +451 -1
- package/dist/versions/v2/api/beta-api.js +666 -0
- package/dist/versions/v2/api/deal-fields-api.d.ts +152 -1
- package/dist/versions/v2/api/deal-fields-api.js +223 -0
- package/dist/versions/v2/api/deal-installments-api.d.ts +81 -1
- package/dist/versions/v2/api/deal-installments-api.js +116 -0
- package/dist/versions/v2/api/deal-products-api.d.ts +141 -1
- package/dist/versions/v2/api/deal-products-api.js +203 -0
- package/dist/versions/v2/api/deals-api.d.ts +363 -1
- package/dist/versions/v2/api/deals-api.js +516 -1
- package/dist/versions/v2/api/item-search-api.d.ts +49 -1
- package/dist/versions/v2/api/item-search-api.js +66 -0
- package/dist/versions/v2/api/leads-api.d.ts +64 -1
- package/dist/versions/v2/api/leads-api.js +90 -0
- package/dist/versions/v2/api/organization-fields-api.d.ts +152 -1
- package/dist/versions/v2/api/organization-fields-api.js +223 -0
- package/dist/versions/v2/api/organizations-api.d.ts +208 -1
- package/dist/versions/v2/api/organizations-api.js +297 -0
- package/dist/versions/v2/api/person-fields-api.d.ts +152 -1
- package/dist/versions/v2/api/person-fields-api.js +223 -0
- package/dist/versions/v2/api/persons-api.d.ts +230 -1
- package/dist/versions/v2/api/persons-api.js +328 -0
- package/dist/versions/v2/api/pipelines-api.d.ts +95 -1
- package/dist/versions/v2/api/pipelines-api.js +139 -0
- package/dist/versions/v2/api/product-fields-api.d.ts +152 -1
- package/dist/versions/v2/api/product-fields-api.js +223 -0
- package/dist/versions/v2/api/products-api.d.ts +371 -1
- package/dist/versions/v2/api/products-api.js +541 -0
- package/dist/versions/v2/api/project-boards-api.d.ts +90 -1
- package/dist/versions/v2/api/project-boards-api.js +134 -0
- package/dist/versions/v2/api/project-fields-api.d.ts +150 -1
- package/dist/versions/v2/api/project-fields-api.js +221 -0
- package/dist/versions/v2/api/project-phases-api.d.ts +92 -1
- package/dist/versions/v2/api/project-phases-api.js +136 -0
- package/dist/versions/v2/api/project-templates-api.d.ts +38 -1
- package/dist/versions/v2/api/project-templates-api.js +55 -0
- package/dist/versions/v2/api/projects-api.d.ts +201 -1
- package/dist/versions/v2/api/projects-api.js +290 -0
- package/dist/versions/v2/api/stages-api.d.ts +96 -1
- package/dist/versions/v2/api/stages-api.js +140 -0
- package/dist/versions/v2/api/tasks-api.d.ts +98 -1
- package/dist/versions/v2/api/tasks-api.js +142 -0
- package/dist/versions/v2/api/users-api.d.ts +21 -1
- package/dist/versions/v2/api/users-api.js +29 -0
- package/dist/versions/v2/base.d.ts +17 -0
- package/dist/versions/v2/base.js +24 -1
- package/dist/versions/v2/common.d.ts +1 -1
- package/dist/versions/v2/common.js +6 -3
- package/package.json +1 -1
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { Configuration } from '../configuration';
|
|
13
13
|
import type { AxiosInstance } from 'axios';
|
|
14
|
-
import { RequestArgs, BaseAPI } from '../base';
|
|
14
|
+
import { RequestArgs, BaseAPI, ApiResponse } from '../base';
|
|
15
15
|
import { AddAdditionalDiscountRequestBody } from '../models';
|
|
16
16
|
import { AddAdditionalDiscountResponse } from '../models';
|
|
17
17
|
import { AddConvertDealToLeadResponse } from '../models';
|
|
@@ -242,6 +242,14 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
242
242
|
* @throws {RequiredError}
|
|
243
243
|
*/
|
|
244
244
|
addDeal(AddDealRequest?: AddDealRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertDealResponse>>;
|
|
245
|
+
/**
|
|
246
|
+
* Same as `addDeal`, but resolves with the response body together with the HTTP status and headers.
|
|
247
|
+
* @summary Add a new deal
|
|
248
|
+
* @param {AddDealRequest} [AddDealRequest]
|
|
249
|
+
|
|
250
|
+
* @throws {RequiredError}
|
|
251
|
+
*/
|
|
252
|
+
addDealWithHttpInfo(AddDealRequest?: AddDealRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<UpsertDealResponse>>>;
|
|
245
253
|
/**
|
|
246
254
|
* Adds a user as a follower to the deal.
|
|
247
255
|
* @summary Add a follower to a deal
|
|
@@ -251,6 +259,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
251
259
|
* @throws {RequiredError}
|
|
252
260
|
*/
|
|
253
261
|
addDealFollower(id: number, AddDealFollowerRequest?: AddDealFollowerRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddFollowerResponse>>;
|
|
262
|
+
/**
|
|
263
|
+
* Same as `addDealFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
264
|
+
* @summary Add a follower to a deal
|
|
265
|
+
* @param {number} id The ID of the deal
|
|
266
|
+
* @param {AddDealFollowerRequest} [AddDealFollowerRequest]
|
|
267
|
+
|
|
268
|
+
* @throws {RequiredError}
|
|
269
|
+
*/
|
|
270
|
+
addDealFollowerWithHttpInfo(id: number, AddDealFollowerRequest?: AddDealFollowerRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddFollowerResponse>>>;
|
|
254
271
|
/**
|
|
255
272
|
* Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
|
|
256
273
|
* @summary Convert a deal to a lead
|
|
@@ -259,6 +276,14 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
259
276
|
* @throws {RequiredError}
|
|
260
277
|
*/
|
|
261
278
|
convertDealToLead(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddConvertDealToLeadResponse>>;
|
|
279
|
+
/**
|
|
280
|
+
* Same as `convertDealToLead`, but resolves with the response body together with the HTTP status and headers.
|
|
281
|
+
* @summary Convert a deal to a lead
|
|
282
|
+
* @param {number} id The ID of the deal to convert
|
|
283
|
+
|
|
284
|
+
* @throws {RequiredError}
|
|
285
|
+
*/
|
|
286
|
+
convertDealToLeadWithHttpInfo(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddConvertDealToLeadResponse>>>;
|
|
262
287
|
/**
|
|
263
288
|
* Removes a discount from a deal, changing the deal value if the deal has one-time products attached.
|
|
264
289
|
* @summary Delete a discount from a deal
|
|
@@ -268,6 +293,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
268
293
|
* @throws {RequiredError}
|
|
269
294
|
*/
|
|
270
295
|
deleteAdditionalDiscount(id: number, discount_id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteAdditionalDiscountResponse>>;
|
|
296
|
+
/**
|
|
297
|
+
* Same as `deleteAdditionalDiscount`, but resolves with the response body together with the HTTP status and headers.
|
|
298
|
+
* @summary Delete a discount from a deal
|
|
299
|
+
* @param {number} id The ID of the deal
|
|
300
|
+
* @param {string} discount_id The ID of the discount
|
|
301
|
+
|
|
302
|
+
* @throws {RequiredError}
|
|
303
|
+
*/
|
|
304
|
+
deleteAdditionalDiscountWithHttpInfo(id: number, discount_id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<DeleteAdditionalDiscountResponse>>>;
|
|
271
305
|
/**
|
|
272
306
|
* Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
|
|
273
307
|
* @summary Delete a deal
|
|
@@ -276,6 +310,14 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
276
310
|
* @throws {RequiredError}
|
|
277
311
|
*/
|
|
278
312
|
deleteDeal(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteDealResponse>>;
|
|
313
|
+
/**
|
|
314
|
+
* Same as `deleteDeal`, but resolves with the response body together with the HTTP status and headers.
|
|
315
|
+
* @summary Delete a deal
|
|
316
|
+
* @param {number} id The ID of the deal
|
|
317
|
+
|
|
318
|
+
* @throws {RequiredError}
|
|
319
|
+
*/
|
|
320
|
+
deleteDealWithHttpInfo(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<DeleteDealResponse>>>;
|
|
279
321
|
/**
|
|
280
322
|
* Deletes a user follower from the deal.
|
|
281
323
|
* @summary Delete a follower from a deal
|
|
@@ -285,6 +327,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
285
327
|
* @throws {RequiredError}
|
|
286
328
|
*/
|
|
287
329
|
deleteDealFollower(id: number, follower_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteFollowerResponse>>;
|
|
330
|
+
/**
|
|
331
|
+
* Same as `deleteDealFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
332
|
+
* @summary Delete a follower from a deal
|
|
333
|
+
* @param {number} id The ID of the deal
|
|
334
|
+
* @param {number} follower_id The ID of the following user
|
|
335
|
+
|
|
336
|
+
* @throws {RequiredError}
|
|
337
|
+
*/
|
|
338
|
+
deleteDealFollowerWithHttpInfo(id: number, follower_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<DeleteFollowerResponse>>>;
|
|
288
339
|
/**
|
|
289
340
|
* Lists discounts attached to a deal.
|
|
290
341
|
* @summary List discounts added to a deal
|
|
@@ -293,6 +344,14 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
293
344
|
* @throws {RequiredError}
|
|
294
345
|
*/
|
|
295
346
|
getAdditionalDiscounts(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAdditionalDiscountsResponse>>;
|
|
347
|
+
/**
|
|
348
|
+
* Same as `getAdditionalDiscounts`, but resolves with the response body together with the HTTP status and headers.
|
|
349
|
+
* @summary List discounts added to a deal
|
|
350
|
+
* @param {number} id The ID of the deal
|
|
351
|
+
|
|
352
|
+
* @throws {RequiredError}
|
|
353
|
+
*/
|
|
354
|
+
getAdditionalDiscountsWithHttpInfo(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetAdditionalDiscountsResponse>>>;
|
|
296
355
|
/**
|
|
297
356
|
* Returns data about all archived deals.
|
|
298
357
|
* @summary Get all archived deals
|
|
@@ -316,6 +375,29 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
316
375
|
* @throws {RequiredError}
|
|
317
376
|
*/
|
|
318
377
|
getArchivedDeals(filter_id?: number, ids?: Set<number>, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: Set<'open' | 'won' | 'lost' | 'deleted'>, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' | 'source_lead_id'>, custom_fields?: Set<string>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsResponse>>;
|
|
378
|
+
/**
|
|
379
|
+
* Same as `getArchivedDeals`, but resolves with the response body together with the HTTP status and headers.
|
|
380
|
+
* @summary Get all archived deals
|
|
381
|
+
* @param {number} [filter_id] If supplied, only deals matching the specified filter are returned
|
|
382
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
383
|
+
* @param {number} [owner_id] If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
384
|
+
* @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
|
|
385
|
+
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
386
|
+
* @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
|
|
387
|
+
* @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
|
|
388
|
+
* @param {Set<'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. Multiple statuses can be included as a comma separated array. If filter_id is provided, this is ignored.
|
|
389
|
+
* @param {string} [updated_since] If set, only deals with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
390
|
+
* @param {string} [updated_until] If set, only deals with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
391
|
+
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
392
|
+
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
393
|
+
* @param {Set<'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' | 'source_lead_id'>} [include_fields] Optional comma separated string array of additional fields to include
|
|
394
|
+
* @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
395
|
+
* @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.
|
|
396
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
397
|
+
|
|
398
|
+
* @throws {RequiredError}
|
|
399
|
+
*/
|
|
400
|
+
getArchivedDealsWithHttpInfo(filter_id?: number, ids?: Set<number>, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: Set<'open' | 'won' | 'lost' | 'deleted'>, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' | 'source_lead_id'>, custom_fields?: Set<string>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetDealsResponse>>>;
|
|
319
401
|
/**
|
|
320
402
|
* Returns the details of a specific deal.
|
|
321
403
|
* @summary Get details of a deal
|
|
@@ -328,6 +410,18 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
328
410
|
* @throws {RequiredError}
|
|
329
411
|
*/
|
|
330
412
|
getDeal(id: number, include_fields?: Set<'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' | 'source_lead_id'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertDealResponse>>;
|
|
413
|
+
/**
|
|
414
|
+
* Same as `getDeal`, but resolves with the response body together with the HTTP status and headers.
|
|
415
|
+
* @summary Get details of a deal
|
|
416
|
+
* @param {number} id The ID of the deal
|
|
417
|
+
* @param {Set<'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' | 'source_lead_id'>} [include_fields] Optional comma separated string array of additional fields to include
|
|
418
|
+
* @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
419
|
+
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
420
|
+
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
421
|
+
|
|
422
|
+
* @throws {RequiredError}
|
|
423
|
+
*/
|
|
424
|
+
getDealWithHttpInfo(id: number, include_fields?: Set<'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' | 'source_lead_id'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<UpsertDealResponse>>>;
|
|
331
425
|
/**
|
|
332
426
|
* Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
|
|
333
427
|
* @summary Get Deal conversion status
|
|
@@ -337,6 +431,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
337
431
|
* @throws {RequiredError}
|
|
338
432
|
*/
|
|
339
433
|
getDealConversionStatus(id: number, conversion_id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetConvertResponse1>>;
|
|
434
|
+
/**
|
|
435
|
+
* Same as `getDealConversionStatus`, but resolves with the response body together with the HTTP status and headers.
|
|
436
|
+
* @summary Get Deal conversion status
|
|
437
|
+
* @param {number} id The ID of a deal
|
|
438
|
+
* @param {string} conversion_id The ID of the conversion
|
|
439
|
+
|
|
440
|
+
* @throws {RequiredError}
|
|
441
|
+
*/
|
|
442
|
+
getDealConversionStatusWithHttpInfo(id: number, conversion_id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetConvertResponse1>>>;
|
|
340
443
|
/**
|
|
341
444
|
* Lists users who are following the deal.
|
|
342
445
|
* @summary List followers of a deal
|
|
@@ -347,6 +450,16 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
347
450
|
* @throws {RequiredError}
|
|
348
451
|
*/
|
|
349
452
|
getDealFollowers(id: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFollowersResponse>>;
|
|
453
|
+
/**
|
|
454
|
+
* Same as `getDealFollowers`, but resolves with the response body together with the HTTP status and headers.
|
|
455
|
+
* @summary List followers of a deal
|
|
456
|
+
* @param {number} id The ID of the deal
|
|
457
|
+
* @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.
|
|
458
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
459
|
+
|
|
460
|
+
* @throws {RequiredError}
|
|
461
|
+
*/
|
|
462
|
+
getDealFollowersWithHttpInfo(id: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetFollowersResponse>>>;
|
|
350
463
|
/**
|
|
351
464
|
* Lists changelogs about users have followed the deal.
|
|
352
465
|
* @summary List followers changelog of a deal
|
|
@@ -357,6 +470,16 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
357
470
|
* @throws {RequiredError}
|
|
358
471
|
*/
|
|
359
472
|
getDealFollowersChangelog(id: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFollowerChangelogsResponse>>;
|
|
473
|
+
/**
|
|
474
|
+
* Same as `getDealFollowersChangelog`, but resolves with the response body together with the HTTP status and headers.
|
|
475
|
+
* @summary List followers changelog of a deal
|
|
476
|
+
* @param {number} id The ID of the deal
|
|
477
|
+
* @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.
|
|
478
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
479
|
+
|
|
480
|
+
* @throws {RequiredError}
|
|
481
|
+
*/
|
|
482
|
+
getDealFollowersChangelogWithHttpInfo(id: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetFollowerChangelogsResponse>>>;
|
|
360
483
|
/**
|
|
361
484
|
* Returns data about all not archived deals.
|
|
362
485
|
* @summary Get all deals
|
|
@@ -382,6 +505,31 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
382
505
|
* @throws {RequiredError}
|
|
383
506
|
*/
|
|
384
507
|
getDeals(filter_id?: number, ids?: Set<number>, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: Set<'open' | 'won' | 'lost' | 'deleted'>, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' | 'source_lead_id'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsResponse>>;
|
|
508
|
+
/**
|
|
509
|
+
* Same as `getDeals`, but resolves with the response body together with the HTTP status and headers.
|
|
510
|
+
* @summary Get all deals
|
|
511
|
+
* @param {number} [filter_id] If supplied, only deals matching the specified filter are returned
|
|
512
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
513
|
+
* @param {number} [owner_id] If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
514
|
+
* @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
|
|
515
|
+
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
516
|
+
* @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
|
|
517
|
+
* @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
|
|
518
|
+
* @param {Set<'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. Multiple statuses can be included as a comma separated array. If filter_id is provided, this is ignored.
|
|
519
|
+
* @param {string} [updated_since] If set, only deals with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
520
|
+
* @param {string} [updated_until] If set, only deals with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
521
|
+
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
522
|
+
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
523
|
+
* @param {Set<'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' | 'source_lead_id'>} [include_fields] Optional comma separated string array of additional fields to include
|
|
524
|
+
* @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
525
|
+
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
526
|
+
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
527
|
+
* @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.
|
|
528
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
529
|
+
|
|
530
|
+
* @throws {RequiredError}
|
|
531
|
+
*/
|
|
532
|
+
getDealsWithHttpInfo(filter_id?: number, ids?: Set<number>, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: Set<'open' | 'won' | 'lost' | 'deleted'>, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' | 'source_lead_id'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetDealsResponse>>>;
|
|
385
533
|
/**
|
|
386
534
|
* Adds a discount to a deal, changing the deal value if the deal has one-time products attached.
|
|
387
535
|
* @summary Add a discount to a deal
|
|
@@ -391,6 +539,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
391
539
|
* @throws {RequiredError}
|
|
392
540
|
*/
|
|
393
541
|
postAdditionalDiscount(id: number, AddAdditionalDiscountRequestBody?: AddAdditionalDiscountRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddAdditionalDiscountResponse>>;
|
|
542
|
+
/**
|
|
543
|
+
* Same as `postAdditionalDiscount`, but resolves with the response body together with the HTTP status and headers.
|
|
544
|
+
* @summary Add a discount to a deal
|
|
545
|
+
* @param {number} id The ID of the deal
|
|
546
|
+
* @param {AddAdditionalDiscountRequestBody} [AddAdditionalDiscountRequestBody]
|
|
547
|
+
|
|
548
|
+
* @throws {RequiredError}
|
|
549
|
+
*/
|
|
550
|
+
postAdditionalDiscountWithHttpInfo(id: number, AddAdditionalDiscountRequestBody?: AddAdditionalDiscountRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddAdditionalDiscountResponse>>>;
|
|
394
551
|
/**
|
|
395
552
|
* 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.
|
|
396
553
|
* @summary Search deals
|
|
@@ -407,6 +564,22 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
407
564
|
* @throws {RequiredError}
|
|
408
565
|
*/
|
|
409
566
|
searchDeals(term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, status?: 'open' | 'won' | 'lost', include_fields?: Set<'deal.cc_email'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealSearchResponse>>;
|
|
567
|
+
/**
|
|
568
|
+
* Same as `searchDeals`, but resolves with the response body together with the HTTP status and headers.
|
|
569
|
+
* @summary Search deals
|
|
570
|
+
* @param {string} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
|
|
571
|
+
* @param {Set<'custom_fields' | 'notes' | 'title'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
572
|
+
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
573
|
+
* @param {number} [person_id] Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.
|
|
574
|
+
* @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
|
|
575
|
+
* @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
|
|
576
|
+
* @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
577
|
+
* @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 100 is allowed.
|
|
578
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
579
|
+
|
|
580
|
+
* @throws {RequiredError}
|
|
581
|
+
*/
|
|
582
|
+
searchDealsWithHttpInfo(term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, status?: 'open' | 'won' | 'lost', include_fields?: Set<'deal.cc_email'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetDealSearchResponse>>>;
|
|
410
583
|
/**
|
|
411
584
|
* Edits a discount added to a deal, changing the deal value if the deal has one-time products attached.
|
|
412
585
|
* @summary Update a discount added to a deal
|
|
@@ -417,6 +590,16 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
417
590
|
* @throws {RequiredError}
|
|
418
591
|
*/
|
|
419
592
|
updateAdditionalDiscount(id: number, discount_id: string, UpdateAdditionalDiscountRequestBody?: UpdateAdditionalDiscountRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpdateAdditionalDiscountResponse>>;
|
|
593
|
+
/**
|
|
594
|
+
* Same as `updateAdditionalDiscount`, but resolves with the response body together with the HTTP status and headers.
|
|
595
|
+
* @summary Update a discount added to a deal
|
|
596
|
+
* @param {number} id The ID of the deal
|
|
597
|
+
* @param {string} discount_id The ID of the discount
|
|
598
|
+
* @param {UpdateAdditionalDiscountRequestBody} [UpdateAdditionalDiscountRequestBody]
|
|
599
|
+
|
|
600
|
+
* @throws {RequiredError}
|
|
601
|
+
*/
|
|
602
|
+
updateAdditionalDiscountWithHttpInfo(id: number, discount_id: string, UpdateAdditionalDiscountRequestBody?: UpdateAdditionalDiscountRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<UpdateAdditionalDiscountResponse>>>;
|
|
420
603
|
/**
|
|
421
604
|
* Updates the properties of a deal.
|
|
422
605
|
* @summary Update a deal
|
|
@@ -426,6 +609,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
426
609
|
* @throws {RequiredError}
|
|
427
610
|
*/
|
|
428
611
|
updateDeal(id: number, UpdateDealRequest?: UpdateDealRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertDealResponse>>;
|
|
612
|
+
/**
|
|
613
|
+
* Same as `updateDeal`, but resolves with the response body together with the HTTP status and headers.
|
|
614
|
+
* @summary Update a deal
|
|
615
|
+
* @param {number} id The ID of the deal
|
|
616
|
+
* @param {UpdateDealRequest} [UpdateDealRequest]
|
|
617
|
+
|
|
618
|
+
* @throws {RequiredError}
|
|
619
|
+
*/
|
|
620
|
+
updateDealWithHttpInfo(id: number, UpdateDealRequest?: UpdateDealRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<UpsertDealResponse>>>;
|
|
429
621
|
};
|
|
430
622
|
/**
|
|
431
623
|
* DealsApi - factory interface
|
|
@@ -440,6 +632,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
440
632
|
* @throws {RequiredError}
|
|
441
633
|
*/
|
|
442
634
|
addDeal(requestParameters?: DealsApiAddDealRequest): Promise<UpsertDealResponse>;
|
|
635
|
+
addDealWithHttpInfo(requestParameters?: DealsApiAddDealRequest): Promise<ApiResponse<UpsertDealResponse>>;
|
|
443
636
|
/**
|
|
444
637
|
* Adds a user as a follower to the deal.
|
|
445
638
|
* @summary Add a follower to a deal
|
|
@@ -448,6 +641,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
448
641
|
* @throws {RequiredError}
|
|
449
642
|
*/
|
|
450
643
|
addDealFollower(requestParameters: DealsApiAddDealFollowerRequest): Promise<AddFollowerResponse>;
|
|
644
|
+
addDealFollowerWithHttpInfo(requestParameters: DealsApiAddDealFollowerRequest): Promise<ApiResponse<AddFollowerResponse>>;
|
|
451
645
|
/**
|
|
452
646
|
* Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
|
|
453
647
|
* @summary Convert a deal to a lead
|
|
@@ -456,6 +650,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
456
650
|
* @throws {RequiredError}
|
|
457
651
|
*/
|
|
458
652
|
convertDealToLead(requestParameters: DealsApiConvertDealToLeadRequest): Promise<AddConvertDealToLeadResponse>;
|
|
653
|
+
convertDealToLeadWithHttpInfo(requestParameters: DealsApiConvertDealToLeadRequest): Promise<ApiResponse<AddConvertDealToLeadResponse>>;
|
|
459
654
|
/**
|
|
460
655
|
* Removes a discount from a deal, changing the deal value if the deal has one-time products attached.
|
|
461
656
|
* @summary Delete a discount from a deal
|
|
@@ -464,6 +659,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
464
659
|
* @throws {RequiredError}
|
|
465
660
|
*/
|
|
466
661
|
deleteAdditionalDiscount(requestParameters: DealsApiDeleteAdditionalDiscountRequest): Promise<DeleteAdditionalDiscountResponse>;
|
|
662
|
+
deleteAdditionalDiscountWithHttpInfo(requestParameters: DealsApiDeleteAdditionalDiscountRequest): Promise<ApiResponse<DeleteAdditionalDiscountResponse>>;
|
|
467
663
|
/**
|
|
468
664
|
* Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
|
|
469
665
|
* @summary Delete a deal
|
|
@@ -472,6 +668,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
472
668
|
* @throws {RequiredError}
|
|
473
669
|
*/
|
|
474
670
|
deleteDeal(requestParameters: DealsApiDeleteDealRequest): Promise<DeleteDealResponse>;
|
|
671
|
+
deleteDealWithHttpInfo(requestParameters: DealsApiDeleteDealRequest): Promise<ApiResponse<DeleteDealResponse>>;
|
|
475
672
|
/**
|
|
476
673
|
* Deletes a user follower from the deal.
|
|
477
674
|
* @summary Delete a follower from a deal
|
|
@@ -480,6 +677,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
480
677
|
* @throws {RequiredError}
|
|
481
678
|
*/
|
|
482
679
|
deleteDealFollower(requestParameters: DealsApiDeleteDealFollowerRequest): Promise<DeleteFollowerResponse>;
|
|
680
|
+
deleteDealFollowerWithHttpInfo(requestParameters: DealsApiDeleteDealFollowerRequest): Promise<ApiResponse<DeleteFollowerResponse>>;
|
|
483
681
|
/**
|
|
484
682
|
* Lists discounts attached to a deal.
|
|
485
683
|
* @summary List discounts added to a deal
|
|
@@ -488,6 +686,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
488
686
|
* @throws {RequiredError}
|
|
489
687
|
*/
|
|
490
688
|
getAdditionalDiscounts(requestParameters: DealsApiGetAdditionalDiscountsRequest): Promise<GetAdditionalDiscountsResponse>;
|
|
689
|
+
getAdditionalDiscountsWithHttpInfo(requestParameters: DealsApiGetAdditionalDiscountsRequest): Promise<ApiResponse<GetAdditionalDiscountsResponse>>;
|
|
491
690
|
/**
|
|
492
691
|
* Returns data about all archived deals.
|
|
493
692
|
* @summary Get all archived deals
|
|
@@ -496,6 +695,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
496
695
|
* @throws {RequiredError}
|
|
497
696
|
*/
|
|
498
697
|
getArchivedDeals(requestParameters?: DealsApiGetArchivedDealsRequest): Promise<GetDealsResponse>;
|
|
698
|
+
getArchivedDealsWithHttpInfo(requestParameters?: DealsApiGetArchivedDealsRequest): Promise<ApiResponse<GetDealsResponse>>;
|
|
499
699
|
/**
|
|
500
700
|
* Returns the details of a specific deal.
|
|
501
701
|
* @summary Get details of a deal
|
|
@@ -504,6 +704,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
504
704
|
* @throws {RequiredError}
|
|
505
705
|
*/
|
|
506
706
|
getDeal(requestParameters: DealsApiGetDealRequest): Promise<UpsertDealResponse>;
|
|
707
|
+
getDealWithHttpInfo(requestParameters: DealsApiGetDealRequest): Promise<ApiResponse<UpsertDealResponse>>;
|
|
507
708
|
/**
|
|
508
709
|
* Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
|
|
509
710
|
* @summary Get Deal conversion status
|
|
@@ -512,6 +713,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
512
713
|
* @throws {RequiredError}
|
|
513
714
|
*/
|
|
514
715
|
getDealConversionStatus(requestParameters: DealsApiGetDealConversionStatusRequest): Promise<GetConvertResponse1>;
|
|
716
|
+
getDealConversionStatusWithHttpInfo(requestParameters: DealsApiGetDealConversionStatusRequest): Promise<ApiResponse<GetConvertResponse1>>;
|
|
515
717
|
/**
|
|
516
718
|
* Lists users who are following the deal.
|
|
517
719
|
* @summary List followers of a deal
|
|
@@ -520,6 +722,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
520
722
|
* @throws {RequiredError}
|
|
521
723
|
*/
|
|
522
724
|
getDealFollowers(requestParameters: DealsApiGetDealFollowersRequest): Promise<GetFollowersResponse>;
|
|
725
|
+
getDealFollowersWithHttpInfo(requestParameters: DealsApiGetDealFollowersRequest): Promise<ApiResponse<GetFollowersResponse>>;
|
|
523
726
|
/**
|
|
524
727
|
* Lists changelogs about users have followed the deal.
|
|
525
728
|
* @summary List followers changelog of a deal
|
|
@@ -528,6 +731,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
528
731
|
* @throws {RequiredError}
|
|
529
732
|
*/
|
|
530
733
|
getDealFollowersChangelog(requestParameters: DealsApiGetDealFollowersChangelogRequest): Promise<GetFollowerChangelogsResponse>;
|
|
734
|
+
getDealFollowersChangelogWithHttpInfo(requestParameters: DealsApiGetDealFollowersChangelogRequest): Promise<ApiResponse<GetFollowerChangelogsResponse>>;
|
|
531
735
|
/**
|
|
532
736
|
* Returns data about all not archived deals.
|
|
533
737
|
* @summary Get all deals
|
|
@@ -536,6 +740,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
536
740
|
* @throws {RequiredError}
|
|
537
741
|
*/
|
|
538
742
|
getDeals(requestParameters?: DealsApiGetDealsRequest): Promise<GetDealsResponse>;
|
|
743
|
+
getDealsWithHttpInfo(requestParameters?: DealsApiGetDealsRequest): Promise<ApiResponse<GetDealsResponse>>;
|
|
539
744
|
/**
|
|
540
745
|
* Adds a discount to a deal, changing the deal value if the deal has one-time products attached.
|
|
541
746
|
* @summary Add a discount to a deal
|
|
@@ -544,6 +749,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
544
749
|
* @throws {RequiredError}
|
|
545
750
|
*/
|
|
546
751
|
postAdditionalDiscount(requestParameters: DealsApiPostAdditionalDiscountRequest): Promise<AddAdditionalDiscountResponse>;
|
|
752
|
+
postAdditionalDiscountWithHttpInfo(requestParameters: DealsApiPostAdditionalDiscountRequest): Promise<ApiResponse<AddAdditionalDiscountResponse>>;
|
|
547
753
|
/**
|
|
548
754
|
* 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.
|
|
549
755
|
* @summary Search deals
|
|
@@ -552,6 +758,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
552
758
|
* @throws {RequiredError}
|
|
553
759
|
*/
|
|
554
760
|
searchDeals(requestParameters: DealsApiSearchDealsRequest): Promise<GetDealSearchResponse>;
|
|
761
|
+
searchDealsWithHttpInfo(requestParameters: DealsApiSearchDealsRequest): Promise<ApiResponse<GetDealSearchResponse>>;
|
|
555
762
|
/**
|
|
556
763
|
* Edits a discount added to a deal, changing the deal value if the deal has one-time products attached.
|
|
557
764
|
* @summary Update a discount added to a deal
|
|
@@ -560,6 +767,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
560
767
|
* @throws {RequiredError}
|
|
561
768
|
*/
|
|
562
769
|
updateAdditionalDiscount(requestParameters: DealsApiUpdateAdditionalDiscountRequest): Promise<UpdateAdditionalDiscountResponse>;
|
|
770
|
+
updateAdditionalDiscountWithHttpInfo(requestParameters: DealsApiUpdateAdditionalDiscountRequest): Promise<ApiResponse<UpdateAdditionalDiscountResponse>>;
|
|
563
771
|
/**
|
|
564
772
|
* Updates the properties of a deal.
|
|
565
773
|
* @summary Update a deal
|
|
@@ -568,6 +776,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
568
776
|
* @throws {RequiredError}
|
|
569
777
|
*/
|
|
570
778
|
updateDeal(requestParameters: DealsApiUpdateDealRequest): Promise<UpsertDealResponse>;
|
|
779
|
+
updateDealWithHttpInfo(requestParameters: DealsApiUpdateDealRequest): Promise<ApiResponse<UpsertDealResponse>>;
|
|
571
780
|
};
|
|
572
781
|
/**
|
|
573
782
|
* Request parameters for addDeal operation in DealsApi.
|
|
@@ -1142,6 +1351,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1142
1351
|
* @memberof DealsApi
|
|
1143
1352
|
*/
|
|
1144
1353
|
addDeal(requestParameters?: DealsApiAddDealRequest): Promise<UpsertDealResponse>;
|
|
1354
|
+
/**
|
|
1355
|
+
* Same as `addDeal`, but resolves with the response body together with the HTTP status and headers.
|
|
1356
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1357
|
+
* @param {DealsApiAddDealRequest} requestParameters Request parameters.
|
|
1358
|
+
|
|
1359
|
+
* @throws {RequiredError}
|
|
1360
|
+
* @memberof DealsApi
|
|
1361
|
+
*/
|
|
1362
|
+
addDealWithHttpInfo(requestParameters?: DealsApiAddDealRequest): Promise<ApiResponse<UpsertDealResponse>>;
|
|
1145
1363
|
/**
|
|
1146
1364
|
* Adds a user as a follower to the deal.
|
|
1147
1365
|
* @summary Add a follower to a deal
|
|
@@ -1151,6 +1369,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1151
1369
|
* @memberof DealsApi
|
|
1152
1370
|
*/
|
|
1153
1371
|
addDealFollower(requestParameters: DealsApiAddDealFollowerRequest): Promise<AddFollowerResponse>;
|
|
1372
|
+
/**
|
|
1373
|
+
* Same as `addDealFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
1374
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1375
|
+
* @param {DealsApiAddDealFollowerRequest} requestParameters Request parameters.
|
|
1376
|
+
|
|
1377
|
+
* @throws {RequiredError}
|
|
1378
|
+
* @memberof DealsApi
|
|
1379
|
+
*/
|
|
1380
|
+
addDealFollowerWithHttpInfo(requestParameters: DealsApiAddDealFollowerRequest): Promise<ApiResponse<AddFollowerResponse>>;
|
|
1154
1381
|
/**
|
|
1155
1382
|
* Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
|
|
1156
1383
|
* @summary Convert a deal to a lead
|
|
@@ -1160,6 +1387,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1160
1387
|
* @memberof DealsApi
|
|
1161
1388
|
*/
|
|
1162
1389
|
convertDealToLead(requestParameters: DealsApiConvertDealToLeadRequest): Promise<AddConvertDealToLeadResponse>;
|
|
1390
|
+
/**
|
|
1391
|
+
* Same as `convertDealToLead`, but resolves with the response body together with the HTTP status and headers.
|
|
1392
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1393
|
+
* @param {DealsApiConvertDealToLeadRequest} requestParameters Request parameters.
|
|
1394
|
+
|
|
1395
|
+
* @throws {RequiredError}
|
|
1396
|
+
* @memberof DealsApi
|
|
1397
|
+
*/
|
|
1398
|
+
convertDealToLeadWithHttpInfo(requestParameters: DealsApiConvertDealToLeadRequest): Promise<ApiResponse<AddConvertDealToLeadResponse>>;
|
|
1163
1399
|
/**
|
|
1164
1400
|
* Removes a discount from a deal, changing the deal value if the deal has one-time products attached.
|
|
1165
1401
|
* @summary Delete a discount from a deal
|
|
@@ -1169,6 +1405,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1169
1405
|
* @memberof DealsApi
|
|
1170
1406
|
*/
|
|
1171
1407
|
deleteAdditionalDiscount(requestParameters: DealsApiDeleteAdditionalDiscountRequest): Promise<DeleteAdditionalDiscountResponse>;
|
|
1408
|
+
/**
|
|
1409
|
+
* Same as `deleteAdditionalDiscount`, but resolves with the response body together with the HTTP status and headers.
|
|
1410
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1411
|
+
* @param {DealsApiDeleteAdditionalDiscountRequest} requestParameters Request parameters.
|
|
1412
|
+
|
|
1413
|
+
* @throws {RequiredError}
|
|
1414
|
+
* @memberof DealsApi
|
|
1415
|
+
*/
|
|
1416
|
+
deleteAdditionalDiscountWithHttpInfo(requestParameters: DealsApiDeleteAdditionalDiscountRequest): Promise<ApiResponse<DeleteAdditionalDiscountResponse>>;
|
|
1172
1417
|
/**
|
|
1173
1418
|
* Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
|
|
1174
1419
|
* @summary Delete a deal
|
|
@@ -1178,6 +1423,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1178
1423
|
* @memberof DealsApi
|
|
1179
1424
|
*/
|
|
1180
1425
|
deleteDeal(requestParameters: DealsApiDeleteDealRequest): Promise<DeleteDealResponse>;
|
|
1426
|
+
/**
|
|
1427
|
+
* Same as `deleteDeal`, but resolves with the response body together with the HTTP status and headers.
|
|
1428
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1429
|
+
* @param {DealsApiDeleteDealRequest} requestParameters Request parameters.
|
|
1430
|
+
|
|
1431
|
+
* @throws {RequiredError}
|
|
1432
|
+
* @memberof DealsApi
|
|
1433
|
+
*/
|
|
1434
|
+
deleteDealWithHttpInfo(requestParameters: DealsApiDeleteDealRequest): Promise<ApiResponse<DeleteDealResponse>>;
|
|
1181
1435
|
/**
|
|
1182
1436
|
* Deletes a user follower from the deal.
|
|
1183
1437
|
* @summary Delete a follower from a deal
|
|
@@ -1187,6 +1441,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1187
1441
|
* @memberof DealsApi
|
|
1188
1442
|
*/
|
|
1189
1443
|
deleteDealFollower(requestParameters: DealsApiDeleteDealFollowerRequest): Promise<DeleteFollowerResponse>;
|
|
1444
|
+
/**
|
|
1445
|
+
* Same as `deleteDealFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
1446
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1447
|
+
* @param {DealsApiDeleteDealFollowerRequest} requestParameters Request parameters.
|
|
1448
|
+
|
|
1449
|
+
* @throws {RequiredError}
|
|
1450
|
+
* @memberof DealsApi
|
|
1451
|
+
*/
|
|
1452
|
+
deleteDealFollowerWithHttpInfo(requestParameters: DealsApiDeleteDealFollowerRequest): Promise<ApiResponse<DeleteFollowerResponse>>;
|
|
1190
1453
|
/**
|
|
1191
1454
|
* Lists discounts attached to a deal.
|
|
1192
1455
|
* @summary List discounts added to a deal
|
|
@@ -1196,6 +1459,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1196
1459
|
* @memberof DealsApi
|
|
1197
1460
|
*/
|
|
1198
1461
|
getAdditionalDiscounts(requestParameters: DealsApiGetAdditionalDiscountsRequest): Promise<GetAdditionalDiscountsResponse>;
|
|
1462
|
+
/**
|
|
1463
|
+
* Same as `getAdditionalDiscounts`, but resolves with the response body together with the HTTP status and headers.
|
|
1464
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1465
|
+
* @param {DealsApiGetAdditionalDiscountsRequest} requestParameters Request parameters.
|
|
1466
|
+
|
|
1467
|
+
* @throws {RequiredError}
|
|
1468
|
+
* @memberof DealsApi
|
|
1469
|
+
*/
|
|
1470
|
+
getAdditionalDiscountsWithHttpInfo(requestParameters: DealsApiGetAdditionalDiscountsRequest): Promise<ApiResponse<GetAdditionalDiscountsResponse>>;
|
|
1199
1471
|
/**
|
|
1200
1472
|
* Returns data about all archived deals.
|
|
1201
1473
|
* @summary Get all archived deals
|
|
@@ -1205,6 +1477,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1205
1477
|
* @memberof DealsApi
|
|
1206
1478
|
*/
|
|
1207
1479
|
getArchivedDeals(requestParameters?: DealsApiGetArchivedDealsRequest): Promise<GetDealsResponse>;
|
|
1480
|
+
/**
|
|
1481
|
+
* Same as `getArchivedDeals`, but resolves with the response body together with the HTTP status and headers.
|
|
1482
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1483
|
+
* @param {DealsApiGetArchivedDealsRequest} requestParameters Request parameters.
|
|
1484
|
+
|
|
1485
|
+
* @throws {RequiredError}
|
|
1486
|
+
* @memberof DealsApi
|
|
1487
|
+
*/
|
|
1488
|
+
getArchivedDealsWithHttpInfo(requestParameters?: DealsApiGetArchivedDealsRequest): Promise<ApiResponse<GetDealsResponse>>;
|
|
1208
1489
|
/**
|
|
1209
1490
|
* Returns the details of a specific deal.
|
|
1210
1491
|
* @summary Get details of a deal
|
|
@@ -1214,6 +1495,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1214
1495
|
* @memberof DealsApi
|
|
1215
1496
|
*/
|
|
1216
1497
|
getDeal(requestParameters: DealsApiGetDealRequest): Promise<UpsertDealResponse>;
|
|
1498
|
+
/**
|
|
1499
|
+
* Same as `getDeal`, but resolves with the response body together with the HTTP status and headers.
|
|
1500
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1501
|
+
* @param {DealsApiGetDealRequest} requestParameters Request parameters.
|
|
1502
|
+
|
|
1503
|
+
* @throws {RequiredError}
|
|
1504
|
+
* @memberof DealsApi
|
|
1505
|
+
*/
|
|
1506
|
+
getDealWithHttpInfo(requestParameters: DealsApiGetDealRequest): Promise<ApiResponse<UpsertDealResponse>>;
|
|
1217
1507
|
/**
|
|
1218
1508
|
* Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
|
|
1219
1509
|
* @summary Get Deal conversion status
|
|
@@ -1223,6 +1513,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1223
1513
|
* @memberof DealsApi
|
|
1224
1514
|
*/
|
|
1225
1515
|
getDealConversionStatus(requestParameters: DealsApiGetDealConversionStatusRequest): Promise<GetConvertResponse1>;
|
|
1516
|
+
/**
|
|
1517
|
+
* Same as `getDealConversionStatus`, but resolves with the response body together with the HTTP status and headers.
|
|
1518
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1519
|
+
* @param {DealsApiGetDealConversionStatusRequest} requestParameters Request parameters.
|
|
1520
|
+
|
|
1521
|
+
* @throws {RequiredError}
|
|
1522
|
+
* @memberof DealsApi
|
|
1523
|
+
*/
|
|
1524
|
+
getDealConversionStatusWithHttpInfo(requestParameters: DealsApiGetDealConversionStatusRequest): Promise<ApiResponse<GetConvertResponse1>>;
|
|
1226
1525
|
/**
|
|
1227
1526
|
* Lists users who are following the deal.
|
|
1228
1527
|
* @summary List followers of a deal
|
|
@@ -1232,6 +1531,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1232
1531
|
* @memberof DealsApi
|
|
1233
1532
|
*/
|
|
1234
1533
|
getDealFollowers(requestParameters: DealsApiGetDealFollowersRequest): Promise<GetFollowersResponse>;
|
|
1534
|
+
/**
|
|
1535
|
+
* Same as `getDealFollowers`, but resolves with the response body together with the HTTP status and headers.
|
|
1536
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1537
|
+
* @param {DealsApiGetDealFollowersRequest} requestParameters Request parameters.
|
|
1538
|
+
|
|
1539
|
+
* @throws {RequiredError}
|
|
1540
|
+
* @memberof DealsApi
|
|
1541
|
+
*/
|
|
1542
|
+
getDealFollowersWithHttpInfo(requestParameters: DealsApiGetDealFollowersRequest): Promise<ApiResponse<GetFollowersResponse>>;
|
|
1235
1543
|
/**
|
|
1236
1544
|
* Lists changelogs about users have followed the deal.
|
|
1237
1545
|
* @summary List followers changelog of a deal
|
|
@@ -1241,6 +1549,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1241
1549
|
* @memberof DealsApi
|
|
1242
1550
|
*/
|
|
1243
1551
|
getDealFollowersChangelog(requestParameters: DealsApiGetDealFollowersChangelogRequest): Promise<GetFollowerChangelogsResponse>;
|
|
1552
|
+
/**
|
|
1553
|
+
* Same as `getDealFollowersChangelog`, but resolves with the response body together with the HTTP status and headers.
|
|
1554
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1555
|
+
* @param {DealsApiGetDealFollowersChangelogRequest} requestParameters Request parameters.
|
|
1556
|
+
|
|
1557
|
+
* @throws {RequiredError}
|
|
1558
|
+
* @memberof DealsApi
|
|
1559
|
+
*/
|
|
1560
|
+
getDealFollowersChangelogWithHttpInfo(requestParameters: DealsApiGetDealFollowersChangelogRequest): Promise<ApiResponse<GetFollowerChangelogsResponse>>;
|
|
1244
1561
|
/**
|
|
1245
1562
|
* Returns data about all not archived deals.
|
|
1246
1563
|
* @summary Get all deals
|
|
@@ -1250,6 +1567,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1250
1567
|
* @memberof DealsApi
|
|
1251
1568
|
*/
|
|
1252
1569
|
getDeals(requestParameters?: DealsApiGetDealsRequest): Promise<GetDealsResponse>;
|
|
1570
|
+
/**
|
|
1571
|
+
* Same as `getDeals`, but resolves with the response body together with the HTTP status and headers.
|
|
1572
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1573
|
+
* @param {DealsApiGetDealsRequest} requestParameters Request parameters.
|
|
1574
|
+
|
|
1575
|
+
* @throws {RequiredError}
|
|
1576
|
+
* @memberof DealsApi
|
|
1577
|
+
*/
|
|
1578
|
+
getDealsWithHttpInfo(requestParameters?: DealsApiGetDealsRequest): Promise<ApiResponse<GetDealsResponse>>;
|
|
1253
1579
|
/**
|
|
1254
1580
|
* Adds a discount to a deal, changing the deal value if the deal has one-time products attached.
|
|
1255
1581
|
* @summary Add a discount to a deal
|
|
@@ -1259,6 +1585,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1259
1585
|
* @memberof DealsApi
|
|
1260
1586
|
*/
|
|
1261
1587
|
postAdditionalDiscount(requestParameters: DealsApiPostAdditionalDiscountRequest): Promise<AddAdditionalDiscountResponse>;
|
|
1588
|
+
/**
|
|
1589
|
+
* Same as `postAdditionalDiscount`, but resolves with the response body together with the HTTP status and headers.
|
|
1590
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1591
|
+
* @param {DealsApiPostAdditionalDiscountRequest} requestParameters Request parameters.
|
|
1592
|
+
|
|
1593
|
+
* @throws {RequiredError}
|
|
1594
|
+
* @memberof DealsApi
|
|
1595
|
+
*/
|
|
1596
|
+
postAdditionalDiscountWithHttpInfo(requestParameters: DealsApiPostAdditionalDiscountRequest): Promise<ApiResponse<AddAdditionalDiscountResponse>>;
|
|
1262
1597
|
/**
|
|
1263
1598
|
* 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.
|
|
1264
1599
|
* @summary Search deals
|
|
@@ -1268,6 +1603,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1268
1603
|
* @memberof DealsApi
|
|
1269
1604
|
*/
|
|
1270
1605
|
searchDeals(requestParameters: DealsApiSearchDealsRequest): Promise<GetDealSearchResponse>;
|
|
1606
|
+
/**
|
|
1607
|
+
* Same as `searchDeals`, but resolves with the response body together with the HTTP status and headers.
|
|
1608
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1609
|
+
* @param {DealsApiSearchDealsRequest} requestParameters Request parameters.
|
|
1610
|
+
|
|
1611
|
+
* @throws {RequiredError}
|
|
1612
|
+
* @memberof DealsApi
|
|
1613
|
+
*/
|
|
1614
|
+
searchDealsWithHttpInfo(requestParameters: DealsApiSearchDealsRequest): Promise<ApiResponse<GetDealSearchResponse>>;
|
|
1271
1615
|
/**
|
|
1272
1616
|
* Edits a discount added to a deal, changing the deal value if the deal has one-time products attached.
|
|
1273
1617
|
* @summary Update a discount added to a deal
|
|
@@ -1277,6 +1621,15 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1277
1621
|
* @memberof DealsApi
|
|
1278
1622
|
*/
|
|
1279
1623
|
updateAdditionalDiscount(requestParameters: DealsApiUpdateAdditionalDiscountRequest): Promise<UpdateAdditionalDiscountResponse>;
|
|
1624
|
+
/**
|
|
1625
|
+
* Same as `updateAdditionalDiscount`, but resolves with the response body together with the HTTP status and headers.
|
|
1626
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1627
|
+
* @param {DealsApiUpdateAdditionalDiscountRequest} requestParameters Request parameters.
|
|
1628
|
+
|
|
1629
|
+
* @throws {RequiredError}
|
|
1630
|
+
* @memberof DealsApi
|
|
1631
|
+
*/
|
|
1632
|
+
updateAdditionalDiscountWithHttpInfo(requestParameters: DealsApiUpdateAdditionalDiscountRequest): Promise<ApiResponse<UpdateAdditionalDiscountResponse>>;
|
|
1280
1633
|
/**
|
|
1281
1634
|
* Updates the properties of a deal.
|
|
1282
1635
|
* @summary Update a deal
|
|
@@ -1286,4 +1639,13 @@ export declare class DealsApi extends BaseAPI {
|
|
|
1286
1639
|
* @memberof DealsApi
|
|
1287
1640
|
*/
|
|
1288
1641
|
updateDeal(requestParameters: DealsApiUpdateDealRequest): Promise<UpsertDealResponse>;
|
|
1642
|
+
/**
|
|
1643
|
+
* Same as `updateDeal`, but resolves with the response body together with the HTTP status and headers.
|
|
1644
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1645
|
+
* @param {DealsApiUpdateDealRequest} requestParameters Request parameters.
|
|
1646
|
+
|
|
1647
|
+
* @throws {RequiredError}
|
|
1648
|
+
* @memberof DealsApi
|
|
1649
|
+
*/
|
|
1650
|
+
updateDealWithHttpInfo(requestParameters: DealsApiUpdateDealRequest): Promise<ApiResponse<UpsertDealResponse>>;
|
|
1289
1651
|
}
|