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
|
@@ -949,6 +949,20 @@ const DealsApiFp = function (configuration) {
|
|
|
949
949
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
950
950
|
});
|
|
951
951
|
},
|
|
952
|
+
/**
|
|
953
|
+
* Same as `addDealFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
954
|
+
* @summary Add a follower to a deal
|
|
955
|
+
* @param {number} id The ID of the deal
|
|
956
|
+
* @param {AddDealFollowerRequest} [AddDealFollowerRequest]
|
|
957
|
+
|
|
958
|
+
* @throws {RequiredError}
|
|
959
|
+
*/
|
|
960
|
+
addDealFollowerWithHttpInfo(id, AddDealFollowerRequest) {
|
|
961
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
962
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.addDealFollower(id, AddDealFollowerRequest);
|
|
963
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
964
|
+
});
|
|
965
|
+
},
|
|
952
966
|
/**
|
|
953
967
|
* Adds a participant to a deal.
|
|
954
968
|
* @summary Add a participant to a deal
|
|
@@ -963,6 +977,20 @@ const DealsApiFp = function (configuration) {
|
|
|
963
977
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
964
978
|
});
|
|
965
979
|
},
|
|
980
|
+
/**
|
|
981
|
+
* Same as `addDealParticipant`, but resolves with the response body together with the HTTP status and headers.
|
|
982
|
+
* @summary Add a participant to a deal
|
|
983
|
+
* @param {number} id The ID of the deal
|
|
984
|
+
* @param {AddDealParticipantRequest} [AddDealParticipantRequest]
|
|
985
|
+
|
|
986
|
+
* @throws {RequiredError}
|
|
987
|
+
*/
|
|
988
|
+
addDealParticipantWithHttpInfo(id, AddDealParticipantRequest) {
|
|
989
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
990
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.addDealParticipant(id, AddDealParticipantRequest);
|
|
991
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
992
|
+
});
|
|
993
|
+
},
|
|
966
994
|
/**
|
|
967
995
|
* Deletes a follower from a deal.
|
|
968
996
|
* @summary Delete a follower from a deal
|
|
@@ -977,6 +1005,20 @@ const DealsApiFp = function (configuration) {
|
|
|
977
1005
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
978
1006
|
});
|
|
979
1007
|
},
|
|
1008
|
+
/**
|
|
1009
|
+
* Same as `deleteDealFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
1010
|
+
* @summary Delete a follower from a deal
|
|
1011
|
+
* @param {number} id The ID of the deal
|
|
1012
|
+
* @param {number} follower_id The ID of the relationship between the follower and the deal
|
|
1013
|
+
|
|
1014
|
+
* @throws {RequiredError}
|
|
1015
|
+
*/
|
|
1016
|
+
deleteDealFollowerWithHttpInfo(id, follower_id) {
|
|
1017
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1018
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteDealFollower(id, follower_id);
|
|
1019
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
1020
|
+
});
|
|
1021
|
+
},
|
|
980
1022
|
/**
|
|
981
1023
|
* Deletes a participant from a deal.
|
|
982
1024
|
* @summary Delete a participant from a deal
|
|
@@ -991,6 +1033,20 @@ const DealsApiFp = function (configuration) {
|
|
|
991
1033
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
992
1034
|
});
|
|
993
1035
|
},
|
|
1036
|
+
/**
|
|
1037
|
+
* Same as `deleteDealParticipant`, but resolves with the response body together with the HTTP status and headers.
|
|
1038
|
+
* @summary Delete a participant from a deal
|
|
1039
|
+
* @param {number} id The ID of the deal
|
|
1040
|
+
* @param {number} deal_participant_id The ID of the participant of the deal
|
|
1041
|
+
|
|
1042
|
+
* @throws {RequiredError}
|
|
1043
|
+
*/
|
|
1044
|
+
deleteDealParticipantWithHttpInfo(id, deal_participant_id) {
|
|
1045
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1046
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteDealParticipant(id, deal_participant_id);
|
|
1047
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
1048
|
+
});
|
|
1049
|
+
},
|
|
994
1050
|
/**
|
|
995
1051
|
* Duplicates a deal.
|
|
996
1052
|
* @summary Duplicate deal
|
|
@@ -1004,6 +1060,19 @@ const DealsApiFp = function (configuration) {
|
|
|
1004
1060
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1005
1061
|
});
|
|
1006
1062
|
},
|
|
1063
|
+
/**
|
|
1064
|
+
* Same as `duplicateDeal`, but resolves with the response body together with the HTTP status and headers.
|
|
1065
|
+
* @summary Duplicate deal
|
|
1066
|
+
* @param {number} id The ID of the deal
|
|
1067
|
+
|
|
1068
|
+
* @throws {RequiredError}
|
|
1069
|
+
*/
|
|
1070
|
+
duplicateDealWithHttpInfo(id) {
|
|
1071
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1072
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.duplicateDeal(id);
|
|
1073
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
1074
|
+
});
|
|
1075
|
+
},
|
|
1007
1076
|
/**
|
|
1008
1077
|
* Returns all archived deals.
|
|
1009
1078
|
* @summary Get all archived deals
|
|
@@ -1028,6 +1097,30 @@ const DealsApiFp = function (configuration) {
|
|
|
1028
1097
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1029
1098
|
});
|
|
1030
1099
|
},
|
|
1100
|
+
/**
|
|
1101
|
+
* Same as `getArchivedDeals`, but resolves with the response body together with the HTTP status and headers.
|
|
1102
|
+
* @summary Get all archived deals
|
|
1103
|
+
* @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.
|
|
1104
|
+
* @param {number} [filter_id] The ID of the filter to use
|
|
1105
|
+
* @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
|
|
1106
|
+
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
1107
|
+
* @param {number} [product_id] If supplied, only deals linked to the specified product are returned. If filter_id is provided, this is ignored.
|
|
1108
|
+
* @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
|
|
1109
|
+
* @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
|
|
1110
|
+
* @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.
|
|
1111
|
+
* @param {number} [start] Pagination start
|
|
1112
|
+
* @param {number} [limit] Items shown per page
|
|
1113
|
+
* @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).
|
|
1114
|
+
* @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.
|
|
1115
|
+
* @deprecated
|
|
1116
|
+
* @throws {RequiredError}
|
|
1117
|
+
*/
|
|
1118
|
+
getArchivedDealsWithHttpInfo(user_id, filter_id, person_id, org_id, product_id, pipeline_id, stage_id, status, start, limit, sort, owned_by_you) {
|
|
1119
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1120
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getArchivedDeals(user_id, filter_id, person_id, org_id, product_id, pipeline_id, stage_id, status, start, limit, sort, owned_by_you);
|
|
1121
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
1122
|
+
});
|
|
1123
|
+
},
|
|
1031
1124
|
/**
|
|
1032
1125
|
* Returns a summary of all archived deals.
|
|
1033
1126
|
* @summary Get archived deals summary
|
|
@@ -1045,6 +1138,23 @@ const DealsApiFp = function (configuration) {
|
|
|
1045
1138
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1046
1139
|
});
|
|
1047
1140
|
},
|
|
1141
|
+
/**
|
|
1142
|
+
* Same as `getArchivedDealsSummary`, but resolves with the response body together with the HTTP status and headers.
|
|
1143
|
+
* @summary Get archived deals summary
|
|
1144
|
+
* @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.
|
|
1145
|
+
* @param {number} [filter_id] <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
|
|
1146
|
+
* @param {number} [user_id] Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.
|
|
1147
|
+
* @param {number} [pipeline_id] Only deals within the given pipeline will be returned
|
|
1148
|
+
* @param {number} [stage_id] Only deals within the given stage will be returned
|
|
1149
|
+
* @deprecated
|
|
1150
|
+
* @throws {RequiredError}
|
|
1151
|
+
*/
|
|
1152
|
+
getArchivedDealsSummaryWithHttpInfo(status, filter_id, user_id, pipeline_id, stage_id) {
|
|
1153
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1154
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getArchivedDealsSummary(status, filter_id, user_id, pipeline_id, stage_id);
|
|
1155
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
1156
|
+
});
|
|
1157
|
+
},
|
|
1048
1158
|
/**
|
|
1049
1159
|
* 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`.
|
|
1050
1160
|
* @summary Get archived deals timeline
|
|
@@ -1066,6 +1176,27 @@ const DealsApiFp = function (configuration) {
|
|
|
1066
1176
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1067
1177
|
});
|
|
1068
1178
|
},
|
|
1179
|
+
/**
|
|
1180
|
+
* Same as `getArchivedDealsTimeline`, but resolves with the response body together with the HTTP status and headers.
|
|
1181
|
+
* @summary Get archived deals timeline
|
|
1182
|
+
* @param {string} start_date The date when the first interval starts. Format: YYYY-MM-DD.
|
|
1183
|
+
* @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>
|
|
1184
|
+
* @param {number} amount The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months).
|
|
1185
|
+
* @param {string} field_key The date field key which deals will be retrieved from
|
|
1186
|
+
* @param {number} [user_id] If supplied, only deals matching the given user will be returned
|
|
1187
|
+
* @param {number} [pipeline_id] If supplied, only deals matching the given pipeline will be returned
|
|
1188
|
+
* @param {number} [filter_id] If supplied, only deals matching the given filter will be returned
|
|
1189
|
+
* @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.
|
|
1190
|
+
* @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.
|
|
1191
|
+
* @deprecated
|
|
1192
|
+
* @throws {RequiredError}
|
|
1193
|
+
*/
|
|
1194
|
+
getArchivedDealsTimelineWithHttpInfo(start_date, interval, amount, field_key, user_id, pipeline_id, filter_id, exclude_deals, totals_convert_currency) {
|
|
1195
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1196
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getArchivedDealsTimeline(start_date, interval, amount, field_key, user_id, pipeline_id, filter_id, exclude_deals, totals_convert_currency);
|
|
1197
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
1198
|
+
});
|
|
1199
|
+
},
|
|
1069
1200
|
/**
|
|
1070
1201
|
* Lists updates about field values of a deal.
|
|
1071
1202
|
* @summary List updates about deal field values
|
|
@@ -1081,6 +1212,21 @@ const DealsApiFp = function (configuration) {
|
|
|
1081
1212
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1082
1213
|
});
|
|
1083
1214
|
},
|
|
1215
|
+
/**
|
|
1216
|
+
* Same as `getDealChangelog`, but resolves with the response body together with the HTTP status and headers.
|
|
1217
|
+
* @summary List updates about deal field values
|
|
1218
|
+
* @param {number} id The ID of the deal
|
|
1219
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
1220
|
+
* @param {number} [limit] Items shown per page
|
|
1221
|
+
|
|
1222
|
+
* @throws {RequiredError}
|
|
1223
|
+
*/
|
|
1224
|
+
getDealChangelogWithHttpInfo(id, cursor, limit) {
|
|
1225
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1226
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealChangelog(id, cursor, limit);
|
|
1227
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
1228
|
+
});
|
|
1229
|
+
},
|
|
1084
1230
|
/**
|
|
1085
1231
|
* Lists files associated with a deal.
|
|
1086
1232
|
* @summary List files attached to a deal
|
|
@@ -1097,6 +1243,22 @@ const DealsApiFp = function (configuration) {
|
|
|
1097
1243
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1098
1244
|
});
|
|
1099
1245
|
},
|
|
1246
|
+
/**
|
|
1247
|
+
* Same as `getDealFiles`, but resolves with the response body together with the HTTP status and headers.
|
|
1248
|
+
* @summary List files attached to a deal
|
|
1249
|
+
* @param {number} id The ID of the deal
|
|
1250
|
+
* @param {number} [start] Pagination start
|
|
1251
|
+
* @param {number} [limit] Items shown per page. Please note that a maximum value of 100 is allowed.
|
|
1252
|
+
* @param {string} [sort] Supported fields: `id`, `update_time`
|
|
1253
|
+
|
|
1254
|
+
* @throws {RequiredError}
|
|
1255
|
+
*/
|
|
1256
|
+
getDealFilesWithHttpInfo(id, start, limit, sort) {
|
|
1257
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1258
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealFiles(id, start, limit, sort);
|
|
1259
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
1260
|
+
});
|
|
1261
|
+
},
|
|
1100
1262
|
/**
|
|
1101
1263
|
* Lists the followers of a deal.
|
|
1102
1264
|
* @summary List followers of a deal
|
|
@@ -1110,6 +1272,19 @@ const DealsApiFp = function (configuration) {
|
|
|
1110
1272
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1111
1273
|
});
|
|
1112
1274
|
},
|
|
1275
|
+
/**
|
|
1276
|
+
* Same as `getDealFollowers`, but resolves with the response body together with the HTTP status and headers.
|
|
1277
|
+
* @summary List followers of a deal
|
|
1278
|
+
* @param {number} id The ID of the deal
|
|
1279
|
+
|
|
1280
|
+
* @throws {RequiredError}
|
|
1281
|
+
*/
|
|
1282
|
+
getDealFollowersWithHttpInfo(id) {
|
|
1283
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1284
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealFollowers(id);
|
|
1285
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
1286
|
+
});
|
|
1287
|
+
},
|
|
1113
1288
|
/**
|
|
1114
1289
|
* Lists mail messages associated with a deal.
|
|
1115
1290
|
* @summary List mail messages associated with a deal
|
|
@@ -1126,6 +1301,22 @@ const DealsApiFp = function (configuration) {
|
|
|
1126
1301
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1127
1302
|
});
|
|
1128
1303
|
},
|
|
1304
|
+
/**
|
|
1305
|
+
* Same as `getDealMailMessages`, but resolves with the response body together with the HTTP status and headers.
|
|
1306
|
+
* @summary List mail messages associated with a deal
|
|
1307
|
+
* @param {number} id The ID of the deal
|
|
1308
|
+
* @param {number} [start] Pagination start
|
|
1309
|
+
* @param {number} [limit] Items shown per page
|
|
1310
|
+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. `0` = Don\'t include, `1` = Include.
|
|
1311
|
+
|
|
1312
|
+
* @throws {RequiredError}
|
|
1313
|
+
*/
|
|
1314
|
+
getDealMailMessagesWithHttpInfo(id, start, limit, include_body) {
|
|
1315
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1316
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealMailMessages(id, start, limit, include_body);
|
|
1317
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
1318
|
+
});
|
|
1319
|
+
},
|
|
1129
1320
|
/**
|
|
1130
1321
|
* Lists the participants associated with a deal.<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.
|
|
1131
1322
|
* @summary List participants of a deal
|
|
@@ -1141,6 +1332,21 @@ const DealsApiFp = function (configuration) {
|
|
|
1141
1332
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1142
1333
|
});
|
|
1143
1334
|
},
|
|
1335
|
+
/**
|
|
1336
|
+
* Same as `getDealParticipants`, but resolves with the response body together with the HTTP status and headers.
|
|
1337
|
+
* @summary List participants of a deal
|
|
1338
|
+
* @param {number} id The ID of the deal
|
|
1339
|
+
* @param {number} [start] Pagination start
|
|
1340
|
+
* @param {number} [limit] Items shown per page
|
|
1341
|
+
|
|
1342
|
+
* @throws {RequiredError}
|
|
1343
|
+
*/
|
|
1344
|
+
getDealParticipantsWithHttpInfo(id, start, limit) {
|
|
1345
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1346
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealParticipants(id, start, limit);
|
|
1347
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
1348
|
+
});
|
|
1349
|
+
},
|
|
1144
1350
|
/**
|
|
1145
1351
|
* List updates about participants of a deal. This is a cursor-paginated endpoint. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>.
|
|
1146
1352
|
* @summary List updates about participants of a deal
|
|
@@ -1156,6 +1362,21 @@ const DealsApiFp = function (configuration) {
|
|
|
1156
1362
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1157
1363
|
});
|
|
1158
1364
|
},
|
|
1365
|
+
/**
|
|
1366
|
+
* Same as `getDealParticipantsChangelog`, but resolves with the response body together with the HTTP status and headers.
|
|
1367
|
+
* @summary List updates about participants of a deal
|
|
1368
|
+
* @param {number} id The ID of the deal
|
|
1369
|
+
* @param {number} [limit] Items shown per page
|
|
1370
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
1371
|
+
|
|
1372
|
+
* @throws {RequiredError}
|
|
1373
|
+
*/
|
|
1374
|
+
getDealParticipantsChangelogWithHttpInfo(id, limit, cursor) {
|
|
1375
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1376
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealParticipantsChangelog(id, limit, cursor);
|
|
1377
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
1378
|
+
});
|
|
1379
|
+
},
|
|
1159
1380
|
/**
|
|
1160
1381
|
* Lists updates about a deal.
|
|
1161
1382
|
* @summary List updates about a deal
|
|
@@ -1173,6 +1394,23 @@ const DealsApiFp = function (configuration) {
|
|
|
1173
1394
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1174
1395
|
});
|
|
1175
1396
|
},
|
|
1397
|
+
/**
|
|
1398
|
+
* Same as `getDealUpdates`, but resolves with the response body together with the HTTP status and headers.
|
|
1399
|
+
* @summary List updates about a deal
|
|
1400
|
+
* @param {number} id The ID of the deal
|
|
1401
|
+
* @param {number} [start] Pagination start
|
|
1402
|
+
* @param {number} [limit] Items shown per page
|
|
1403
|
+
* @param {string} [all_changes] Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
|
|
1404
|
+
* @param {Set<string>} [items] A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).
|
|
1405
|
+
|
|
1406
|
+
* @throws {RequiredError}
|
|
1407
|
+
*/
|
|
1408
|
+
getDealUpdatesWithHttpInfo(id, start, limit, all_changes, items) {
|
|
1409
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1410
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealUpdates(id, start, limit, all_changes, items);
|
|
1411
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
1412
|
+
});
|
|
1413
|
+
},
|
|
1176
1414
|
/**
|
|
1177
1415
|
* Lists the users permitted to access a deal.
|
|
1178
1416
|
* @summary List permitted users
|
|
@@ -1186,6 +1424,19 @@ const DealsApiFp = function (configuration) {
|
|
|
1186
1424
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1187
1425
|
});
|
|
1188
1426
|
},
|
|
1427
|
+
/**
|
|
1428
|
+
* Same as `getDealUsers`, but resolves with the response body together with the HTTP status and headers.
|
|
1429
|
+
* @summary List permitted users
|
|
1430
|
+
* @param {number} id The ID of the deal
|
|
1431
|
+
|
|
1432
|
+
* @throws {RequiredError}
|
|
1433
|
+
*/
|
|
1434
|
+
getDealUsersWithHttpInfo(id) {
|
|
1435
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1436
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealUsers(id);
|
|
1437
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
1438
|
+
});
|
|
1439
|
+
},
|
|
1189
1440
|
/**
|
|
1190
1441
|
* Returns a summary of all not archived deals.
|
|
1191
1442
|
* @summary Get deals summary
|
|
@@ -1203,6 +1454,23 @@ const DealsApiFp = function (configuration) {
|
|
|
1203
1454
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1204
1455
|
});
|
|
1205
1456
|
},
|
|
1457
|
+
/**
|
|
1458
|
+
* Same as `getDealsSummary`, but resolves with the response body together with the HTTP status and headers.
|
|
1459
|
+
* @summary Get deals summary
|
|
1460
|
+
* @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.
|
|
1461
|
+
* @param {number} [filter_id] <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
|
|
1462
|
+
* @param {number} [user_id] Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.
|
|
1463
|
+
* @param {number} [pipeline_id] Only deals within the given pipeline will be returned
|
|
1464
|
+
* @param {number} [stage_id] Only deals within the given stage will be returned
|
|
1465
|
+
|
|
1466
|
+
* @throws {RequiredError}
|
|
1467
|
+
*/
|
|
1468
|
+
getDealsSummaryWithHttpInfo(status, filter_id, user_id, pipeline_id, stage_id) {
|
|
1469
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1470
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealsSummary(status, filter_id, user_id, pipeline_id, stage_id);
|
|
1471
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
1472
|
+
});
|
|
1473
|
+
},
|
|
1206
1474
|
/**
|
|
1207
1475
|
* 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`.
|
|
1208
1476
|
* @summary Get deals timeline
|
|
@@ -1224,6 +1492,27 @@ const DealsApiFp = function (configuration) {
|
|
|
1224
1492
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1225
1493
|
});
|
|
1226
1494
|
},
|
|
1495
|
+
/**
|
|
1496
|
+
* Same as `getDealsTimeline`, but resolves with the response body together with the HTTP status and headers.
|
|
1497
|
+
* @summary Get deals timeline
|
|
1498
|
+
* @param {string} start_date The date when the first interval starts. Format: YYYY-MM-DD.
|
|
1499
|
+
* @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>
|
|
1500
|
+
* @param {number} amount The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months).
|
|
1501
|
+
* @param {string} field_key The date field key which deals will be retrieved from
|
|
1502
|
+
* @param {number} [user_id] If supplied, only deals matching the given user will be returned
|
|
1503
|
+
* @param {number} [pipeline_id] If supplied, only deals matching the given pipeline will be returned
|
|
1504
|
+
* @param {number} [filter_id] If supplied, only deals matching the given filter will be returned
|
|
1505
|
+
* @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.
|
|
1506
|
+
* @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.
|
|
1507
|
+
|
|
1508
|
+
* @throws {RequiredError}
|
|
1509
|
+
*/
|
|
1510
|
+
getDealsTimelineWithHttpInfo(start_date, interval, amount, field_key, user_id, pipeline_id, filter_id, exclude_deals, totals_convert_currency) {
|
|
1511
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1512
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealsTimeline(start_date, interval, amount, field_key, user_id, pipeline_id, filter_id, exclude_deals, totals_convert_currency);
|
|
1513
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
1514
|
+
});
|
|
1515
|
+
},
|
|
1227
1516
|
/**
|
|
1228
1517
|
* Merges a deal with another deal. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/merging-two-deals\" target=\"_blank\" rel=\"noopener noreferrer\">merging two deals</a>.
|
|
1229
1518
|
* @summary Merge two deals
|
|
@@ -1238,6 +1527,20 @@ const DealsApiFp = function (configuration) {
|
|
|
1238
1527
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1239
1528
|
});
|
|
1240
1529
|
},
|
|
1530
|
+
/**
|
|
1531
|
+
* Same as `mergeDeals`, but resolves with the response body together with the HTTP status and headers.
|
|
1532
|
+
* @summary Merge two deals
|
|
1533
|
+
* @param {number} id The ID of the deal
|
|
1534
|
+
* @param {MergeDealsRequest} [MergeDealsRequest]
|
|
1535
|
+
|
|
1536
|
+
* @throws {RequiredError}
|
|
1537
|
+
*/
|
|
1538
|
+
mergeDealsWithHttpInfo(id, MergeDealsRequest) {
|
|
1539
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1540
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.mergeDeals(id, MergeDealsRequest);
|
|
1541
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
1542
|
+
});
|
|
1543
|
+
},
|
|
1241
1544
|
};
|
|
1242
1545
|
};
|
|
1243
1546
|
exports.DealsApiFp = DealsApiFp;
|
|
@@ -1258,6 +1561,9 @@ const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1258
1561
|
addDealFollower(requestParameters) {
|
|
1259
1562
|
return localVarFp.addDealFollower(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(axios, basePath));
|
|
1260
1563
|
},
|
|
1564
|
+
addDealFollowerWithHttpInfo(requestParameters) {
|
|
1565
|
+
return localVarFp.addDealFollowerWithHttpInfo(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(axios, basePath));
|
|
1566
|
+
},
|
|
1261
1567
|
/**
|
|
1262
1568
|
* Adds a participant to a deal.
|
|
1263
1569
|
* @summary Add a participant to a deal
|
|
@@ -1268,6 +1574,9 @@ const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1268
1574
|
addDealParticipant(requestParameters) {
|
|
1269
1575
|
return localVarFp.addDealParticipant(requestParameters.id, requestParameters.AddDealParticipantRequest).then((request) => request(axios, basePath));
|
|
1270
1576
|
},
|
|
1577
|
+
addDealParticipantWithHttpInfo(requestParameters) {
|
|
1578
|
+
return localVarFp.addDealParticipantWithHttpInfo(requestParameters.id, requestParameters.AddDealParticipantRequest).then((request) => request(axios, basePath));
|
|
1579
|
+
},
|
|
1271
1580
|
/**
|
|
1272
1581
|
* Deletes a follower from a deal.
|
|
1273
1582
|
* @summary Delete a follower from a deal
|
|
@@ -1278,6 +1587,9 @@ const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1278
1587
|
deleteDealFollower(requestParameters) {
|
|
1279
1588
|
return localVarFp.deleteDealFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(axios, basePath));
|
|
1280
1589
|
},
|
|
1590
|
+
deleteDealFollowerWithHttpInfo(requestParameters) {
|
|
1591
|
+
return localVarFp.deleteDealFollowerWithHttpInfo(requestParameters.id, requestParameters.follower_id).then((request) => request(axios, basePath));
|
|
1592
|
+
},
|
|
1281
1593
|
/**
|
|
1282
1594
|
* Deletes a participant from a deal.
|
|
1283
1595
|
* @summary Delete a participant from a deal
|
|
@@ -1288,6 +1600,9 @@ const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1288
1600
|
deleteDealParticipant(requestParameters) {
|
|
1289
1601
|
return localVarFp.deleteDealParticipant(requestParameters.id, requestParameters.deal_participant_id).then((request) => request(axios, basePath));
|
|
1290
1602
|
},
|
|
1603
|
+
deleteDealParticipantWithHttpInfo(requestParameters) {
|
|
1604
|
+
return localVarFp.deleteDealParticipantWithHttpInfo(requestParameters.id, requestParameters.deal_participant_id).then((request) => request(axios, basePath));
|
|
1605
|
+
},
|
|
1291
1606
|
/**
|
|
1292
1607
|
* Duplicates a deal.
|
|
1293
1608
|
* @summary Duplicate deal
|
|
@@ -1298,6 +1613,9 @@ const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1298
1613
|
duplicateDeal(requestParameters) {
|
|
1299
1614
|
return localVarFp.duplicateDeal(requestParameters.id).then((request) => request(axios, basePath));
|
|
1300
1615
|
},
|
|
1616
|
+
duplicateDealWithHttpInfo(requestParameters) {
|
|
1617
|
+
return localVarFp.duplicateDealWithHttpInfo(requestParameters.id).then((request) => request(axios, basePath));
|
|
1618
|
+
},
|
|
1301
1619
|
/**
|
|
1302
1620
|
* Returns all archived deals.
|
|
1303
1621
|
* @summary Get all archived deals
|
|
@@ -1308,6 +1626,9 @@ const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1308
1626
|
getArchivedDeals(requestParameters = {}) {
|
|
1309
1627
|
return localVarFp.getArchivedDeals(requestParameters.user_id, requestParameters.filter_id, requestParameters.person_id, requestParameters.org_id, requestParameters.product_id, requestParameters.pipeline_id, requestParameters.stage_id, requestParameters.status, requestParameters.start, requestParameters.limit, requestParameters.sort, requestParameters.owned_by_you).then((request) => request(axios, basePath));
|
|
1310
1628
|
},
|
|
1629
|
+
getArchivedDealsWithHttpInfo(requestParameters = {}) {
|
|
1630
|
+
return localVarFp.getArchivedDealsWithHttpInfo(requestParameters.user_id, requestParameters.filter_id, requestParameters.person_id, requestParameters.org_id, requestParameters.product_id, requestParameters.pipeline_id, requestParameters.stage_id, requestParameters.status, requestParameters.start, requestParameters.limit, requestParameters.sort, requestParameters.owned_by_you).then((request) => request(axios, basePath));
|
|
1631
|
+
},
|
|
1311
1632
|
/**
|
|
1312
1633
|
* Returns a summary of all archived deals.
|
|
1313
1634
|
* @summary Get archived deals summary
|
|
@@ -1318,6 +1639,9 @@ const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1318
1639
|
getArchivedDealsSummary(requestParameters = {}) {
|
|
1319
1640
|
return localVarFp.getArchivedDealsSummary(requestParameters.status, requestParameters.filter_id, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.stage_id).then((request) => request(axios, basePath));
|
|
1320
1641
|
},
|
|
1642
|
+
getArchivedDealsSummaryWithHttpInfo(requestParameters = {}) {
|
|
1643
|
+
return localVarFp.getArchivedDealsSummaryWithHttpInfo(requestParameters.status, requestParameters.filter_id, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.stage_id).then((request) => request(axios, basePath));
|
|
1644
|
+
},
|
|
1321
1645
|
/**
|
|
1322
1646
|
* 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`.
|
|
1323
1647
|
* @summary Get archived deals timeline
|
|
@@ -1328,6 +1652,9 @@ const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1328
1652
|
getArchivedDealsTimeline(requestParameters) {
|
|
1329
1653
|
return localVarFp.getArchivedDealsTimeline(requestParameters.start_date, requestParameters.interval, requestParameters.amount, requestParameters.field_key, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.filter_id, requestParameters.exclude_deals, requestParameters.totals_convert_currency).then((request) => request(axios, basePath));
|
|
1330
1654
|
},
|
|
1655
|
+
getArchivedDealsTimelineWithHttpInfo(requestParameters) {
|
|
1656
|
+
return localVarFp.getArchivedDealsTimelineWithHttpInfo(requestParameters.start_date, requestParameters.interval, requestParameters.amount, requestParameters.field_key, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.filter_id, requestParameters.exclude_deals, requestParameters.totals_convert_currency).then((request) => request(axios, basePath));
|
|
1657
|
+
},
|
|
1331
1658
|
/**
|
|
1332
1659
|
* Lists updates about field values of a deal.
|
|
1333
1660
|
* @summary List updates about deal field values
|
|
@@ -1338,6 +1665,9 @@ const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1338
1665
|
getDealChangelog(requestParameters) {
|
|
1339
1666
|
return localVarFp.getDealChangelog(requestParameters.id, requestParameters.cursor, requestParameters.limit).then((request) => request(axios, basePath));
|
|
1340
1667
|
},
|
|
1668
|
+
getDealChangelogWithHttpInfo(requestParameters) {
|
|
1669
|
+
return localVarFp.getDealChangelogWithHttpInfo(requestParameters.id, requestParameters.cursor, requestParameters.limit).then((request) => request(axios, basePath));
|
|
1670
|
+
},
|
|
1341
1671
|
/**
|
|
1342
1672
|
* Lists files associated with a deal.
|
|
1343
1673
|
* @summary List files attached to a deal
|
|
@@ -1348,6 +1678,9 @@ const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1348
1678
|
getDealFiles(requestParameters) {
|
|
1349
1679
|
return localVarFp.getDealFiles(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.sort).then((request) => request(axios, basePath));
|
|
1350
1680
|
},
|
|
1681
|
+
getDealFilesWithHttpInfo(requestParameters) {
|
|
1682
|
+
return localVarFp.getDealFilesWithHttpInfo(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.sort).then((request) => request(axios, basePath));
|
|
1683
|
+
},
|
|
1351
1684
|
/**
|
|
1352
1685
|
* Lists the followers of a deal.
|
|
1353
1686
|
* @summary List followers of a deal
|
|
@@ -1358,6 +1691,9 @@ const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1358
1691
|
getDealFollowers(requestParameters) {
|
|
1359
1692
|
return localVarFp.getDealFollowers(requestParameters.id).then((request) => request(axios, basePath));
|
|
1360
1693
|
},
|
|
1694
|
+
getDealFollowersWithHttpInfo(requestParameters) {
|
|
1695
|
+
return localVarFp.getDealFollowersWithHttpInfo(requestParameters.id).then((request) => request(axios, basePath));
|
|
1696
|
+
},
|
|
1361
1697
|
/**
|
|
1362
1698
|
* Lists mail messages associated with a deal.
|
|
1363
1699
|
* @summary List mail messages associated with a deal
|
|
@@ -1368,6 +1704,9 @@ const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1368
1704
|
getDealMailMessages(requestParameters) {
|
|
1369
1705
|
return localVarFp.getDealMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.include_body).then((request) => request(axios, basePath));
|
|
1370
1706
|
},
|
|
1707
|
+
getDealMailMessagesWithHttpInfo(requestParameters) {
|
|
1708
|
+
return localVarFp.getDealMailMessagesWithHttpInfo(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.include_body).then((request) => request(axios, basePath));
|
|
1709
|
+
},
|
|
1371
1710
|
/**
|
|
1372
1711
|
* Lists the participants associated with a deal.<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.
|
|
1373
1712
|
* @summary List participants of a deal
|
|
@@ -1378,6 +1717,9 @@ const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1378
1717
|
getDealParticipants(requestParameters) {
|
|
1379
1718
|
return localVarFp.getDealParticipants(requestParameters.id, requestParameters.start, requestParameters.limit).then((request) => request(axios, basePath));
|
|
1380
1719
|
},
|
|
1720
|
+
getDealParticipantsWithHttpInfo(requestParameters) {
|
|
1721
|
+
return localVarFp.getDealParticipantsWithHttpInfo(requestParameters.id, requestParameters.start, requestParameters.limit).then((request) => request(axios, basePath));
|
|
1722
|
+
},
|
|
1381
1723
|
/**
|
|
1382
1724
|
* List updates about participants of a deal. This is a cursor-paginated endpoint. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>.
|
|
1383
1725
|
* @summary List updates about participants of a deal
|
|
@@ -1388,6 +1730,9 @@ const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1388
1730
|
getDealParticipantsChangelog(requestParameters) {
|
|
1389
1731
|
return localVarFp.getDealParticipantsChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
|
1390
1732
|
},
|
|
1733
|
+
getDealParticipantsChangelogWithHttpInfo(requestParameters) {
|
|
1734
|
+
return localVarFp.getDealParticipantsChangelogWithHttpInfo(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
|
1735
|
+
},
|
|
1391
1736
|
/**
|
|
1392
1737
|
* Lists updates about a deal.
|
|
1393
1738
|
* @summary List updates about a deal
|
|
@@ -1398,6 +1743,9 @@ const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1398
1743
|
getDealUpdates(requestParameters) {
|
|
1399
1744
|
return localVarFp.getDealUpdates(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.all_changes, requestParameters.items).then((request) => request(axios, basePath));
|
|
1400
1745
|
},
|
|
1746
|
+
getDealUpdatesWithHttpInfo(requestParameters) {
|
|
1747
|
+
return localVarFp.getDealUpdatesWithHttpInfo(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.all_changes, requestParameters.items).then((request) => request(axios, basePath));
|
|
1748
|
+
},
|
|
1401
1749
|
/**
|
|
1402
1750
|
* Lists the users permitted to access a deal.
|
|
1403
1751
|
* @summary List permitted users
|
|
@@ -1408,6 +1756,9 @@ const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1408
1756
|
getDealUsers(requestParameters) {
|
|
1409
1757
|
return localVarFp.getDealUsers(requestParameters.id).then((request) => request(axios, basePath));
|
|
1410
1758
|
},
|
|
1759
|
+
getDealUsersWithHttpInfo(requestParameters) {
|
|
1760
|
+
return localVarFp.getDealUsersWithHttpInfo(requestParameters.id).then((request) => request(axios, basePath));
|
|
1761
|
+
},
|
|
1411
1762
|
/**
|
|
1412
1763
|
* Returns a summary of all not archived deals.
|
|
1413
1764
|
* @summary Get deals summary
|
|
@@ -1418,6 +1769,9 @@ const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1418
1769
|
getDealsSummary(requestParameters = {}) {
|
|
1419
1770
|
return localVarFp.getDealsSummary(requestParameters.status, requestParameters.filter_id, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.stage_id).then((request) => request(axios, basePath));
|
|
1420
1771
|
},
|
|
1772
|
+
getDealsSummaryWithHttpInfo(requestParameters = {}) {
|
|
1773
|
+
return localVarFp.getDealsSummaryWithHttpInfo(requestParameters.status, requestParameters.filter_id, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.stage_id).then((request) => request(axios, basePath));
|
|
1774
|
+
},
|
|
1421
1775
|
/**
|
|
1422
1776
|
* 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`.
|
|
1423
1777
|
* @summary Get deals timeline
|
|
@@ -1428,6 +1782,9 @@ const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1428
1782
|
getDealsTimeline(requestParameters) {
|
|
1429
1783
|
return localVarFp.getDealsTimeline(requestParameters.start_date, requestParameters.interval, requestParameters.amount, requestParameters.field_key, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.filter_id, requestParameters.exclude_deals, requestParameters.totals_convert_currency).then((request) => request(axios, basePath));
|
|
1430
1784
|
},
|
|
1785
|
+
getDealsTimelineWithHttpInfo(requestParameters) {
|
|
1786
|
+
return localVarFp.getDealsTimelineWithHttpInfo(requestParameters.start_date, requestParameters.interval, requestParameters.amount, requestParameters.field_key, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.filter_id, requestParameters.exclude_deals, requestParameters.totals_convert_currency).then((request) => request(axios, basePath));
|
|
1787
|
+
},
|
|
1431
1788
|
/**
|
|
1432
1789
|
* Merges a deal with another deal. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/merging-two-deals\" target=\"_blank\" rel=\"noopener noreferrer\">merging two deals</a>.
|
|
1433
1790
|
* @summary Merge two deals
|
|
@@ -1438,6 +1795,9 @@ const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1438
1795
|
mergeDeals(requestParameters) {
|
|
1439
1796
|
return localVarFp.mergeDeals(requestParameters.id, requestParameters.MergeDealsRequest).then((request) => request(axios, basePath));
|
|
1440
1797
|
},
|
|
1798
|
+
mergeDealsWithHttpInfo(requestParameters) {
|
|
1799
|
+
return localVarFp.mergeDealsWithHttpInfo(requestParameters.id, requestParameters.MergeDealsRequest).then((request) => request(axios, basePath));
|
|
1800
|
+
},
|
|
1441
1801
|
};
|
|
1442
1802
|
};
|
|
1443
1803
|
exports.DealsApiFactory = DealsApiFactory;
|
|
@@ -1459,6 +1819,17 @@ class DealsApi extends base_1.BaseAPI {
|
|
|
1459
1819
|
addDealFollower(requestParameters) {
|
|
1460
1820
|
return (0, exports.DealsApiFp)(this.configuration).addDealFollower(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(this.axios, this.basePath));
|
|
1461
1821
|
}
|
|
1822
|
+
/**
|
|
1823
|
+
* Same as `addDealFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
1824
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1825
|
+
* @param {DealsApiAddDealFollowerRequest} requestParameters Request parameters.
|
|
1826
|
+
|
|
1827
|
+
* @throws {RequiredError}
|
|
1828
|
+
* @memberof DealsApi
|
|
1829
|
+
*/
|
|
1830
|
+
addDealFollowerWithHttpInfo(requestParameters) {
|
|
1831
|
+
return (0, exports.DealsApiFp)(this.configuration).addDealFollowerWithHttpInfo(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(this.axios, this.basePath));
|
|
1832
|
+
}
|
|
1462
1833
|
/**
|
|
1463
1834
|
* Adds a participant to a deal.
|
|
1464
1835
|
* @summary Add a participant to a deal
|
|
@@ -1470,6 +1841,17 @@ class DealsApi extends base_1.BaseAPI {
|
|
|
1470
1841
|
addDealParticipant(requestParameters) {
|
|
1471
1842
|
return (0, exports.DealsApiFp)(this.configuration).addDealParticipant(requestParameters.id, requestParameters.AddDealParticipantRequest).then((request) => request(this.axios, this.basePath));
|
|
1472
1843
|
}
|
|
1844
|
+
/**
|
|
1845
|
+
* Same as `addDealParticipant`, but resolves with the response body together with the HTTP status and headers.
|
|
1846
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1847
|
+
* @param {DealsApiAddDealParticipantRequest} requestParameters Request parameters.
|
|
1848
|
+
|
|
1849
|
+
* @throws {RequiredError}
|
|
1850
|
+
* @memberof DealsApi
|
|
1851
|
+
*/
|
|
1852
|
+
addDealParticipantWithHttpInfo(requestParameters) {
|
|
1853
|
+
return (0, exports.DealsApiFp)(this.configuration).addDealParticipantWithHttpInfo(requestParameters.id, requestParameters.AddDealParticipantRequest).then((request) => request(this.axios, this.basePath));
|
|
1854
|
+
}
|
|
1473
1855
|
/**
|
|
1474
1856
|
* Deletes a follower from a deal.
|
|
1475
1857
|
* @summary Delete a follower from a deal
|
|
@@ -1481,6 +1863,17 @@ class DealsApi extends base_1.BaseAPI {
|
|
|
1481
1863
|
deleteDealFollower(requestParameters) {
|
|
1482
1864
|
return (0, exports.DealsApiFp)(this.configuration).deleteDealFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(this.axios, this.basePath));
|
|
1483
1865
|
}
|
|
1866
|
+
/**
|
|
1867
|
+
* Same as `deleteDealFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
1868
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1869
|
+
* @param {DealsApiDeleteDealFollowerRequest} requestParameters Request parameters.
|
|
1870
|
+
|
|
1871
|
+
* @throws {RequiredError}
|
|
1872
|
+
* @memberof DealsApi
|
|
1873
|
+
*/
|
|
1874
|
+
deleteDealFollowerWithHttpInfo(requestParameters) {
|
|
1875
|
+
return (0, exports.DealsApiFp)(this.configuration).deleteDealFollowerWithHttpInfo(requestParameters.id, requestParameters.follower_id).then((request) => request(this.axios, this.basePath));
|
|
1876
|
+
}
|
|
1484
1877
|
/**
|
|
1485
1878
|
* Deletes a participant from a deal.
|
|
1486
1879
|
* @summary Delete a participant from a deal
|
|
@@ -1492,6 +1885,17 @@ class DealsApi extends base_1.BaseAPI {
|
|
|
1492
1885
|
deleteDealParticipant(requestParameters) {
|
|
1493
1886
|
return (0, exports.DealsApiFp)(this.configuration).deleteDealParticipant(requestParameters.id, requestParameters.deal_participant_id).then((request) => request(this.axios, this.basePath));
|
|
1494
1887
|
}
|
|
1888
|
+
/**
|
|
1889
|
+
* Same as `deleteDealParticipant`, but resolves with the response body together with the HTTP status and headers.
|
|
1890
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1891
|
+
* @param {DealsApiDeleteDealParticipantRequest} requestParameters Request parameters.
|
|
1892
|
+
|
|
1893
|
+
* @throws {RequiredError}
|
|
1894
|
+
* @memberof DealsApi
|
|
1895
|
+
*/
|
|
1896
|
+
deleteDealParticipantWithHttpInfo(requestParameters) {
|
|
1897
|
+
return (0, exports.DealsApiFp)(this.configuration).deleteDealParticipantWithHttpInfo(requestParameters.id, requestParameters.deal_participant_id).then((request) => request(this.axios, this.basePath));
|
|
1898
|
+
}
|
|
1495
1899
|
/**
|
|
1496
1900
|
* Duplicates a deal.
|
|
1497
1901
|
* @summary Duplicate deal
|
|
@@ -1503,6 +1907,17 @@ class DealsApi extends base_1.BaseAPI {
|
|
|
1503
1907
|
duplicateDeal(requestParameters) {
|
|
1504
1908
|
return (0, exports.DealsApiFp)(this.configuration).duplicateDeal(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
1505
1909
|
}
|
|
1910
|
+
/**
|
|
1911
|
+
* Same as `duplicateDeal`, but resolves with the response body together with the HTTP status and headers.
|
|
1912
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1913
|
+
* @param {DealsApiDuplicateDealRequest} requestParameters Request parameters.
|
|
1914
|
+
|
|
1915
|
+
* @throws {RequiredError}
|
|
1916
|
+
* @memberof DealsApi
|
|
1917
|
+
*/
|
|
1918
|
+
duplicateDealWithHttpInfo(requestParameters) {
|
|
1919
|
+
return (0, exports.DealsApiFp)(this.configuration).duplicateDealWithHttpInfo(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
1920
|
+
}
|
|
1506
1921
|
/**
|
|
1507
1922
|
* Returns all archived deals.
|
|
1508
1923
|
* @summary Get all archived deals
|
|
@@ -1514,6 +1929,17 @@ class DealsApi extends base_1.BaseAPI {
|
|
|
1514
1929
|
getArchivedDeals(requestParameters = {}) {
|
|
1515
1930
|
return (0, exports.DealsApiFp)(this.configuration).getArchivedDeals(requestParameters.user_id, requestParameters.filter_id, requestParameters.person_id, requestParameters.org_id, requestParameters.product_id, requestParameters.pipeline_id, requestParameters.stage_id, requestParameters.status, requestParameters.start, requestParameters.limit, requestParameters.sort, requestParameters.owned_by_you).then((request) => request(this.axios, this.basePath));
|
|
1516
1931
|
}
|
|
1932
|
+
/**
|
|
1933
|
+
* Same as `getArchivedDeals`, but resolves with the response body together with the HTTP status and headers.
|
|
1934
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1935
|
+
* @param {DealsApiGetArchivedDealsRequest} requestParameters Request parameters.
|
|
1936
|
+
* @deprecated
|
|
1937
|
+
* @throws {RequiredError}
|
|
1938
|
+
* @memberof DealsApi
|
|
1939
|
+
*/
|
|
1940
|
+
getArchivedDealsWithHttpInfo(requestParameters = {}) {
|
|
1941
|
+
return (0, exports.DealsApiFp)(this.configuration).getArchivedDealsWithHttpInfo(requestParameters.user_id, requestParameters.filter_id, requestParameters.person_id, requestParameters.org_id, requestParameters.product_id, requestParameters.pipeline_id, requestParameters.stage_id, requestParameters.status, requestParameters.start, requestParameters.limit, requestParameters.sort, requestParameters.owned_by_you).then((request) => request(this.axios, this.basePath));
|
|
1942
|
+
}
|
|
1517
1943
|
/**
|
|
1518
1944
|
* Returns a summary of all archived deals.
|
|
1519
1945
|
* @summary Get archived deals summary
|
|
@@ -1525,6 +1951,17 @@ class DealsApi extends base_1.BaseAPI {
|
|
|
1525
1951
|
getArchivedDealsSummary(requestParameters = {}) {
|
|
1526
1952
|
return (0, exports.DealsApiFp)(this.configuration).getArchivedDealsSummary(requestParameters.status, requestParameters.filter_id, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.stage_id).then((request) => request(this.axios, this.basePath));
|
|
1527
1953
|
}
|
|
1954
|
+
/**
|
|
1955
|
+
* Same as `getArchivedDealsSummary`, but resolves with the response body together with the HTTP status and headers.
|
|
1956
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1957
|
+
* @param {DealsApiGetArchivedDealsSummaryRequest} requestParameters Request parameters.
|
|
1958
|
+
* @deprecated
|
|
1959
|
+
* @throws {RequiredError}
|
|
1960
|
+
* @memberof DealsApi
|
|
1961
|
+
*/
|
|
1962
|
+
getArchivedDealsSummaryWithHttpInfo(requestParameters = {}) {
|
|
1963
|
+
return (0, exports.DealsApiFp)(this.configuration).getArchivedDealsSummaryWithHttpInfo(requestParameters.status, requestParameters.filter_id, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.stage_id).then((request) => request(this.axios, this.basePath));
|
|
1964
|
+
}
|
|
1528
1965
|
/**
|
|
1529
1966
|
* 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`.
|
|
1530
1967
|
* @summary Get archived deals timeline
|
|
@@ -1536,6 +1973,17 @@ class DealsApi extends base_1.BaseAPI {
|
|
|
1536
1973
|
getArchivedDealsTimeline(requestParameters) {
|
|
1537
1974
|
return (0, exports.DealsApiFp)(this.configuration).getArchivedDealsTimeline(requestParameters.start_date, requestParameters.interval, requestParameters.amount, requestParameters.field_key, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.filter_id, requestParameters.exclude_deals, requestParameters.totals_convert_currency).then((request) => request(this.axios, this.basePath));
|
|
1538
1975
|
}
|
|
1976
|
+
/**
|
|
1977
|
+
* Same as `getArchivedDealsTimeline`, but resolves with the response body together with the HTTP status and headers.
|
|
1978
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1979
|
+
* @param {DealsApiGetArchivedDealsTimelineRequest} requestParameters Request parameters.
|
|
1980
|
+
* @deprecated
|
|
1981
|
+
* @throws {RequiredError}
|
|
1982
|
+
* @memberof DealsApi
|
|
1983
|
+
*/
|
|
1984
|
+
getArchivedDealsTimelineWithHttpInfo(requestParameters) {
|
|
1985
|
+
return (0, exports.DealsApiFp)(this.configuration).getArchivedDealsTimelineWithHttpInfo(requestParameters.start_date, requestParameters.interval, requestParameters.amount, requestParameters.field_key, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.filter_id, requestParameters.exclude_deals, requestParameters.totals_convert_currency).then((request) => request(this.axios, this.basePath));
|
|
1986
|
+
}
|
|
1539
1987
|
/**
|
|
1540
1988
|
* Lists updates about field values of a deal.
|
|
1541
1989
|
* @summary List updates about deal field values
|
|
@@ -1547,6 +1995,17 @@ class DealsApi extends base_1.BaseAPI {
|
|
|
1547
1995
|
getDealChangelog(requestParameters) {
|
|
1548
1996
|
return (0, exports.DealsApiFp)(this.configuration).getDealChangelog(requestParameters.id, requestParameters.cursor, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
|
1549
1997
|
}
|
|
1998
|
+
/**
|
|
1999
|
+
* Same as `getDealChangelog`, but resolves with the response body together with the HTTP status and headers.
|
|
2000
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
2001
|
+
* @param {DealsApiGetDealChangelogRequest} requestParameters Request parameters.
|
|
2002
|
+
|
|
2003
|
+
* @throws {RequiredError}
|
|
2004
|
+
* @memberof DealsApi
|
|
2005
|
+
*/
|
|
2006
|
+
getDealChangelogWithHttpInfo(requestParameters) {
|
|
2007
|
+
return (0, exports.DealsApiFp)(this.configuration).getDealChangelogWithHttpInfo(requestParameters.id, requestParameters.cursor, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
|
2008
|
+
}
|
|
1550
2009
|
/**
|
|
1551
2010
|
* Lists files associated with a deal.
|
|
1552
2011
|
* @summary List files attached to a deal
|
|
@@ -1558,6 +2017,17 @@ class DealsApi extends base_1.BaseAPI {
|
|
|
1558
2017
|
getDealFiles(requestParameters) {
|
|
1559
2018
|
return (0, exports.DealsApiFp)(this.configuration).getDealFiles(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.sort).then((request) => request(this.axios, this.basePath));
|
|
1560
2019
|
}
|
|
2020
|
+
/**
|
|
2021
|
+
* Same as `getDealFiles`, but resolves with the response body together with the HTTP status and headers.
|
|
2022
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
2023
|
+
* @param {DealsApiGetDealFilesRequest} requestParameters Request parameters.
|
|
2024
|
+
|
|
2025
|
+
* @throws {RequiredError}
|
|
2026
|
+
* @memberof DealsApi
|
|
2027
|
+
*/
|
|
2028
|
+
getDealFilesWithHttpInfo(requestParameters) {
|
|
2029
|
+
return (0, exports.DealsApiFp)(this.configuration).getDealFilesWithHttpInfo(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.sort).then((request) => request(this.axios, this.basePath));
|
|
2030
|
+
}
|
|
1561
2031
|
/**
|
|
1562
2032
|
* Lists the followers of a deal.
|
|
1563
2033
|
* @summary List followers of a deal
|
|
@@ -1569,6 +2039,17 @@ class DealsApi extends base_1.BaseAPI {
|
|
|
1569
2039
|
getDealFollowers(requestParameters) {
|
|
1570
2040
|
return (0, exports.DealsApiFp)(this.configuration).getDealFollowers(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
1571
2041
|
}
|
|
2042
|
+
/**
|
|
2043
|
+
* Same as `getDealFollowers`, but resolves with the response body together with the HTTP status and headers.
|
|
2044
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
2045
|
+
* @param {DealsApiGetDealFollowersRequest} requestParameters Request parameters.
|
|
2046
|
+
|
|
2047
|
+
* @throws {RequiredError}
|
|
2048
|
+
* @memberof DealsApi
|
|
2049
|
+
*/
|
|
2050
|
+
getDealFollowersWithHttpInfo(requestParameters) {
|
|
2051
|
+
return (0, exports.DealsApiFp)(this.configuration).getDealFollowersWithHttpInfo(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
2052
|
+
}
|
|
1572
2053
|
/**
|
|
1573
2054
|
* Lists mail messages associated with a deal.
|
|
1574
2055
|
* @summary List mail messages associated with a deal
|
|
@@ -1580,6 +2061,17 @@ class DealsApi extends base_1.BaseAPI {
|
|
|
1580
2061
|
getDealMailMessages(requestParameters) {
|
|
1581
2062
|
return (0, exports.DealsApiFp)(this.configuration).getDealMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.include_body).then((request) => request(this.axios, this.basePath));
|
|
1582
2063
|
}
|
|
2064
|
+
/**
|
|
2065
|
+
* Same as `getDealMailMessages`, but resolves with the response body together with the HTTP status and headers.
|
|
2066
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
2067
|
+
* @param {DealsApiGetDealMailMessagesRequest} requestParameters Request parameters.
|
|
2068
|
+
|
|
2069
|
+
* @throws {RequiredError}
|
|
2070
|
+
* @memberof DealsApi
|
|
2071
|
+
*/
|
|
2072
|
+
getDealMailMessagesWithHttpInfo(requestParameters) {
|
|
2073
|
+
return (0, exports.DealsApiFp)(this.configuration).getDealMailMessagesWithHttpInfo(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.include_body).then((request) => request(this.axios, this.basePath));
|
|
2074
|
+
}
|
|
1583
2075
|
/**
|
|
1584
2076
|
* Lists the participants associated with a deal.<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.
|
|
1585
2077
|
* @summary List participants of a deal
|
|
@@ -1591,6 +2083,17 @@ class DealsApi extends base_1.BaseAPI {
|
|
|
1591
2083
|
getDealParticipants(requestParameters) {
|
|
1592
2084
|
return (0, exports.DealsApiFp)(this.configuration).getDealParticipants(requestParameters.id, requestParameters.start, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
|
1593
2085
|
}
|
|
2086
|
+
/**
|
|
2087
|
+
* Same as `getDealParticipants`, but resolves with the response body together with the HTTP status and headers.
|
|
2088
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
2089
|
+
* @param {DealsApiGetDealParticipantsRequest} requestParameters Request parameters.
|
|
2090
|
+
|
|
2091
|
+
* @throws {RequiredError}
|
|
2092
|
+
* @memberof DealsApi
|
|
2093
|
+
*/
|
|
2094
|
+
getDealParticipantsWithHttpInfo(requestParameters) {
|
|
2095
|
+
return (0, exports.DealsApiFp)(this.configuration).getDealParticipantsWithHttpInfo(requestParameters.id, requestParameters.start, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
|
2096
|
+
}
|
|
1594
2097
|
/**
|
|
1595
2098
|
* List updates about participants of a deal. This is a cursor-paginated endpoint. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>.
|
|
1596
2099
|
* @summary List updates about participants of a deal
|
|
@@ -1602,6 +2105,17 @@ class DealsApi extends base_1.BaseAPI {
|
|
|
1602
2105
|
getDealParticipantsChangelog(requestParameters) {
|
|
1603
2106
|
return (0, exports.DealsApiFp)(this.configuration).getDealParticipantsChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
|
1604
2107
|
}
|
|
2108
|
+
/**
|
|
2109
|
+
* Same as `getDealParticipantsChangelog`, but resolves with the response body together with the HTTP status and headers.
|
|
2110
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
2111
|
+
* @param {DealsApiGetDealParticipantsChangelogRequest} requestParameters Request parameters.
|
|
2112
|
+
|
|
2113
|
+
* @throws {RequiredError}
|
|
2114
|
+
* @memberof DealsApi
|
|
2115
|
+
*/
|
|
2116
|
+
getDealParticipantsChangelogWithHttpInfo(requestParameters) {
|
|
2117
|
+
return (0, exports.DealsApiFp)(this.configuration).getDealParticipantsChangelogWithHttpInfo(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
|
2118
|
+
}
|
|
1605
2119
|
/**
|
|
1606
2120
|
* Lists updates about a deal.
|
|
1607
2121
|
* @summary List updates about a deal
|
|
@@ -1613,6 +2127,17 @@ class DealsApi extends base_1.BaseAPI {
|
|
|
1613
2127
|
getDealUpdates(requestParameters) {
|
|
1614
2128
|
return (0, exports.DealsApiFp)(this.configuration).getDealUpdates(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.all_changes, requestParameters.items).then((request) => request(this.axios, this.basePath));
|
|
1615
2129
|
}
|
|
2130
|
+
/**
|
|
2131
|
+
* Same as `getDealUpdates`, but resolves with the response body together with the HTTP status and headers.
|
|
2132
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
2133
|
+
* @param {DealsApiGetDealUpdatesRequest} requestParameters Request parameters.
|
|
2134
|
+
|
|
2135
|
+
* @throws {RequiredError}
|
|
2136
|
+
* @memberof DealsApi
|
|
2137
|
+
*/
|
|
2138
|
+
getDealUpdatesWithHttpInfo(requestParameters) {
|
|
2139
|
+
return (0, exports.DealsApiFp)(this.configuration).getDealUpdatesWithHttpInfo(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.all_changes, requestParameters.items).then((request) => request(this.axios, this.basePath));
|
|
2140
|
+
}
|
|
1616
2141
|
/**
|
|
1617
2142
|
* Lists the users permitted to access a deal.
|
|
1618
2143
|
* @summary List permitted users
|
|
@@ -1624,6 +2149,17 @@ class DealsApi extends base_1.BaseAPI {
|
|
|
1624
2149
|
getDealUsers(requestParameters) {
|
|
1625
2150
|
return (0, exports.DealsApiFp)(this.configuration).getDealUsers(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
1626
2151
|
}
|
|
2152
|
+
/**
|
|
2153
|
+
* Same as `getDealUsers`, but resolves with the response body together with the HTTP status and headers.
|
|
2154
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
2155
|
+
* @param {DealsApiGetDealUsersRequest} requestParameters Request parameters.
|
|
2156
|
+
|
|
2157
|
+
* @throws {RequiredError}
|
|
2158
|
+
* @memberof DealsApi
|
|
2159
|
+
*/
|
|
2160
|
+
getDealUsersWithHttpInfo(requestParameters) {
|
|
2161
|
+
return (0, exports.DealsApiFp)(this.configuration).getDealUsersWithHttpInfo(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
2162
|
+
}
|
|
1627
2163
|
/**
|
|
1628
2164
|
* Returns a summary of all not archived deals.
|
|
1629
2165
|
* @summary Get deals summary
|
|
@@ -1635,6 +2171,17 @@ class DealsApi extends base_1.BaseAPI {
|
|
|
1635
2171
|
getDealsSummary(requestParameters = {}) {
|
|
1636
2172
|
return (0, exports.DealsApiFp)(this.configuration).getDealsSummary(requestParameters.status, requestParameters.filter_id, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.stage_id).then((request) => request(this.axios, this.basePath));
|
|
1637
2173
|
}
|
|
2174
|
+
/**
|
|
2175
|
+
* Same as `getDealsSummary`, but resolves with the response body together with the HTTP status and headers.
|
|
2176
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
2177
|
+
* @param {DealsApiGetDealsSummaryRequest} requestParameters Request parameters.
|
|
2178
|
+
|
|
2179
|
+
* @throws {RequiredError}
|
|
2180
|
+
* @memberof DealsApi
|
|
2181
|
+
*/
|
|
2182
|
+
getDealsSummaryWithHttpInfo(requestParameters = {}) {
|
|
2183
|
+
return (0, exports.DealsApiFp)(this.configuration).getDealsSummaryWithHttpInfo(requestParameters.status, requestParameters.filter_id, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.stage_id).then((request) => request(this.axios, this.basePath));
|
|
2184
|
+
}
|
|
1638
2185
|
/**
|
|
1639
2186
|
* 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`.
|
|
1640
2187
|
* @summary Get deals timeline
|
|
@@ -1646,6 +2193,17 @@ class DealsApi extends base_1.BaseAPI {
|
|
|
1646
2193
|
getDealsTimeline(requestParameters) {
|
|
1647
2194
|
return (0, exports.DealsApiFp)(this.configuration).getDealsTimeline(requestParameters.start_date, requestParameters.interval, requestParameters.amount, requestParameters.field_key, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.filter_id, requestParameters.exclude_deals, requestParameters.totals_convert_currency).then((request) => request(this.axios, this.basePath));
|
|
1648
2195
|
}
|
|
2196
|
+
/**
|
|
2197
|
+
* Same as `getDealsTimeline`, but resolves with the response body together with the HTTP status and headers.
|
|
2198
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
2199
|
+
* @param {DealsApiGetDealsTimelineRequest} requestParameters Request parameters.
|
|
2200
|
+
|
|
2201
|
+
* @throws {RequiredError}
|
|
2202
|
+
* @memberof DealsApi
|
|
2203
|
+
*/
|
|
2204
|
+
getDealsTimelineWithHttpInfo(requestParameters) {
|
|
2205
|
+
return (0, exports.DealsApiFp)(this.configuration).getDealsTimelineWithHttpInfo(requestParameters.start_date, requestParameters.interval, requestParameters.amount, requestParameters.field_key, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.filter_id, requestParameters.exclude_deals, requestParameters.totals_convert_currency).then((request) => request(this.axios, this.basePath));
|
|
2206
|
+
}
|
|
1649
2207
|
/**
|
|
1650
2208
|
* Merges a deal with another deal. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/merging-two-deals\" target=\"_blank\" rel=\"noopener noreferrer\">merging two deals</a>.
|
|
1651
2209
|
* @summary Merge two deals
|
|
@@ -1657,5 +2215,16 @@ class DealsApi extends base_1.BaseAPI {
|
|
|
1657
2215
|
mergeDeals(requestParameters) {
|
|
1658
2216
|
return (0, exports.DealsApiFp)(this.configuration).mergeDeals(requestParameters.id, requestParameters.MergeDealsRequest).then((request) => request(this.axios, this.basePath));
|
|
1659
2217
|
}
|
|
2218
|
+
/**
|
|
2219
|
+
* Same as `mergeDeals`, but resolves with the response body together with the HTTP status and headers.
|
|
2220
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
2221
|
+
* @param {DealsApiMergeDealsRequest} requestParameters Request parameters.
|
|
2222
|
+
|
|
2223
|
+
* @throws {RequiredError}
|
|
2224
|
+
* @memberof DealsApi
|
|
2225
|
+
*/
|
|
2226
|
+
mergeDealsWithHttpInfo(requestParameters) {
|
|
2227
|
+
return (0, exports.DealsApiFp)(this.configuration).mergeDealsWithHttpInfo(requestParameters.id, requestParameters.MergeDealsRequest).then((request) => request(this.axios, this.basePath));
|
|
2228
|
+
}
|
|
1660
2229
|
}
|
|
1661
2230
|
exports.DealsApi = DealsApi;
|