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
|
@@ -942,6 +942,20 @@ export const DealsApiFp = function (configuration) {
|
|
|
942
942
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
943
943
|
});
|
|
944
944
|
},
|
|
945
|
+
/**
|
|
946
|
+
* Same as `addDealFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
947
|
+
* @summary Add a follower to a deal
|
|
948
|
+
* @param {number} id The ID of the deal
|
|
949
|
+
* @param {AddDealFollowerRequest} [AddDealFollowerRequest]
|
|
950
|
+
|
|
951
|
+
* @throws {RequiredError}
|
|
952
|
+
*/
|
|
953
|
+
addDealFollowerWithHttpInfo(id, AddDealFollowerRequest) {
|
|
954
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
955
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.addDealFollower(id, AddDealFollowerRequest);
|
|
956
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
957
|
+
});
|
|
958
|
+
},
|
|
945
959
|
/**
|
|
946
960
|
* Adds a participant to a deal.
|
|
947
961
|
* @summary Add a participant to a deal
|
|
@@ -956,6 +970,20 @@ export const DealsApiFp = function (configuration) {
|
|
|
956
970
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
957
971
|
});
|
|
958
972
|
},
|
|
973
|
+
/**
|
|
974
|
+
* Same as `addDealParticipant`, but resolves with the response body together with the HTTP status and headers.
|
|
975
|
+
* @summary Add a participant to a deal
|
|
976
|
+
* @param {number} id The ID of the deal
|
|
977
|
+
* @param {AddDealParticipantRequest} [AddDealParticipantRequest]
|
|
978
|
+
|
|
979
|
+
* @throws {RequiredError}
|
|
980
|
+
*/
|
|
981
|
+
addDealParticipantWithHttpInfo(id, AddDealParticipantRequest) {
|
|
982
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
983
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.addDealParticipant(id, AddDealParticipantRequest);
|
|
984
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
985
|
+
});
|
|
986
|
+
},
|
|
959
987
|
/**
|
|
960
988
|
* Deletes a follower from a deal.
|
|
961
989
|
* @summary Delete a follower from a deal
|
|
@@ -970,6 +998,20 @@ export const DealsApiFp = function (configuration) {
|
|
|
970
998
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
971
999
|
});
|
|
972
1000
|
},
|
|
1001
|
+
/**
|
|
1002
|
+
* Same as `deleteDealFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
1003
|
+
* @summary Delete a follower from a deal
|
|
1004
|
+
* @param {number} id The ID of the deal
|
|
1005
|
+
* @param {number} follower_id The ID of the relationship between the follower and the deal
|
|
1006
|
+
|
|
1007
|
+
* @throws {RequiredError}
|
|
1008
|
+
*/
|
|
1009
|
+
deleteDealFollowerWithHttpInfo(id, follower_id) {
|
|
1010
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1011
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteDealFollower(id, follower_id);
|
|
1012
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
1013
|
+
});
|
|
1014
|
+
},
|
|
973
1015
|
/**
|
|
974
1016
|
* Deletes a participant from a deal.
|
|
975
1017
|
* @summary Delete a participant from a deal
|
|
@@ -984,6 +1026,20 @@ export const DealsApiFp = function (configuration) {
|
|
|
984
1026
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
985
1027
|
});
|
|
986
1028
|
},
|
|
1029
|
+
/**
|
|
1030
|
+
* Same as `deleteDealParticipant`, but resolves with the response body together with the HTTP status and headers.
|
|
1031
|
+
* @summary Delete a participant from a deal
|
|
1032
|
+
* @param {number} id The ID of the deal
|
|
1033
|
+
* @param {number} deal_participant_id The ID of the participant of the deal
|
|
1034
|
+
|
|
1035
|
+
* @throws {RequiredError}
|
|
1036
|
+
*/
|
|
1037
|
+
deleteDealParticipantWithHttpInfo(id, deal_participant_id) {
|
|
1038
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1039
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteDealParticipant(id, deal_participant_id);
|
|
1040
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
1041
|
+
});
|
|
1042
|
+
},
|
|
987
1043
|
/**
|
|
988
1044
|
* Duplicates a deal.
|
|
989
1045
|
* @summary Duplicate deal
|
|
@@ -997,6 +1053,19 @@ export const DealsApiFp = function (configuration) {
|
|
|
997
1053
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
998
1054
|
});
|
|
999
1055
|
},
|
|
1056
|
+
/**
|
|
1057
|
+
* Same as `duplicateDeal`, but resolves with the response body together with the HTTP status and headers.
|
|
1058
|
+
* @summary Duplicate deal
|
|
1059
|
+
* @param {number} id The ID of the deal
|
|
1060
|
+
|
|
1061
|
+
* @throws {RequiredError}
|
|
1062
|
+
*/
|
|
1063
|
+
duplicateDealWithHttpInfo(id) {
|
|
1064
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1065
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.duplicateDeal(id);
|
|
1066
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
1067
|
+
});
|
|
1068
|
+
},
|
|
1000
1069
|
/**
|
|
1001
1070
|
* Returns all archived deals.
|
|
1002
1071
|
* @summary Get all archived deals
|
|
@@ -1021,6 +1090,30 @@ export const DealsApiFp = function (configuration) {
|
|
|
1021
1090
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1022
1091
|
});
|
|
1023
1092
|
},
|
|
1093
|
+
/**
|
|
1094
|
+
* Same as `getArchivedDeals`, but resolves with the response body together with the HTTP status and headers.
|
|
1095
|
+
* @summary Get all archived deals
|
|
1096
|
+
* @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.
|
|
1097
|
+
* @param {number} [filter_id] The ID of the filter to use
|
|
1098
|
+
* @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
|
|
1099
|
+
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
1100
|
+
* @param {number} [product_id] If supplied, only deals linked to the specified product are returned. If filter_id is provided, this is ignored.
|
|
1101
|
+
* @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
|
|
1102
|
+
* @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
|
|
1103
|
+
* @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.
|
|
1104
|
+
* @param {number} [start] Pagination start
|
|
1105
|
+
* @param {number} [limit] Items shown per page
|
|
1106
|
+
* @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).
|
|
1107
|
+
* @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.
|
|
1108
|
+
* @deprecated
|
|
1109
|
+
* @throws {RequiredError}
|
|
1110
|
+
*/
|
|
1111
|
+
getArchivedDealsWithHttpInfo(user_id, filter_id, person_id, org_id, product_id, pipeline_id, stage_id, status, start, limit, sort, owned_by_you) {
|
|
1112
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1113
|
+
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);
|
|
1114
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
1115
|
+
});
|
|
1116
|
+
},
|
|
1024
1117
|
/**
|
|
1025
1118
|
* Returns a summary of all archived deals.
|
|
1026
1119
|
* @summary Get archived deals summary
|
|
@@ -1038,6 +1131,23 @@ export const DealsApiFp = function (configuration) {
|
|
|
1038
1131
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1039
1132
|
});
|
|
1040
1133
|
},
|
|
1134
|
+
/**
|
|
1135
|
+
* Same as `getArchivedDealsSummary`, but resolves with the response body together with the HTTP status and headers.
|
|
1136
|
+
* @summary Get archived deals summary
|
|
1137
|
+
* @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.
|
|
1138
|
+
* @param {number} [filter_id] <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
|
|
1139
|
+
* @param {number} [user_id] Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.
|
|
1140
|
+
* @param {number} [pipeline_id] Only deals within the given pipeline will be returned
|
|
1141
|
+
* @param {number} [stage_id] Only deals within the given stage will be returned
|
|
1142
|
+
* @deprecated
|
|
1143
|
+
* @throws {RequiredError}
|
|
1144
|
+
*/
|
|
1145
|
+
getArchivedDealsSummaryWithHttpInfo(status, filter_id, user_id, pipeline_id, stage_id) {
|
|
1146
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1147
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getArchivedDealsSummary(status, filter_id, user_id, pipeline_id, stage_id);
|
|
1148
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
1149
|
+
});
|
|
1150
|
+
},
|
|
1041
1151
|
/**
|
|
1042
1152
|
* 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`.
|
|
1043
1153
|
* @summary Get archived deals timeline
|
|
@@ -1059,6 +1169,27 @@ export const DealsApiFp = function (configuration) {
|
|
|
1059
1169
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1060
1170
|
});
|
|
1061
1171
|
},
|
|
1172
|
+
/**
|
|
1173
|
+
* Same as `getArchivedDealsTimeline`, but resolves with the response body together with the HTTP status and headers.
|
|
1174
|
+
* @summary Get archived deals timeline
|
|
1175
|
+
* @param {string} start_date The date when the first interval starts. Format: YYYY-MM-DD.
|
|
1176
|
+
* @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>
|
|
1177
|
+
* @param {number} amount The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months).
|
|
1178
|
+
* @param {string} field_key The date field key which deals will be retrieved from
|
|
1179
|
+
* @param {number} [user_id] If supplied, only deals matching the given user will be returned
|
|
1180
|
+
* @param {number} [pipeline_id] If supplied, only deals matching the given pipeline will be returned
|
|
1181
|
+
* @param {number} [filter_id] If supplied, only deals matching the given filter will be returned
|
|
1182
|
+
* @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.
|
|
1183
|
+
* @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.
|
|
1184
|
+
* @deprecated
|
|
1185
|
+
* @throws {RequiredError}
|
|
1186
|
+
*/
|
|
1187
|
+
getArchivedDealsTimelineWithHttpInfo(start_date, interval, amount, field_key, user_id, pipeline_id, filter_id, exclude_deals, totals_convert_currency) {
|
|
1188
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1189
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getArchivedDealsTimeline(start_date, interval, amount, field_key, user_id, pipeline_id, filter_id, exclude_deals, totals_convert_currency);
|
|
1190
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
1191
|
+
});
|
|
1192
|
+
},
|
|
1062
1193
|
/**
|
|
1063
1194
|
* Lists updates about field values of a deal.
|
|
1064
1195
|
* @summary List updates about deal field values
|
|
@@ -1074,6 +1205,21 @@ export const DealsApiFp = function (configuration) {
|
|
|
1074
1205
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1075
1206
|
});
|
|
1076
1207
|
},
|
|
1208
|
+
/**
|
|
1209
|
+
* Same as `getDealChangelog`, but resolves with the response body together with the HTTP status and headers.
|
|
1210
|
+
* @summary List updates about deal field values
|
|
1211
|
+
* @param {number} id The ID of the deal
|
|
1212
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
1213
|
+
* @param {number} [limit] Items shown per page
|
|
1214
|
+
|
|
1215
|
+
* @throws {RequiredError}
|
|
1216
|
+
*/
|
|
1217
|
+
getDealChangelogWithHttpInfo(id, cursor, limit) {
|
|
1218
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1219
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealChangelog(id, cursor, limit);
|
|
1220
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
1221
|
+
});
|
|
1222
|
+
},
|
|
1077
1223
|
/**
|
|
1078
1224
|
* Lists files associated with a deal.
|
|
1079
1225
|
* @summary List files attached to a deal
|
|
@@ -1090,6 +1236,22 @@ export const DealsApiFp = function (configuration) {
|
|
|
1090
1236
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1091
1237
|
});
|
|
1092
1238
|
},
|
|
1239
|
+
/**
|
|
1240
|
+
* Same as `getDealFiles`, but resolves with the response body together with the HTTP status and headers.
|
|
1241
|
+
* @summary List files attached to a deal
|
|
1242
|
+
* @param {number} id The ID of the deal
|
|
1243
|
+
* @param {number} [start] Pagination start
|
|
1244
|
+
* @param {number} [limit] Items shown per page. Please note that a maximum value of 100 is allowed.
|
|
1245
|
+
* @param {string} [sort] Supported fields: `id`, `update_time`
|
|
1246
|
+
|
|
1247
|
+
* @throws {RequiredError}
|
|
1248
|
+
*/
|
|
1249
|
+
getDealFilesWithHttpInfo(id, start, limit, sort) {
|
|
1250
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1251
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealFiles(id, start, limit, sort);
|
|
1252
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
1253
|
+
});
|
|
1254
|
+
},
|
|
1093
1255
|
/**
|
|
1094
1256
|
* Lists the followers of a deal.
|
|
1095
1257
|
* @summary List followers of a deal
|
|
@@ -1103,6 +1265,19 @@ export const DealsApiFp = function (configuration) {
|
|
|
1103
1265
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1104
1266
|
});
|
|
1105
1267
|
},
|
|
1268
|
+
/**
|
|
1269
|
+
* Same as `getDealFollowers`, but resolves with the response body together with the HTTP status and headers.
|
|
1270
|
+
* @summary List followers of a deal
|
|
1271
|
+
* @param {number} id The ID of the deal
|
|
1272
|
+
|
|
1273
|
+
* @throws {RequiredError}
|
|
1274
|
+
*/
|
|
1275
|
+
getDealFollowersWithHttpInfo(id) {
|
|
1276
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1277
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealFollowers(id);
|
|
1278
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
1279
|
+
});
|
|
1280
|
+
},
|
|
1106
1281
|
/**
|
|
1107
1282
|
* Lists mail messages associated with a deal.
|
|
1108
1283
|
* @summary List mail messages associated with a deal
|
|
@@ -1119,6 +1294,22 @@ export const DealsApiFp = function (configuration) {
|
|
|
1119
1294
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1120
1295
|
});
|
|
1121
1296
|
},
|
|
1297
|
+
/**
|
|
1298
|
+
* Same as `getDealMailMessages`, but resolves with the response body together with the HTTP status and headers.
|
|
1299
|
+
* @summary List mail messages associated with a deal
|
|
1300
|
+
* @param {number} id The ID of the deal
|
|
1301
|
+
* @param {number} [start] Pagination start
|
|
1302
|
+
* @param {number} [limit] Items shown per page
|
|
1303
|
+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. `0` = Don\'t include, `1` = Include.
|
|
1304
|
+
|
|
1305
|
+
* @throws {RequiredError}
|
|
1306
|
+
*/
|
|
1307
|
+
getDealMailMessagesWithHttpInfo(id, start, limit, include_body) {
|
|
1308
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1309
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealMailMessages(id, start, limit, include_body);
|
|
1310
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
1311
|
+
});
|
|
1312
|
+
},
|
|
1122
1313
|
/**
|
|
1123
1314
|
* 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.
|
|
1124
1315
|
* @summary List participants of a deal
|
|
@@ -1134,6 +1325,21 @@ export const DealsApiFp = function (configuration) {
|
|
|
1134
1325
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1135
1326
|
});
|
|
1136
1327
|
},
|
|
1328
|
+
/**
|
|
1329
|
+
* Same as `getDealParticipants`, but resolves with the response body together with the HTTP status and headers.
|
|
1330
|
+
* @summary List participants of a deal
|
|
1331
|
+
* @param {number} id The ID of the deal
|
|
1332
|
+
* @param {number} [start] Pagination start
|
|
1333
|
+
* @param {number} [limit] Items shown per page
|
|
1334
|
+
|
|
1335
|
+
* @throws {RequiredError}
|
|
1336
|
+
*/
|
|
1337
|
+
getDealParticipantsWithHttpInfo(id, start, limit) {
|
|
1338
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1339
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealParticipants(id, start, limit);
|
|
1340
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
1341
|
+
});
|
|
1342
|
+
},
|
|
1137
1343
|
/**
|
|
1138
1344
|
* 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>.
|
|
1139
1345
|
* @summary List updates about participants of a deal
|
|
@@ -1149,6 +1355,21 @@ export const DealsApiFp = function (configuration) {
|
|
|
1149
1355
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1150
1356
|
});
|
|
1151
1357
|
},
|
|
1358
|
+
/**
|
|
1359
|
+
* Same as `getDealParticipantsChangelog`, but resolves with the response body together with the HTTP status and headers.
|
|
1360
|
+
* @summary List updates about participants of a deal
|
|
1361
|
+
* @param {number} id The ID of the deal
|
|
1362
|
+
* @param {number} [limit] Items shown per page
|
|
1363
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
1364
|
+
|
|
1365
|
+
* @throws {RequiredError}
|
|
1366
|
+
*/
|
|
1367
|
+
getDealParticipantsChangelogWithHttpInfo(id, limit, cursor) {
|
|
1368
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1369
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealParticipantsChangelog(id, limit, cursor);
|
|
1370
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
1371
|
+
});
|
|
1372
|
+
},
|
|
1152
1373
|
/**
|
|
1153
1374
|
* Lists updates about a deal.
|
|
1154
1375
|
* @summary List updates about a deal
|
|
@@ -1166,6 +1387,23 @@ export const DealsApiFp = function (configuration) {
|
|
|
1166
1387
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1167
1388
|
});
|
|
1168
1389
|
},
|
|
1390
|
+
/**
|
|
1391
|
+
* Same as `getDealUpdates`, but resolves with the response body together with the HTTP status and headers.
|
|
1392
|
+
* @summary List updates about a deal
|
|
1393
|
+
* @param {number} id The ID of the deal
|
|
1394
|
+
* @param {number} [start] Pagination start
|
|
1395
|
+
* @param {number} [limit] Items shown per page
|
|
1396
|
+
* @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.
|
|
1397
|
+
* @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).
|
|
1398
|
+
|
|
1399
|
+
* @throws {RequiredError}
|
|
1400
|
+
*/
|
|
1401
|
+
getDealUpdatesWithHttpInfo(id, start, limit, all_changes, items) {
|
|
1402
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1403
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealUpdates(id, start, limit, all_changes, items);
|
|
1404
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
1405
|
+
});
|
|
1406
|
+
},
|
|
1169
1407
|
/**
|
|
1170
1408
|
* Lists the users permitted to access a deal.
|
|
1171
1409
|
* @summary List permitted users
|
|
@@ -1179,6 +1417,19 @@ export const DealsApiFp = function (configuration) {
|
|
|
1179
1417
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1180
1418
|
});
|
|
1181
1419
|
},
|
|
1420
|
+
/**
|
|
1421
|
+
* Same as `getDealUsers`, but resolves with the response body together with the HTTP status and headers.
|
|
1422
|
+
* @summary List permitted users
|
|
1423
|
+
* @param {number} id The ID of the deal
|
|
1424
|
+
|
|
1425
|
+
* @throws {RequiredError}
|
|
1426
|
+
*/
|
|
1427
|
+
getDealUsersWithHttpInfo(id) {
|
|
1428
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1429
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealUsers(id);
|
|
1430
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
1431
|
+
});
|
|
1432
|
+
},
|
|
1182
1433
|
/**
|
|
1183
1434
|
* Returns a summary of all not archived deals.
|
|
1184
1435
|
* @summary Get deals summary
|
|
@@ -1196,6 +1447,23 @@ export const DealsApiFp = function (configuration) {
|
|
|
1196
1447
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1197
1448
|
});
|
|
1198
1449
|
},
|
|
1450
|
+
/**
|
|
1451
|
+
* Same as `getDealsSummary`, but resolves with the response body together with the HTTP status and headers.
|
|
1452
|
+
* @summary Get deals summary
|
|
1453
|
+
* @param {'open' | 'won' | 'lost'} [status] Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.
|
|
1454
|
+
* @param {number} [filter_id] <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
|
|
1455
|
+
* @param {number} [user_id] Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.
|
|
1456
|
+
* @param {number} [pipeline_id] Only deals within the given pipeline will be returned
|
|
1457
|
+
* @param {number} [stage_id] Only deals within the given stage will be returned
|
|
1458
|
+
|
|
1459
|
+
* @throws {RequiredError}
|
|
1460
|
+
*/
|
|
1461
|
+
getDealsSummaryWithHttpInfo(status, filter_id, user_id, pipeline_id, stage_id) {
|
|
1462
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1463
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealsSummary(status, filter_id, user_id, pipeline_id, stage_id);
|
|
1464
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
1465
|
+
});
|
|
1466
|
+
},
|
|
1199
1467
|
/**
|
|
1200
1468
|
* 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`.
|
|
1201
1469
|
* @summary Get deals timeline
|
|
@@ -1217,6 +1485,27 @@ export const DealsApiFp = function (configuration) {
|
|
|
1217
1485
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1218
1486
|
});
|
|
1219
1487
|
},
|
|
1488
|
+
/**
|
|
1489
|
+
* Same as `getDealsTimeline`, but resolves with the response body together with the HTTP status and headers.
|
|
1490
|
+
* @summary Get deals timeline
|
|
1491
|
+
* @param {string} start_date The date when the first interval starts. Format: YYYY-MM-DD.
|
|
1492
|
+
* @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>
|
|
1493
|
+
* @param {number} amount The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months).
|
|
1494
|
+
* @param {string} field_key The date field key which deals will be retrieved from
|
|
1495
|
+
* @param {number} [user_id] If supplied, only deals matching the given user will be returned
|
|
1496
|
+
* @param {number} [pipeline_id] If supplied, only deals matching the given pipeline will be returned
|
|
1497
|
+
* @param {number} [filter_id] If supplied, only deals matching the given filter will be returned
|
|
1498
|
+
* @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.
|
|
1499
|
+
* @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.
|
|
1500
|
+
|
|
1501
|
+
* @throws {RequiredError}
|
|
1502
|
+
*/
|
|
1503
|
+
getDealsTimelineWithHttpInfo(start_date, interval, amount, field_key, user_id, pipeline_id, filter_id, exclude_deals, totals_convert_currency) {
|
|
1504
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1505
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealsTimeline(start_date, interval, amount, field_key, user_id, pipeline_id, filter_id, exclude_deals, totals_convert_currency);
|
|
1506
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
1507
|
+
});
|
|
1508
|
+
},
|
|
1220
1509
|
/**
|
|
1221
1510
|
* 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>.
|
|
1222
1511
|
* @summary Merge two deals
|
|
@@ -1231,6 +1520,20 @@ export const DealsApiFp = function (configuration) {
|
|
|
1231
1520
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1232
1521
|
});
|
|
1233
1522
|
},
|
|
1523
|
+
/**
|
|
1524
|
+
* Same as `mergeDeals`, but resolves with the response body together with the HTTP status and headers.
|
|
1525
|
+
* @summary Merge two deals
|
|
1526
|
+
* @param {number} id The ID of the deal
|
|
1527
|
+
* @param {MergeDealsRequest} [MergeDealsRequest]
|
|
1528
|
+
|
|
1529
|
+
* @throws {RequiredError}
|
|
1530
|
+
*/
|
|
1531
|
+
mergeDealsWithHttpInfo(id, MergeDealsRequest) {
|
|
1532
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1533
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.mergeDeals(id, MergeDealsRequest);
|
|
1534
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
1535
|
+
});
|
|
1536
|
+
},
|
|
1234
1537
|
};
|
|
1235
1538
|
};
|
|
1236
1539
|
/**
|
|
@@ -1250,6 +1553,9 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1250
1553
|
addDealFollower(requestParameters) {
|
|
1251
1554
|
return localVarFp.addDealFollower(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(axios, basePath));
|
|
1252
1555
|
},
|
|
1556
|
+
addDealFollowerWithHttpInfo(requestParameters) {
|
|
1557
|
+
return localVarFp.addDealFollowerWithHttpInfo(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(axios, basePath));
|
|
1558
|
+
},
|
|
1253
1559
|
/**
|
|
1254
1560
|
* Adds a participant to a deal.
|
|
1255
1561
|
* @summary Add a participant to a deal
|
|
@@ -1260,6 +1566,9 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1260
1566
|
addDealParticipant(requestParameters) {
|
|
1261
1567
|
return localVarFp.addDealParticipant(requestParameters.id, requestParameters.AddDealParticipantRequest).then((request) => request(axios, basePath));
|
|
1262
1568
|
},
|
|
1569
|
+
addDealParticipantWithHttpInfo(requestParameters) {
|
|
1570
|
+
return localVarFp.addDealParticipantWithHttpInfo(requestParameters.id, requestParameters.AddDealParticipantRequest).then((request) => request(axios, basePath));
|
|
1571
|
+
},
|
|
1263
1572
|
/**
|
|
1264
1573
|
* Deletes a follower from a deal.
|
|
1265
1574
|
* @summary Delete a follower from a deal
|
|
@@ -1270,6 +1579,9 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1270
1579
|
deleteDealFollower(requestParameters) {
|
|
1271
1580
|
return localVarFp.deleteDealFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(axios, basePath));
|
|
1272
1581
|
},
|
|
1582
|
+
deleteDealFollowerWithHttpInfo(requestParameters) {
|
|
1583
|
+
return localVarFp.deleteDealFollowerWithHttpInfo(requestParameters.id, requestParameters.follower_id).then((request) => request(axios, basePath));
|
|
1584
|
+
},
|
|
1273
1585
|
/**
|
|
1274
1586
|
* Deletes a participant from a deal.
|
|
1275
1587
|
* @summary Delete a participant from a deal
|
|
@@ -1280,6 +1592,9 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1280
1592
|
deleteDealParticipant(requestParameters) {
|
|
1281
1593
|
return localVarFp.deleteDealParticipant(requestParameters.id, requestParameters.deal_participant_id).then((request) => request(axios, basePath));
|
|
1282
1594
|
},
|
|
1595
|
+
deleteDealParticipantWithHttpInfo(requestParameters) {
|
|
1596
|
+
return localVarFp.deleteDealParticipantWithHttpInfo(requestParameters.id, requestParameters.deal_participant_id).then((request) => request(axios, basePath));
|
|
1597
|
+
},
|
|
1283
1598
|
/**
|
|
1284
1599
|
* Duplicates a deal.
|
|
1285
1600
|
* @summary Duplicate deal
|
|
@@ -1290,6 +1605,9 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1290
1605
|
duplicateDeal(requestParameters) {
|
|
1291
1606
|
return localVarFp.duplicateDeal(requestParameters.id).then((request) => request(axios, basePath));
|
|
1292
1607
|
},
|
|
1608
|
+
duplicateDealWithHttpInfo(requestParameters) {
|
|
1609
|
+
return localVarFp.duplicateDealWithHttpInfo(requestParameters.id).then((request) => request(axios, basePath));
|
|
1610
|
+
},
|
|
1293
1611
|
/**
|
|
1294
1612
|
* Returns all archived deals.
|
|
1295
1613
|
* @summary Get all archived deals
|
|
@@ -1300,6 +1618,9 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1300
1618
|
getArchivedDeals(requestParameters = {}) {
|
|
1301
1619
|
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));
|
|
1302
1620
|
},
|
|
1621
|
+
getArchivedDealsWithHttpInfo(requestParameters = {}) {
|
|
1622
|
+
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));
|
|
1623
|
+
},
|
|
1303
1624
|
/**
|
|
1304
1625
|
* Returns a summary of all archived deals.
|
|
1305
1626
|
* @summary Get archived deals summary
|
|
@@ -1310,6 +1631,9 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1310
1631
|
getArchivedDealsSummary(requestParameters = {}) {
|
|
1311
1632
|
return localVarFp.getArchivedDealsSummary(requestParameters.status, requestParameters.filter_id, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.stage_id).then((request) => request(axios, basePath));
|
|
1312
1633
|
},
|
|
1634
|
+
getArchivedDealsSummaryWithHttpInfo(requestParameters = {}) {
|
|
1635
|
+
return localVarFp.getArchivedDealsSummaryWithHttpInfo(requestParameters.status, requestParameters.filter_id, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.stage_id).then((request) => request(axios, basePath));
|
|
1636
|
+
},
|
|
1313
1637
|
/**
|
|
1314
1638
|
* 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`.
|
|
1315
1639
|
* @summary Get archived deals timeline
|
|
@@ -1320,6 +1644,9 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1320
1644
|
getArchivedDealsTimeline(requestParameters) {
|
|
1321
1645
|
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));
|
|
1322
1646
|
},
|
|
1647
|
+
getArchivedDealsTimelineWithHttpInfo(requestParameters) {
|
|
1648
|
+
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));
|
|
1649
|
+
},
|
|
1323
1650
|
/**
|
|
1324
1651
|
* Lists updates about field values of a deal.
|
|
1325
1652
|
* @summary List updates about deal field values
|
|
@@ -1330,6 +1657,9 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1330
1657
|
getDealChangelog(requestParameters) {
|
|
1331
1658
|
return localVarFp.getDealChangelog(requestParameters.id, requestParameters.cursor, requestParameters.limit).then((request) => request(axios, basePath));
|
|
1332
1659
|
},
|
|
1660
|
+
getDealChangelogWithHttpInfo(requestParameters) {
|
|
1661
|
+
return localVarFp.getDealChangelogWithHttpInfo(requestParameters.id, requestParameters.cursor, requestParameters.limit).then((request) => request(axios, basePath));
|
|
1662
|
+
},
|
|
1333
1663
|
/**
|
|
1334
1664
|
* Lists files associated with a deal.
|
|
1335
1665
|
* @summary List files attached to a deal
|
|
@@ -1340,6 +1670,9 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1340
1670
|
getDealFiles(requestParameters) {
|
|
1341
1671
|
return localVarFp.getDealFiles(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.sort).then((request) => request(axios, basePath));
|
|
1342
1672
|
},
|
|
1673
|
+
getDealFilesWithHttpInfo(requestParameters) {
|
|
1674
|
+
return localVarFp.getDealFilesWithHttpInfo(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.sort).then((request) => request(axios, basePath));
|
|
1675
|
+
},
|
|
1343
1676
|
/**
|
|
1344
1677
|
* Lists the followers of a deal.
|
|
1345
1678
|
* @summary List followers of a deal
|
|
@@ -1350,6 +1683,9 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1350
1683
|
getDealFollowers(requestParameters) {
|
|
1351
1684
|
return localVarFp.getDealFollowers(requestParameters.id).then((request) => request(axios, basePath));
|
|
1352
1685
|
},
|
|
1686
|
+
getDealFollowersWithHttpInfo(requestParameters) {
|
|
1687
|
+
return localVarFp.getDealFollowersWithHttpInfo(requestParameters.id).then((request) => request(axios, basePath));
|
|
1688
|
+
},
|
|
1353
1689
|
/**
|
|
1354
1690
|
* Lists mail messages associated with a deal.
|
|
1355
1691
|
* @summary List mail messages associated with a deal
|
|
@@ -1360,6 +1696,9 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1360
1696
|
getDealMailMessages(requestParameters) {
|
|
1361
1697
|
return localVarFp.getDealMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.include_body).then((request) => request(axios, basePath));
|
|
1362
1698
|
},
|
|
1699
|
+
getDealMailMessagesWithHttpInfo(requestParameters) {
|
|
1700
|
+
return localVarFp.getDealMailMessagesWithHttpInfo(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.include_body).then((request) => request(axios, basePath));
|
|
1701
|
+
},
|
|
1363
1702
|
/**
|
|
1364
1703
|
* 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.
|
|
1365
1704
|
* @summary List participants of a deal
|
|
@@ -1370,6 +1709,9 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1370
1709
|
getDealParticipants(requestParameters) {
|
|
1371
1710
|
return localVarFp.getDealParticipants(requestParameters.id, requestParameters.start, requestParameters.limit).then((request) => request(axios, basePath));
|
|
1372
1711
|
},
|
|
1712
|
+
getDealParticipantsWithHttpInfo(requestParameters) {
|
|
1713
|
+
return localVarFp.getDealParticipantsWithHttpInfo(requestParameters.id, requestParameters.start, requestParameters.limit).then((request) => request(axios, basePath));
|
|
1714
|
+
},
|
|
1373
1715
|
/**
|
|
1374
1716
|
* 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>.
|
|
1375
1717
|
* @summary List updates about participants of a deal
|
|
@@ -1380,6 +1722,9 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1380
1722
|
getDealParticipantsChangelog(requestParameters) {
|
|
1381
1723
|
return localVarFp.getDealParticipantsChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
|
1382
1724
|
},
|
|
1725
|
+
getDealParticipantsChangelogWithHttpInfo(requestParameters) {
|
|
1726
|
+
return localVarFp.getDealParticipantsChangelogWithHttpInfo(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
|
1727
|
+
},
|
|
1383
1728
|
/**
|
|
1384
1729
|
* Lists updates about a deal.
|
|
1385
1730
|
* @summary List updates about a deal
|
|
@@ -1390,6 +1735,9 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1390
1735
|
getDealUpdates(requestParameters) {
|
|
1391
1736
|
return localVarFp.getDealUpdates(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.all_changes, requestParameters.items).then((request) => request(axios, basePath));
|
|
1392
1737
|
},
|
|
1738
|
+
getDealUpdatesWithHttpInfo(requestParameters) {
|
|
1739
|
+
return localVarFp.getDealUpdatesWithHttpInfo(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.all_changes, requestParameters.items).then((request) => request(axios, basePath));
|
|
1740
|
+
},
|
|
1393
1741
|
/**
|
|
1394
1742
|
* Lists the users permitted to access a deal.
|
|
1395
1743
|
* @summary List permitted users
|
|
@@ -1400,6 +1748,9 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1400
1748
|
getDealUsers(requestParameters) {
|
|
1401
1749
|
return localVarFp.getDealUsers(requestParameters.id).then((request) => request(axios, basePath));
|
|
1402
1750
|
},
|
|
1751
|
+
getDealUsersWithHttpInfo(requestParameters) {
|
|
1752
|
+
return localVarFp.getDealUsersWithHttpInfo(requestParameters.id).then((request) => request(axios, basePath));
|
|
1753
|
+
},
|
|
1403
1754
|
/**
|
|
1404
1755
|
* Returns a summary of all not archived deals.
|
|
1405
1756
|
* @summary Get deals summary
|
|
@@ -1410,6 +1761,9 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1410
1761
|
getDealsSummary(requestParameters = {}) {
|
|
1411
1762
|
return localVarFp.getDealsSummary(requestParameters.status, requestParameters.filter_id, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.stage_id).then((request) => request(axios, basePath));
|
|
1412
1763
|
},
|
|
1764
|
+
getDealsSummaryWithHttpInfo(requestParameters = {}) {
|
|
1765
|
+
return localVarFp.getDealsSummaryWithHttpInfo(requestParameters.status, requestParameters.filter_id, requestParameters.user_id, requestParameters.pipeline_id, requestParameters.stage_id).then((request) => request(axios, basePath));
|
|
1766
|
+
},
|
|
1413
1767
|
/**
|
|
1414
1768
|
* 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`.
|
|
1415
1769
|
* @summary Get deals timeline
|
|
@@ -1420,6 +1774,9 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1420
1774
|
getDealsTimeline(requestParameters) {
|
|
1421
1775
|
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));
|
|
1422
1776
|
},
|
|
1777
|
+
getDealsTimelineWithHttpInfo(requestParameters) {
|
|
1778
|
+
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));
|
|
1779
|
+
},
|
|
1423
1780
|
/**
|
|
1424
1781
|
* 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>.
|
|
1425
1782
|
* @summary Merge two deals
|
|
@@ -1430,6 +1787,9 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1430
1787
|
mergeDeals(requestParameters) {
|
|
1431
1788
|
return localVarFp.mergeDeals(requestParameters.id, requestParameters.MergeDealsRequest).then((request) => request(axios, basePath));
|
|
1432
1789
|
},
|
|
1790
|
+
mergeDealsWithHttpInfo(requestParameters) {
|
|
1791
|
+
return localVarFp.mergeDealsWithHttpInfo(requestParameters.id, requestParameters.MergeDealsRequest).then((request) => request(axios, basePath));
|
|
1792
|
+
},
|
|
1433
1793
|
};
|
|
1434
1794
|
};
|
|
1435
1795
|
/**
|
|
@@ -1450,6 +1810,17 @@ export class DealsApi extends BaseAPI {
|
|
|
1450
1810
|
addDealFollower(requestParameters) {
|
|
1451
1811
|
return DealsApiFp(this.configuration).addDealFollower(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(this.axios, this.basePath));
|
|
1452
1812
|
}
|
|
1813
|
+
/**
|
|
1814
|
+
* Same as `addDealFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
1815
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1816
|
+
* @param {DealsApiAddDealFollowerRequest} requestParameters Request parameters.
|
|
1817
|
+
|
|
1818
|
+
* @throws {RequiredError}
|
|
1819
|
+
* @memberof DealsApi
|
|
1820
|
+
*/
|
|
1821
|
+
addDealFollowerWithHttpInfo(requestParameters) {
|
|
1822
|
+
return DealsApiFp(this.configuration).addDealFollowerWithHttpInfo(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(this.axios, this.basePath));
|
|
1823
|
+
}
|
|
1453
1824
|
/**
|
|
1454
1825
|
* Adds a participant to a deal.
|
|
1455
1826
|
* @summary Add a participant to a deal
|
|
@@ -1461,6 +1832,17 @@ export class DealsApi extends BaseAPI {
|
|
|
1461
1832
|
addDealParticipant(requestParameters) {
|
|
1462
1833
|
return DealsApiFp(this.configuration).addDealParticipant(requestParameters.id, requestParameters.AddDealParticipantRequest).then((request) => request(this.axios, this.basePath));
|
|
1463
1834
|
}
|
|
1835
|
+
/**
|
|
1836
|
+
* Same as `addDealParticipant`, but resolves with the response body together with the HTTP status and headers.
|
|
1837
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1838
|
+
* @param {DealsApiAddDealParticipantRequest} requestParameters Request parameters.
|
|
1839
|
+
|
|
1840
|
+
* @throws {RequiredError}
|
|
1841
|
+
* @memberof DealsApi
|
|
1842
|
+
*/
|
|
1843
|
+
addDealParticipantWithHttpInfo(requestParameters) {
|
|
1844
|
+
return DealsApiFp(this.configuration).addDealParticipantWithHttpInfo(requestParameters.id, requestParameters.AddDealParticipantRequest).then((request) => request(this.axios, this.basePath));
|
|
1845
|
+
}
|
|
1464
1846
|
/**
|
|
1465
1847
|
* Deletes a follower from a deal.
|
|
1466
1848
|
* @summary Delete a follower from a deal
|
|
@@ -1472,6 +1854,17 @@ export class DealsApi extends BaseAPI {
|
|
|
1472
1854
|
deleteDealFollower(requestParameters) {
|
|
1473
1855
|
return DealsApiFp(this.configuration).deleteDealFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(this.axios, this.basePath));
|
|
1474
1856
|
}
|
|
1857
|
+
/**
|
|
1858
|
+
* Same as `deleteDealFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
1859
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1860
|
+
* @param {DealsApiDeleteDealFollowerRequest} requestParameters Request parameters.
|
|
1861
|
+
|
|
1862
|
+
* @throws {RequiredError}
|
|
1863
|
+
* @memberof DealsApi
|
|
1864
|
+
*/
|
|
1865
|
+
deleteDealFollowerWithHttpInfo(requestParameters) {
|
|
1866
|
+
return DealsApiFp(this.configuration).deleteDealFollowerWithHttpInfo(requestParameters.id, requestParameters.follower_id).then((request) => request(this.axios, this.basePath));
|
|
1867
|
+
}
|
|
1475
1868
|
/**
|
|
1476
1869
|
* Deletes a participant from a deal.
|
|
1477
1870
|
* @summary Delete a participant from a deal
|
|
@@ -1483,6 +1876,17 @@ export class DealsApi extends BaseAPI {
|
|
|
1483
1876
|
deleteDealParticipant(requestParameters) {
|
|
1484
1877
|
return DealsApiFp(this.configuration).deleteDealParticipant(requestParameters.id, requestParameters.deal_participant_id).then((request) => request(this.axios, this.basePath));
|
|
1485
1878
|
}
|
|
1879
|
+
/**
|
|
1880
|
+
* Same as `deleteDealParticipant`, but resolves with the response body together with the HTTP status and headers.
|
|
1881
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1882
|
+
* @param {DealsApiDeleteDealParticipantRequest} requestParameters Request parameters.
|
|
1883
|
+
|
|
1884
|
+
* @throws {RequiredError}
|
|
1885
|
+
* @memberof DealsApi
|
|
1886
|
+
*/
|
|
1887
|
+
deleteDealParticipantWithHttpInfo(requestParameters) {
|
|
1888
|
+
return DealsApiFp(this.configuration).deleteDealParticipantWithHttpInfo(requestParameters.id, requestParameters.deal_participant_id).then((request) => request(this.axios, this.basePath));
|
|
1889
|
+
}
|
|
1486
1890
|
/**
|
|
1487
1891
|
* Duplicates a deal.
|
|
1488
1892
|
* @summary Duplicate deal
|
|
@@ -1494,6 +1898,17 @@ export class DealsApi extends BaseAPI {
|
|
|
1494
1898
|
duplicateDeal(requestParameters) {
|
|
1495
1899
|
return DealsApiFp(this.configuration).duplicateDeal(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
1496
1900
|
}
|
|
1901
|
+
/**
|
|
1902
|
+
* Same as `duplicateDeal`, but resolves with the response body together with the HTTP status and headers.
|
|
1903
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1904
|
+
* @param {DealsApiDuplicateDealRequest} requestParameters Request parameters.
|
|
1905
|
+
|
|
1906
|
+
* @throws {RequiredError}
|
|
1907
|
+
* @memberof DealsApi
|
|
1908
|
+
*/
|
|
1909
|
+
duplicateDealWithHttpInfo(requestParameters) {
|
|
1910
|
+
return DealsApiFp(this.configuration).duplicateDealWithHttpInfo(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
1911
|
+
}
|
|
1497
1912
|
/**
|
|
1498
1913
|
* Returns all archived deals.
|
|
1499
1914
|
* @summary Get all archived deals
|
|
@@ -1505,6 +1920,17 @@ export class DealsApi extends BaseAPI {
|
|
|
1505
1920
|
getArchivedDeals(requestParameters = {}) {
|
|
1506
1921
|
return 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));
|
|
1507
1922
|
}
|
|
1923
|
+
/**
|
|
1924
|
+
* Same as `getArchivedDeals`, but resolves with the response body together with the HTTP status and headers.
|
|
1925
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1926
|
+
* @param {DealsApiGetArchivedDealsRequest} requestParameters Request parameters.
|
|
1927
|
+
* @deprecated
|
|
1928
|
+
* @throws {RequiredError}
|
|
1929
|
+
* @memberof DealsApi
|
|
1930
|
+
*/
|
|
1931
|
+
getArchivedDealsWithHttpInfo(requestParameters = {}) {
|
|
1932
|
+
return 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));
|
|
1933
|
+
}
|
|
1508
1934
|
/**
|
|
1509
1935
|
* Returns a summary of all archived deals.
|
|
1510
1936
|
* @summary Get archived deals summary
|
|
@@ -1516,6 +1942,17 @@ export class DealsApi extends BaseAPI {
|
|
|
1516
1942
|
getArchivedDealsSummary(requestParameters = {}) {
|
|
1517
1943
|
return 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));
|
|
1518
1944
|
}
|
|
1945
|
+
/**
|
|
1946
|
+
* Same as `getArchivedDealsSummary`, but resolves with the response body together with the HTTP status and headers.
|
|
1947
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1948
|
+
* @param {DealsApiGetArchivedDealsSummaryRequest} requestParameters Request parameters.
|
|
1949
|
+
* @deprecated
|
|
1950
|
+
* @throws {RequiredError}
|
|
1951
|
+
* @memberof DealsApi
|
|
1952
|
+
*/
|
|
1953
|
+
getArchivedDealsSummaryWithHttpInfo(requestParameters = {}) {
|
|
1954
|
+
return 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));
|
|
1955
|
+
}
|
|
1519
1956
|
/**
|
|
1520
1957
|
* 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`.
|
|
1521
1958
|
* @summary Get archived deals timeline
|
|
@@ -1527,6 +1964,17 @@ export class DealsApi extends BaseAPI {
|
|
|
1527
1964
|
getArchivedDealsTimeline(requestParameters) {
|
|
1528
1965
|
return 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));
|
|
1529
1966
|
}
|
|
1967
|
+
/**
|
|
1968
|
+
* Same as `getArchivedDealsTimeline`, but resolves with the response body together with the HTTP status and headers.
|
|
1969
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1970
|
+
* @param {DealsApiGetArchivedDealsTimelineRequest} requestParameters Request parameters.
|
|
1971
|
+
* @deprecated
|
|
1972
|
+
* @throws {RequiredError}
|
|
1973
|
+
* @memberof DealsApi
|
|
1974
|
+
*/
|
|
1975
|
+
getArchivedDealsTimelineWithHttpInfo(requestParameters) {
|
|
1976
|
+
return 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));
|
|
1977
|
+
}
|
|
1530
1978
|
/**
|
|
1531
1979
|
* Lists updates about field values of a deal.
|
|
1532
1980
|
* @summary List updates about deal field values
|
|
@@ -1538,6 +1986,17 @@ export class DealsApi extends BaseAPI {
|
|
|
1538
1986
|
getDealChangelog(requestParameters) {
|
|
1539
1987
|
return DealsApiFp(this.configuration).getDealChangelog(requestParameters.id, requestParameters.cursor, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
|
1540
1988
|
}
|
|
1989
|
+
/**
|
|
1990
|
+
* Same as `getDealChangelog`, but resolves with the response body together with the HTTP status and headers.
|
|
1991
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1992
|
+
* @param {DealsApiGetDealChangelogRequest} requestParameters Request parameters.
|
|
1993
|
+
|
|
1994
|
+
* @throws {RequiredError}
|
|
1995
|
+
* @memberof DealsApi
|
|
1996
|
+
*/
|
|
1997
|
+
getDealChangelogWithHttpInfo(requestParameters) {
|
|
1998
|
+
return DealsApiFp(this.configuration).getDealChangelogWithHttpInfo(requestParameters.id, requestParameters.cursor, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
|
1999
|
+
}
|
|
1541
2000
|
/**
|
|
1542
2001
|
* Lists files associated with a deal.
|
|
1543
2002
|
* @summary List files attached to a deal
|
|
@@ -1549,6 +2008,17 @@ export class DealsApi extends BaseAPI {
|
|
|
1549
2008
|
getDealFiles(requestParameters) {
|
|
1550
2009
|
return DealsApiFp(this.configuration).getDealFiles(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.sort).then((request) => request(this.axios, this.basePath));
|
|
1551
2010
|
}
|
|
2011
|
+
/**
|
|
2012
|
+
* Same as `getDealFiles`, but resolves with the response body together with the HTTP status and headers.
|
|
2013
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
2014
|
+
* @param {DealsApiGetDealFilesRequest} requestParameters Request parameters.
|
|
2015
|
+
|
|
2016
|
+
* @throws {RequiredError}
|
|
2017
|
+
* @memberof DealsApi
|
|
2018
|
+
*/
|
|
2019
|
+
getDealFilesWithHttpInfo(requestParameters) {
|
|
2020
|
+
return DealsApiFp(this.configuration).getDealFilesWithHttpInfo(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.sort).then((request) => request(this.axios, this.basePath));
|
|
2021
|
+
}
|
|
1552
2022
|
/**
|
|
1553
2023
|
* Lists the followers of a deal.
|
|
1554
2024
|
* @summary List followers of a deal
|
|
@@ -1560,6 +2030,17 @@ export class DealsApi extends BaseAPI {
|
|
|
1560
2030
|
getDealFollowers(requestParameters) {
|
|
1561
2031
|
return DealsApiFp(this.configuration).getDealFollowers(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
1562
2032
|
}
|
|
2033
|
+
/**
|
|
2034
|
+
* Same as `getDealFollowers`, but resolves with the response body together with the HTTP status and headers.
|
|
2035
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
2036
|
+
* @param {DealsApiGetDealFollowersRequest} requestParameters Request parameters.
|
|
2037
|
+
|
|
2038
|
+
* @throws {RequiredError}
|
|
2039
|
+
* @memberof DealsApi
|
|
2040
|
+
*/
|
|
2041
|
+
getDealFollowersWithHttpInfo(requestParameters) {
|
|
2042
|
+
return DealsApiFp(this.configuration).getDealFollowersWithHttpInfo(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
2043
|
+
}
|
|
1563
2044
|
/**
|
|
1564
2045
|
* Lists mail messages associated with a deal.
|
|
1565
2046
|
* @summary List mail messages associated with a deal
|
|
@@ -1571,6 +2052,17 @@ export class DealsApi extends BaseAPI {
|
|
|
1571
2052
|
getDealMailMessages(requestParameters) {
|
|
1572
2053
|
return DealsApiFp(this.configuration).getDealMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.include_body).then((request) => request(this.axios, this.basePath));
|
|
1573
2054
|
}
|
|
2055
|
+
/**
|
|
2056
|
+
* Same as `getDealMailMessages`, but resolves with the response body together with the HTTP status and headers.
|
|
2057
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
2058
|
+
* @param {DealsApiGetDealMailMessagesRequest} requestParameters Request parameters.
|
|
2059
|
+
|
|
2060
|
+
* @throws {RequiredError}
|
|
2061
|
+
* @memberof DealsApi
|
|
2062
|
+
*/
|
|
2063
|
+
getDealMailMessagesWithHttpInfo(requestParameters) {
|
|
2064
|
+
return DealsApiFp(this.configuration).getDealMailMessagesWithHttpInfo(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.include_body).then((request) => request(this.axios, this.basePath));
|
|
2065
|
+
}
|
|
1574
2066
|
/**
|
|
1575
2067
|
* 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.
|
|
1576
2068
|
* @summary List participants of a deal
|
|
@@ -1582,6 +2074,17 @@ export class DealsApi extends BaseAPI {
|
|
|
1582
2074
|
getDealParticipants(requestParameters) {
|
|
1583
2075
|
return DealsApiFp(this.configuration).getDealParticipants(requestParameters.id, requestParameters.start, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
|
1584
2076
|
}
|
|
2077
|
+
/**
|
|
2078
|
+
* Same as `getDealParticipants`, but resolves with the response body together with the HTTP status and headers.
|
|
2079
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
2080
|
+
* @param {DealsApiGetDealParticipantsRequest} requestParameters Request parameters.
|
|
2081
|
+
|
|
2082
|
+
* @throws {RequiredError}
|
|
2083
|
+
* @memberof DealsApi
|
|
2084
|
+
*/
|
|
2085
|
+
getDealParticipantsWithHttpInfo(requestParameters) {
|
|
2086
|
+
return DealsApiFp(this.configuration).getDealParticipantsWithHttpInfo(requestParameters.id, requestParameters.start, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
|
2087
|
+
}
|
|
1585
2088
|
/**
|
|
1586
2089
|
* 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>.
|
|
1587
2090
|
* @summary List updates about participants of a deal
|
|
@@ -1593,6 +2096,17 @@ export class DealsApi extends BaseAPI {
|
|
|
1593
2096
|
getDealParticipantsChangelog(requestParameters) {
|
|
1594
2097
|
return DealsApiFp(this.configuration).getDealParticipantsChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
|
1595
2098
|
}
|
|
2099
|
+
/**
|
|
2100
|
+
* Same as `getDealParticipantsChangelog`, but resolves with the response body together with the HTTP status and headers.
|
|
2101
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
2102
|
+
* @param {DealsApiGetDealParticipantsChangelogRequest} requestParameters Request parameters.
|
|
2103
|
+
|
|
2104
|
+
* @throws {RequiredError}
|
|
2105
|
+
* @memberof DealsApi
|
|
2106
|
+
*/
|
|
2107
|
+
getDealParticipantsChangelogWithHttpInfo(requestParameters) {
|
|
2108
|
+
return DealsApiFp(this.configuration).getDealParticipantsChangelogWithHttpInfo(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
|
2109
|
+
}
|
|
1596
2110
|
/**
|
|
1597
2111
|
* Lists updates about a deal.
|
|
1598
2112
|
* @summary List updates about a deal
|
|
@@ -1604,6 +2118,17 @@ export class DealsApi extends BaseAPI {
|
|
|
1604
2118
|
getDealUpdates(requestParameters) {
|
|
1605
2119
|
return DealsApiFp(this.configuration).getDealUpdates(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.all_changes, requestParameters.items).then((request) => request(this.axios, this.basePath));
|
|
1606
2120
|
}
|
|
2121
|
+
/**
|
|
2122
|
+
* Same as `getDealUpdates`, but resolves with the response body together with the HTTP status and headers.
|
|
2123
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
2124
|
+
* @param {DealsApiGetDealUpdatesRequest} requestParameters Request parameters.
|
|
2125
|
+
|
|
2126
|
+
* @throws {RequiredError}
|
|
2127
|
+
* @memberof DealsApi
|
|
2128
|
+
*/
|
|
2129
|
+
getDealUpdatesWithHttpInfo(requestParameters) {
|
|
2130
|
+
return DealsApiFp(this.configuration).getDealUpdatesWithHttpInfo(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.all_changes, requestParameters.items).then((request) => request(this.axios, this.basePath));
|
|
2131
|
+
}
|
|
1607
2132
|
/**
|
|
1608
2133
|
* Lists the users permitted to access a deal.
|
|
1609
2134
|
* @summary List permitted users
|
|
@@ -1615,6 +2140,17 @@ export class DealsApi extends BaseAPI {
|
|
|
1615
2140
|
getDealUsers(requestParameters) {
|
|
1616
2141
|
return DealsApiFp(this.configuration).getDealUsers(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
1617
2142
|
}
|
|
2143
|
+
/**
|
|
2144
|
+
* Same as `getDealUsers`, but resolves with the response body together with the HTTP status and headers.
|
|
2145
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
2146
|
+
* @param {DealsApiGetDealUsersRequest} requestParameters Request parameters.
|
|
2147
|
+
|
|
2148
|
+
* @throws {RequiredError}
|
|
2149
|
+
* @memberof DealsApi
|
|
2150
|
+
*/
|
|
2151
|
+
getDealUsersWithHttpInfo(requestParameters) {
|
|
2152
|
+
return DealsApiFp(this.configuration).getDealUsersWithHttpInfo(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
2153
|
+
}
|
|
1618
2154
|
/**
|
|
1619
2155
|
* Returns a summary of all not archived deals.
|
|
1620
2156
|
* @summary Get deals summary
|
|
@@ -1626,6 +2162,17 @@ export class DealsApi extends BaseAPI {
|
|
|
1626
2162
|
getDealsSummary(requestParameters = {}) {
|
|
1627
2163
|
return 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));
|
|
1628
2164
|
}
|
|
2165
|
+
/**
|
|
2166
|
+
* Same as `getDealsSummary`, but resolves with the response body together with the HTTP status and headers.
|
|
2167
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
2168
|
+
* @param {DealsApiGetDealsSummaryRequest} requestParameters Request parameters.
|
|
2169
|
+
|
|
2170
|
+
* @throws {RequiredError}
|
|
2171
|
+
* @memberof DealsApi
|
|
2172
|
+
*/
|
|
2173
|
+
getDealsSummaryWithHttpInfo(requestParameters = {}) {
|
|
2174
|
+
return 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));
|
|
2175
|
+
}
|
|
1629
2176
|
/**
|
|
1630
2177
|
* 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`.
|
|
1631
2178
|
* @summary Get deals timeline
|
|
@@ -1637,6 +2184,17 @@ export class DealsApi extends BaseAPI {
|
|
|
1637
2184
|
getDealsTimeline(requestParameters) {
|
|
1638
2185
|
return 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));
|
|
1639
2186
|
}
|
|
2187
|
+
/**
|
|
2188
|
+
* Same as `getDealsTimeline`, but resolves with the response body together with the HTTP status and headers.
|
|
2189
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
2190
|
+
* @param {DealsApiGetDealsTimelineRequest} requestParameters Request parameters.
|
|
2191
|
+
|
|
2192
|
+
* @throws {RequiredError}
|
|
2193
|
+
* @memberof DealsApi
|
|
2194
|
+
*/
|
|
2195
|
+
getDealsTimelineWithHttpInfo(requestParameters) {
|
|
2196
|
+
return 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));
|
|
2197
|
+
}
|
|
1640
2198
|
/**
|
|
1641
2199
|
* 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>.
|
|
1642
2200
|
* @summary Merge two deals
|
|
@@ -1648,4 +2206,15 @@ export class DealsApi extends BaseAPI {
|
|
|
1648
2206
|
mergeDeals(requestParameters) {
|
|
1649
2207
|
return DealsApiFp(this.configuration).mergeDeals(requestParameters.id, requestParameters.MergeDealsRequest).then((request) => request(this.axios, this.basePath));
|
|
1650
2208
|
}
|
|
2209
|
+
/**
|
|
2210
|
+
* Same as `mergeDeals`, but resolves with the response body together with the HTTP status and headers.
|
|
2211
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
2212
|
+
* @param {DealsApiMergeDealsRequest} requestParameters Request parameters.
|
|
2213
|
+
|
|
2214
|
+
* @throws {RequiredError}
|
|
2215
|
+
* @memberof DealsApi
|
|
2216
|
+
*/
|
|
2217
|
+
mergeDealsWithHttpInfo(requestParameters) {
|
|
2218
|
+
return DealsApiFp(this.configuration).mergeDealsWithHttpInfo(requestParameters.id, requestParameters.MergeDealsRequest).then((request) => request(this.axios, this.basePath));
|
|
2219
|
+
}
|
|
1651
2220
|
}
|