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
|
@@ -112,6 +112,22 @@ const RecentsApiFp = function (configuration) {
|
|
|
112
112
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
113
113
|
});
|
|
114
114
|
},
|
|
115
|
+
/**
|
|
116
|
+
* Same as `getRecents`, but resolves with the response body together with the HTTP status and headers.
|
|
117
|
+
* @summary Get recents
|
|
118
|
+
* @param {string} since_timestamp The timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS.
|
|
119
|
+
* @param {'activity' | 'activityType' | 'deal' | 'file' | 'filter' | 'note' | 'person' | 'organization' | 'pipeline' | 'product' | 'stage' | 'user'} [items] Multiple selection of item types to include in the query (optional)
|
|
120
|
+
* @param {number} [start] Pagination start
|
|
121
|
+
* @param {number} [limit] Items shown per page
|
|
122
|
+
|
|
123
|
+
* @throws {RequiredError}
|
|
124
|
+
*/
|
|
125
|
+
getRecentsWithHttpInfo(since_timestamp, items, start, limit) {
|
|
126
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
127
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getRecents(since_timestamp, items, start, limit);
|
|
128
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
|
|
129
|
+
});
|
|
130
|
+
},
|
|
115
131
|
};
|
|
116
132
|
};
|
|
117
133
|
exports.RecentsApiFp = RecentsApiFp;
|
|
@@ -132,6 +148,9 @@ const RecentsApiFactory = function (configuration, basePath, axios) {
|
|
|
132
148
|
getRecents(requestParameters) {
|
|
133
149
|
return localVarFp.getRecents(requestParameters.since_timestamp, requestParameters.items, requestParameters.start, requestParameters.limit).then((request) => request(axios, basePath));
|
|
134
150
|
},
|
|
151
|
+
getRecentsWithHttpInfo(requestParameters) {
|
|
152
|
+
return localVarFp.getRecentsWithHttpInfo(requestParameters.since_timestamp, requestParameters.items, requestParameters.start, requestParameters.limit).then((request) => request(axios, basePath));
|
|
153
|
+
},
|
|
135
154
|
};
|
|
136
155
|
};
|
|
137
156
|
exports.RecentsApiFactory = RecentsApiFactory;
|
|
@@ -153,5 +172,16 @@ class RecentsApi extends base_1.BaseAPI {
|
|
|
153
172
|
getRecents(requestParameters) {
|
|
154
173
|
return (0, exports.RecentsApiFp)(this.configuration).getRecents(requestParameters.since_timestamp, requestParameters.items, requestParameters.start, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
|
155
174
|
}
|
|
175
|
+
/**
|
|
176
|
+
* Same as `getRecents`, but resolves with the response body together with the HTTP status and headers.
|
|
177
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
178
|
+
* @param {RecentsApiGetRecentsRequest} requestParameters Request parameters.
|
|
179
|
+
|
|
180
|
+
* @throws {RequiredError}
|
|
181
|
+
* @memberof RecentsApi
|
|
182
|
+
*/
|
|
183
|
+
getRecentsWithHttpInfo(requestParameters) {
|
|
184
|
+
return (0, exports.RecentsApiFp)(this.configuration).getRecentsWithHttpInfo(requestParameters.since_timestamp, requestParameters.items, requestParameters.start, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
|
185
|
+
}
|
|
156
186
|
}
|
|
157
187
|
exports.RecentsApi = RecentsApi;
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { Configuration } from '../configuration';
|
|
13
13
|
import type { AxiosInstance } from 'axios';
|
|
14
|
-
import { RequestArgs, BaseAPI } from '../base';
|
|
14
|
+
import { RequestArgs, BaseAPI, ApiResponse } from '../base';
|
|
15
15
|
import { AddOrUpdateRoleSettingRequest } from '../models';
|
|
16
16
|
import { AddRoleAssignmentRequest } from '../models';
|
|
17
17
|
import { AddRoleAssignmentResponse } from '../models';
|
|
@@ -154,6 +154,15 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
|
|
|
154
154
|
* @throws {RequiredError}
|
|
155
155
|
*/
|
|
156
156
|
addOrUpdateRoleSetting(id: number, AddOrUpdateRoleSettingRequest?: AddOrUpdateRoleSettingRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertRoleSettingsResponse>>;
|
|
157
|
+
/**
|
|
158
|
+
* Same as `addOrUpdateRoleSetting`, but resolves with the response body together with the HTTP status and headers.
|
|
159
|
+
* @summary Add or update role setting
|
|
160
|
+
* @param {number} id The ID of the role
|
|
161
|
+
* @param {AddOrUpdateRoleSettingRequest} [AddOrUpdateRoleSettingRequest]
|
|
162
|
+
|
|
163
|
+
* @throws {RequiredError}
|
|
164
|
+
*/
|
|
165
|
+
addOrUpdateRoleSettingWithHttpInfo(id: number, AddOrUpdateRoleSettingRequest?: AddOrUpdateRoleSettingRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<UpsertRoleSettingsResponse>>>;
|
|
157
166
|
/**
|
|
158
167
|
* Adds a new role.
|
|
159
168
|
* @summary Add a role
|
|
@@ -162,6 +171,14 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
|
|
|
162
171
|
* @throws {RequiredError}
|
|
163
172
|
*/
|
|
164
173
|
addRole(AddRoleRequest?: AddRoleRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddRolesResponse>>;
|
|
174
|
+
/**
|
|
175
|
+
* Same as `addRole`, but resolves with the response body together with the HTTP status and headers.
|
|
176
|
+
* @summary Add a role
|
|
177
|
+
* @param {AddRoleRequest} [AddRoleRequest]
|
|
178
|
+
|
|
179
|
+
* @throws {RequiredError}
|
|
180
|
+
*/
|
|
181
|
+
addRoleWithHttpInfo(AddRoleRequest?: AddRoleRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddRolesResponse>>>;
|
|
165
182
|
/**
|
|
166
183
|
* Assigns a user to a role.
|
|
167
184
|
* @summary Add role assignment
|
|
@@ -171,6 +188,15 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
|
|
|
171
188
|
* @throws {RequiredError}
|
|
172
189
|
*/
|
|
173
190
|
addRoleAssignment(id: number, AddRoleAssignmentRequest?: AddRoleAssignmentRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddRoleAssignmentResponse>>;
|
|
191
|
+
/**
|
|
192
|
+
* Same as `addRoleAssignment`, but resolves with the response body together with the HTTP status and headers.
|
|
193
|
+
* @summary Add role assignment
|
|
194
|
+
* @param {number} id The ID of the role
|
|
195
|
+
* @param {AddRoleAssignmentRequest} [AddRoleAssignmentRequest]
|
|
196
|
+
|
|
197
|
+
* @throws {RequiredError}
|
|
198
|
+
*/
|
|
199
|
+
addRoleAssignmentWithHttpInfo(id: number, AddRoleAssignmentRequest?: AddRoleAssignmentRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddRoleAssignmentResponse>>>;
|
|
174
200
|
/**
|
|
175
201
|
* Marks a role as deleted.
|
|
176
202
|
* @summary Delete a role
|
|
@@ -179,6 +205,14 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
|
|
|
179
205
|
* @throws {RequiredError}
|
|
180
206
|
*/
|
|
181
207
|
deleteRole(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteRoleResponse>>;
|
|
208
|
+
/**
|
|
209
|
+
* Same as `deleteRole`, but resolves with the response body together with the HTTP status and headers.
|
|
210
|
+
* @summary Delete a role
|
|
211
|
+
* @param {number} id The ID of the role
|
|
212
|
+
|
|
213
|
+
* @throws {RequiredError}
|
|
214
|
+
*/
|
|
215
|
+
deleteRoleWithHttpInfo(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<DeleteRoleResponse>>>;
|
|
182
216
|
/**
|
|
183
217
|
* Removes the assigned user from a role and adds to the default role.
|
|
184
218
|
* @summary Delete a role assignment
|
|
@@ -188,6 +222,15 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
|
|
|
188
222
|
* @throws {RequiredError}
|
|
189
223
|
*/
|
|
190
224
|
deleteRoleAssignment(id: number, DeleteRoleAssignmentRequest?: DeleteRoleAssignmentRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteRoleAssignmentResponse>>;
|
|
225
|
+
/**
|
|
226
|
+
* Same as `deleteRoleAssignment`, but resolves with the response body together with the HTTP status and headers.
|
|
227
|
+
* @summary Delete a role assignment
|
|
228
|
+
* @param {number} id The ID of the role
|
|
229
|
+
* @param {DeleteRoleAssignmentRequest} [DeleteRoleAssignmentRequest]
|
|
230
|
+
|
|
231
|
+
* @throws {RequiredError}
|
|
232
|
+
*/
|
|
233
|
+
deleteRoleAssignmentWithHttpInfo(id: number, DeleteRoleAssignmentRequest?: DeleteRoleAssignmentRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<DeleteRoleAssignmentResponse>>>;
|
|
191
234
|
/**
|
|
192
235
|
* Returns the details of a specific role.
|
|
193
236
|
* @summary Get one role
|
|
@@ -196,6 +239,14 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
|
|
|
196
239
|
* @throws {RequiredError}
|
|
197
240
|
*/
|
|
198
241
|
getRole(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetRoleResponse>>;
|
|
242
|
+
/**
|
|
243
|
+
* Same as `getRole`, but resolves with the response body together with the HTTP status and headers.
|
|
244
|
+
* @summary Get one role
|
|
245
|
+
* @param {number} id The ID of the role
|
|
246
|
+
|
|
247
|
+
* @throws {RequiredError}
|
|
248
|
+
*/
|
|
249
|
+
getRoleWithHttpInfo(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetRoleResponse>>>;
|
|
199
250
|
/**
|
|
200
251
|
* Returns all users assigned to a role.
|
|
201
252
|
* @summary List role assignments
|
|
@@ -206,6 +257,16 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
|
|
|
206
257
|
* @throws {RequiredError}
|
|
207
258
|
*/
|
|
208
259
|
getRoleAssignments(id: number, start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetRoleAssignmentsResponse>>;
|
|
260
|
+
/**
|
|
261
|
+
* Same as `getRoleAssignments`, but resolves with the response body together with the HTTP status and headers.
|
|
262
|
+
* @summary List role assignments
|
|
263
|
+
* @param {number} id The ID of the role
|
|
264
|
+
* @param {number} [start] Pagination start
|
|
265
|
+
* @param {number} [limit] Items shown per page
|
|
266
|
+
|
|
267
|
+
* @throws {RequiredError}
|
|
268
|
+
*/
|
|
269
|
+
getRoleAssignmentsWithHttpInfo(id: number, start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetRoleAssignmentsResponse>>>;
|
|
209
270
|
/**
|
|
210
271
|
* Returns the list of either visible or hidden pipeline IDs for a specific role. For more information on pipeline visibility, please refer to the <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">Visibility groups article</a>.
|
|
211
272
|
* @summary List pipeline visibility for a role
|
|
@@ -215,6 +276,15 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
|
|
|
215
276
|
* @throws {RequiredError}
|
|
216
277
|
*/
|
|
217
278
|
getRolePipelines(id: number, visible?: boolean): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetRolePipelinesResponse>>;
|
|
279
|
+
/**
|
|
280
|
+
* Same as `getRolePipelines`, but resolves with the response body together with the HTTP status and headers.
|
|
281
|
+
* @summary List pipeline visibility for a role
|
|
282
|
+
* @param {number} id The ID of the role
|
|
283
|
+
* @param {boolean} [visible] Whether to return the visible or hidden pipelines for the role
|
|
284
|
+
|
|
285
|
+
* @throws {RequiredError}
|
|
286
|
+
*/
|
|
287
|
+
getRolePipelinesWithHttpInfo(id: number, visible?: boolean): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetRolePipelinesResponse>>>;
|
|
218
288
|
/**
|
|
219
289
|
* Returns the visibility settings of a specific role.
|
|
220
290
|
* @summary List role settings
|
|
@@ -223,6 +293,14 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
|
|
|
223
293
|
* @throws {RequiredError}
|
|
224
294
|
*/
|
|
225
295
|
getRoleSettings(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetRoleSettingsResponse>>;
|
|
296
|
+
/**
|
|
297
|
+
* Same as `getRoleSettings`, but resolves with the response body together with the HTTP status and headers.
|
|
298
|
+
* @summary List role settings
|
|
299
|
+
* @param {number} id The ID of the role
|
|
300
|
+
|
|
301
|
+
* @throws {RequiredError}
|
|
302
|
+
*/
|
|
303
|
+
getRoleSettingsWithHttpInfo(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetRoleSettingsResponse>>>;
|
|
226
304
|
/**
|
|
227
305
|
* Returns all the roles within the company.
|
|
228
306
|
* @summary Get all roles
|
|
@@ -232,6 +310,15 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
|
|
|
232
310
|
* @throws {RequiredError}
|
|
233
311
|
*/
|
|
234
312
|
getRoles(start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetRolesResponse>>;
|
|
313
|
+
/**
|
|
314
|
+
* Same as `getRoles`, but resolves with the response body together with the HTTP status and headers.
|
|
315
|
+
* @summary Get all roles
|
|
316
|
+
* @param {number} [start] Pagination start
|
|
317
|
+
* @param {number} [limit] Items shown per page
|
|
318
|
+
|
|
319
|
+
* @throws {RequiredError}
|
|
320
|
+
*/
|
|
321
|
+
getRolesWithHttpInfo(start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetRolesResponse>>>;
|
|
235
322
|
/**
|
|
236
323
|
* Updates the parent role and/or the name of a specific role.
|
|
237
324
|
* @summary Update role details
|
|
@@ -241,6 +328,15 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
|
|
|
241
328
|
* @throws {RequiredError}
|
|
242
329
|
*/
|
|
243
330
|
updateRole(id: number, BaseRoleRequest?: BaseRoleRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpdateRoleResponse>>;
|
|
331
|
+
/**
|
|
332
|
+
* Same as `updateRole`, but resolves with the response body together with the HTTP status and headers.
|
|
333
|
+
* @summary Update role details
|
|
334
|
+
* @param {number} id The ID of the role
|
|
335
|
+
* @param {BaseRoleRequest} [BaseRoleRequest]
|
|
336
|
+
|
|
337
|
+
* @throws {RequiredError}
|
|
338
|
+
*/
|
|
339
|
+
updateRoleWithHttpInfo(id: number, BaseRoleRequest?: BaseRoleRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<UpdateRoleResponse>>>;
|
|
244
340
|
/**
|
|
245
341
|
* Updates the specified pipelines to be visible and/or hidden for a specific role. For more information on pipeline visibility, please refer to the <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">Visibility groups article</a>.
|
|
246
342
|
* @summary Update pipeline visibility for a role
|
|
@@ -250,6 +346,15 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
|
|
|
250
346
|
* @throws {RequiredError}
|
|
251
347
|
*/
|
|
252
348
|
updateRolePipelines(id: number, PutRolePipelinesBody?: PutRolePipelinesBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetRolePipelinesResponse>>;
|
|
349
|
+
/**
|
|
350
|
+
* Same as `updateRolePipelines`, but resolves with the response body together with the HTTP status and headers.
|
|
351
|
+
* @summary Update pipeline visibility for a role
|
|
352
|
+
* @param {number} id The ID of the role
|
|
353
|
+
* @param {PutRolePipelinesBody} [PutRolePipelinesBody]
|
|
354
|
+
|
|
355
|
+
* @throws {RequiredError}
|
|
356
|
+
*/
|
|
357
|
+
updateRolePipelinesWithHttpInfo(id: number, PutRolePipelinesBody?: PutRolePipelinesBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetRolePipelinesResponse>>>;
|
|
253
358
|
};
|
|
254
359
|
/**
|
|
255
360
|
* RolesApi - factory interface
|
|
@@ -264,6 +369,7 @@ export declare const RolesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
264
369
|
* @throws {RequiredError}
|
|
265
370
|
*/
|
|
266
371
|
addOrUpdateRoleSetting(requestParameters: RolesApiAddOrUpdateRoleSettingRequest): Promise<UpsertRoleSettingsResponse>;
|
|
372
|
+
addOrUpdateRoleSettingWithHttpInfo(requestParameters: RolesApiAddOrUpdateRoleSettingRequest): Promise<ApiResponse<UpsertRoleSettingsResponse>>;
|
|
267
373
|
/**
|
|
268
374
|
* Adds a new role.
|
|
269
375
|
* @summary Add a role
|
|
@@ -272,6 +378,7 @@ export declare const RolesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
272
378
|
* @throws {RequiredError}
|
|
273
379
|
*/
|
|
274
380
|
addRole(requestParameters?: RolesApiAddRoleRequest): Promise<AddRolesResponse>;
|
|
381
|
+
addRoleWithHttpInfo(requestParameters?: RolesApiAddRoleRequest): Promise<ApiResponse<AddRolesResponse>>;
|
|
275
382
|
/**
|
|
276
383
|
* Assigns a user to a role.
|
|
277
384
|
* @summary Add role assignment
|
|
@@ -280,6 +387,7 @@ export declare const RolesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
280
387
|
* @throws {RequiredError}
|
|
281
388
|
*/
|
|
282
389
|
addRoleAssignment(requestParameters: RolesApiAddRoleAssignmentRequest): Promise<AddRoleAssignmentResponse>;
|
|
390
|
+
addRoleAssignmentWithHttpInfo(requestParameters: RolesApiAddRoleAssignmentRequest): Promise<ApiResponse<AddRoleAssignmentResponse>>;
|
|
283
391
|
/**
|
|
284
392
|
* Marks a role as deleted.
|
|
285
393
|
* @summary Delete a role
|
|
@@ -288,6 +396,7 @@ export declare const RolesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
288
396
|
* @throws {RequiredError}
|
|
289
397
|
*/
|
|
290
398
|
deleteRole(requestParameters: RolesApiDeleteRoleRequest): Promise<DeleteRoleResponse>;
|
|
399
|
+
deleteRoleWithHttpInfo(requestParameters: RolesApiDeleteRoleRequest): Promise<ApiResponse<DeleteRoleResponse>>;
|
|
291
400
|
/**
|
|
292
401
|
* Removes the assigned user from a role and adds to the default role.
|
|
293
402
|
* @summary Delete a role assignment
|
|
@@ -296,6 +405,7 @@ export declare const RolesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
296
405
|
* @throws {RequiredError}
|
|
297
406
|
*/
|
|
298
407
|
deleteRoleAssignment(requestParameters: RolesApiDeleteRoleAssignmentRequest): Promise<DeleteRoleAssignmentResponse>;
|
|
408
|
+
deleteRoleAssignmentWithHttpInfo(requestParameters: RolesApiDeleteRoleAssignmentRequest): Promise<ApiResponse<DeleteRoleAssignmentResponse>>;
|
|
299
409
|
/**
|
|
300
410
|
* Returns the details of a specific role.
|
|
301
411
|
* @summary Get one role
|
|
@@ -304,6 +414,7 @@ export declare const RolesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
304
414
|
* @throws {RequiredError}
|
|
305
415
|
*/
|
|
306
416
|
getRole(requestParameters: RolesApiGetRoleRequest): Promise<GetRoleResponse>;
|
|
417
|
+
getRoleWithHttpInfo(requestParameters: RolesApiGetRoleRequest): Promise<ApiResponse<GetRoleResponse>>;
|
|
307
418
|
/**
|
|
308
419
|
* Returns all users assigned to a role.
|
|
309
420
|
* @summary List role assignments
|
|
@@ -312,6 +423,7 @@ export declare const RolesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
312
423
|
* @throws {RequiredError}
|
|
313
424
|
*/
|
|
314
425
|
getRoleAssignments(requestParameters: RolesApiGetRoleAssignmentsRequest): Promise<GetRoleAssignmentsResponse>;
|
|
426
|
+
getRoleAssignmentsWithHttpInfo(requestParameters: RolesApiGetRoleAssignmentsRequest): Promise<ApiResponse<GetRoleAssignmentsResponse>>;
|
|
315
427
|
/**
|
|
316
428
|
* Returns the list of either visible or hidden pipeline IDs for a specific role. For more information on pipeline visibility, please refer to the <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">Visibility groups article</a>.
|
|
317
429
|
* @summary List pipeline visibility for a role
|
|
@@ -320,6 +432,7 @@ export declare const RolesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
320
432
|
* @throws {RequiredError}
|
|
321
433
|
*/
|
|
322
434
|
getRolePipelines(requestParameters: RolesApiGetRolePipelinesRequest): Promise<GetRolePipelinesResponse>;
|
|
435
|
+
getRolePipelinesWithHttpInfo(requestParameters: RolesApiGetRolePipelinesRequest): Promise<ApiResponse<GetRolePipelinesResponse>>;
|
|
323
436
|
/**
|
|
324
437
|
* Returns the visibility settings of a specific role.
|
|
325
438
|
* @summary List role settings
|
|
@@ -328,6 +441,7 @@ export declare const RolesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
328
441
|
* @throws {RequiredError}
|
|
329
442
|
*/
|
|
330
443
|
getRoleSettings(requestParameters: RolesApiGetRoleSettingsRequest): Promise<GetRoleSettingsResponse>;
|
|
444
|
+
getRoleSettingsWithHttpInfo(requestParameters: RolesApiGetRoleSettingsRequest): Promise<ApiResponse<GetRoleSettingsResponse>>;
|
|
331
445
|
/**
|
|
332
446
|
* Returns all the roles within the company.
|
|
333
447
|
* @summary Get all roles
|
|
@@ -336,6 +450,7 @@ export declare const RolesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
336
450
|
* @throws {RequiredError}
|
|
337
451
|
*/
|
|
338
452
|
getRoles(requestParameters?: RolesApiGetRolesRequest): Promise<GetRolesResponse>;
|
|
453
|
+
getRolesWithHttpInfo(requestParameters?: RolesApiGetRolesRequest): Promise<ApiResponse<GetRolesResponse>>;
|
|
339
454
|
/**
|
|
340
455
|
* Updates the parent role and/or the name of a specific role.
|
|
341
456
|
* @summary Update role details
|
|
@@ -344,6 +459,7 @@ export declare const RolesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
344
459
|
* @throws {RequiredError}
|
|
345
460
|
*/
|
|
346
461
|
updateRole(requestParameters: RolesApiUpdateRoleRequest): Promise<UpdateRoleResponse>;
|
|
462
|
+
updateRoleWithHttpInfo(requestParameters: RolesApiUpdateRoleRequest): Promise<ApiResponse<UpdateRoleResponse>>;
|
|
347
463
|
/**
|
|
348
464
|
* Updates the specified pipelines to be visible and/or hidden for a specific role. For more information on pipeline visibility, please refer to the <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">Visibility groups article</a>.
|
|
349
465
|
* @summary Update pipeline visibility for a role
|
|
@@ -352,6 +468,7 @@ export declare const RolesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
352
468
|
* @throws {RequiredError}
|
|
353
469
|
*/
|
|
354
470
|
updateRolePipelines(requestParameters: RolesApiUpdateRolePipelinesRequest): Promise<GetRolePipelinesResponse>;
|
|
471
|
+
updateRolePipelinesWithHttpInfo(requestParameters: RolesApiUpdateRolePipelinesRequest): Promise<ApiResponse<GetRolePipelinesResponse>>;
|
|
355
472
|
};
|
|
356
473
|
/**
|
|
357
474
|
* Request parameters for addOrUpdateRoleSetting operation in RolesApi.
|
|
@@ -579,6 +696,15 @@ export declare class RolesApi extends BaseAPI {
|
|
|
579
696
|
* @memberof RolesApi
|
|
580
697
|
*/
|
|
581
698
|
addOrUpdateRoleSetting(requestParameters: RolesApiAddOrUpdateRoleSettingRequest): Promise<UpsertRoleSettingsResponse>;
|
|
699
|
+
/**
|
|
700
|
+
* Same as `addOrUpdateRoleSetting`, but resolves with the response body together with the HTTP status and headers.
|
|
701
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
702
|
+
* @param {RolesApiAddOrUpdateRoleSettingRequest} requestParameters Request parameters.
|
|
703
|
+
|
|
704
|
+
* @throws {RequiredError}
|
|
705
|
+
* @memberof RolesApi
|
|
706
|
+
*/
|
|
707
|
+
addOrUpdateRoleSettingWithHttpInfo(requestParameters: RolesApiAddOrUpdateRoleSettingRequest): Promise<ApiResponse<UpsertRoleSettingsResponse>>;
|
|
582
708
|
/**
|
|
583
709
|
* Adds a new role.
|
|
584
710
|
* @summary Add a role
|
|
@@ -588,6 +714,15 @@ export declare class RolesApi extends BaseAPI {
|
|
|
588
714
|
* @memberof RolesApi
|
|
589
715
|
*/
|
|
590
716
|
addRole(requestParameters?: RolesApiAddRoleRequest): Promise<AddRolesResponse>;
|
|
717
|
+
/**
|
|
718
|
+
* Same as `addRole`, but resolves with the response body together with the HTTP status and headers.
|
|
719
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
720
|
+
* @param {RolesApiAddRoleRequest} requestParameters Request parameters.
|
|
721
|
+
|
|
722
|
+
* @throws {RequiredError}
|
|
723
|
+
* @memberof RolesApi
|
|
724
|
+
*/
|
|
725
|
+
addRoleWithHttpInfo(requestParameters?: RolesApiAddRoleRequest): Promise<ApiResponse<AddRolesResponse>>;
|
|
591
726
|
/**
|
|
592
727
|
* Assigns a user to a role.
|
|
593
728
|
* @summary Add role assignment
|
|
@@ -597,6 +732,15 @@ export declare class RolesApi extends BaseAPI {
|
|
|
597
732
|
* @memberof RolesApi
|
|
598
733
|
*/
|
|
599
734
|
addRoleAssignment(requestParameters: RolesApiAddRoleAssignmentRequest): Promise<AddRoleAssignmentResponse>;
|
|
735
|
+
/**
|
|
736
|
+
* Same as `addRoleAssignment`, but resolves with the response body together with the HTTP status and headers.
|
|
737
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
738
|
+
* @param {RolesApiAddRoleAssignmentRequest} requestParameters Request parameters.
|
|
739
|
+
|
|
740
|
+
* @throws {RequiredError}
|
|
741
|
+
* @memberof RolesApi
|
|
742
|
+
*/
|
|
743
|
+
addRoleAssignmentWithHttpInfo(requestParameters: RolesApiAddRoleAssignmentRequest): Promise<ApiResponse<AddRoleAssignmentResponse>>;
|
|
600
744
|
/**
|
|
601
745
|
* Marks a role as deleted.
|
|
602
746
|
* @summary Delete a role
|
|
@@ -606,6 +750,15 @@ export declare class RolesApi extends BaseAPI {
|
|
|
606
750
|
* @memberof RolesApi
|
|
607
751
|
*/
|
|
608
752
|
deleteRole(requestParameters: RolesApiDeleteRoleRequest): Promise<DeleteRoleResponse>;
|
|
753
|
+
/**
|
|
754
|
+
* Same as `deleteRole`, but resolves with the response body together with the HTTP status and headers.
|
|
755
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
756
|
+
* @param {RolesApiDeleteRoleRequest} requestParameters Request parameters.
|
|
757
|
+
|
|
758
|
+
* @throws {RequiredError}
|
|
759
|
+
* @memberof RolesApi
|
|
760
|
+
*/
|
|
761
|
+
deleteRoleWithHttpInfo(requestParameters: RolesApiDeleteRoleRequest): Promise<ApiResponse<DeleteRoleResponse>>;
|
|
609
762
|
/**
|
|
610
763
|
* Removes the assigned user from a role and adds to the default role.
|
|
611
764
|
* @summary Delete a role assignment
|
|
@@ -615,6 +768,15 @@ export declare class RolesApi extends BaseAPI {
|
|
|
615
768
|
* @memberof RolesApi
|
|
616
769
|
*/
|
|
617
770
|
deleteRoleAssignment(requestParameters: RolesApiDeleteRoleAssignmentRequest): Promise<DeleteRoleAssignmentResponse>;
|
|
771
|
+
/**
|
|
772
|
+
* Same as `deleteRoleAssignment`, but resolves with the response body together with the HTTP status and headers.
|
|
773
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
774
|
+
* @param {RolesApiDeleteRoleAssignmentRequest} requestParameters Request parameters.
|
|
775
|
+
|
|
776
|
+
* @throws {RequiredError}
|
|
777
|
+
* @memberof RolesApi
|
|
778
|
+
*/
|
|
779
|
+
deleteRoleAssignmentWithHttpInfo(requestParameters: RolesApiDeleteRoleAssignmentRequest): Promise<ApiResponse<DeleteRoleAssignmentResponse>>;
|
|
618
780
|
/**
|
|
619
781
|
* Returns the details of a specific role.
|
|
620
782
|
* @summary Get one role
|
|
@@ -624,6 +786,15 @@ export declare class RolesApi extends BaseAPI {
|
|
|
624
786
|
* @memberof RolesApi
|
|
625
787
|
*/
|
|
626
788
|
getRole(requestParameters: RolesApiGetRoleRequest): Promise<GetRoleResponse>;
|
|
789
|
+
/**
|
|
790
|
+
* Same as `getRole`, but resolves with the response body together with the HTTP status and headers.
|
|
791
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
792
|
+
* @param {RolesApiGetRoleRequest} requestParameters Request parameters.
|
|
793
|
+
|
|
794
|
+
* @throws {RequiredError}
|
|
795
|
+
* @memberof RolesApi
|
|
796
|
+
*/
|
|
797
|
+
getRoleWithHttpInfo(requestParameters: RolesApiGetRoleRequest): Promise<ApiResponse<GetRoleResponse>>;
|
|
627
798
|
/**
|
|
628
799
|
* Returns all users assigned to a role.
|
|
629
800
|
* @summary List role assignments
|
|
@@ -633,6 +804,15 @@ export declare class RolesApi extends BaseAPI {
|
|
|
633
804
|
* @memberof RolesApi
|
|
634
805
|
*/
|
|
635
806
|
getRoleAssignments(requestParameters: RolesApiGetRoleAssignmentsRequest): Promise<GetRoleAssignmentsResponse>;
|
|
807
|
+
/**
|
|
808
|
+
* Same as `getRoleAssignments`, but resolves with the response body together with the HTTP status and headers.
|
|
809
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
810
|
+
* @param {RolesApiGetRoleAssignmentsRequest} requestParameters Request parameters.
|
|
811
|
+
|
|
812
|
+
* @throws {RequiredError}
|
|
813
|
+
* @memberof RolesApi
|
|
814
|
+
*/
|
|
815
|
+
getRoleAssignmentsWithHttpInfo(requestParameters: RolesApiGetRoleAssignmentsRequest): Promise<ApiResponse<GetRoleAssignmentsResponse>>;
|
|
636
816
|
/**
|
|
637
817
|
* Returns the list of either visible or hidden pipeline IDs for a specific role. For more information on pipeline visibility, please refer to the <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">Visibility groups article</a>.
|
|
638
818
|
* @summary List pipeline visibility for a role
|
|
@@ -642,6 +822,15 @@ export declare class RolesApi extends BaseAPI {
|
|
|
642
822
|
* @memberof RolesApi
|
|
643
823
|
*/
|
|
644
824
|
getRolePipelines(requestParameters: RolesApiGetRolePipelinesRequest): Promise<GetRolePipelinesResponse>;
|
|
825
|
+
/**
|
|
826
|
+
* Same as `getRolePipelines`, but resolves with the response body together with the HTTP status and headers.
|
|
827
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
828
|
+
* @param {RolesApiGetRolePipelinesRequest} requestParameters Request parameters.
|
|
829
|
+
|
|
830
|
+
* @throws {RequiredError}
|
|
831
|
+
* @memberof RolesApi
|
|
832
|
+
*/
|
|
833
|
+
getRolePipelinesWithHttpInfo(requestParameters: RolesApiGetRolePipelinesRequest): Promise<ApiResponse<GetRolePipelinesResponse>>;
|
|
645
834
|
/**
|
|
646
835
|
* Returns the visibility settings of a specific role.
|
|
647
836
|
* @summary List role settings
|
|
@@ -651,6 +840,15 @@ export declare class RolesApi extends BaseAPI {
|
|
|
651
840
|
* @memberof RolesApi
|
|
652
841
|
*/
|
|
653
842
|
getRoleSettings(requestParameters: RolesApiGetRoleSettingsRequest): Promise<GetRoleSettingsResponse>;
|
|
843
|
+
/**
|
|
844
|
+
* Same as `getRoleSettings`, but resolves with the response body together with the HTTP status and headers.
|
|
845
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
846
|
+
* @param {RolesApiGetRoleSettingsRequest} requestParameters Request parameters.
|
|
847
|
+
|
|
848
|
+
* @throws {RequiredError}
|
|
849
|
+
* @memberof RolesApi
|
|
850
|
+
*/
|
|
851
|
+
getRoleSettingsWithHttpInfo(requestParameters: RolesApiGetRoleSettingsRequest): Promise<ApiResponse<GetRoleSettingsResponse>>;
|
|
654
852
|
/**
|
|
655
853
|
* Returns all the roles within the company.
|
|
656
854
|
* @summary Get all roles
|
|
@@ -660,6 +858,15 @@ export declare class RolesApi extends BaseAPI {
|
|
|
660
858
|
* @memberof RolesApi
|
|
661
859
|
*/
|
|
662
860
|
getRoles(requestParameters?: RolesApiGetRolesRequest): Promise<GetRolesResponse>;
|
|
861
|
+
/**
|
|
862
|
+
* Same as `getRoles`, but resolves with the response body together with the HTTP status and headers.
|
|
863
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
864
|
+
* @param {RolesApiGetRolesRequest} requestParameters Request parameters.
|
|
865
|
+
|
|
866
|
+
* @throws {RequiredError}
|
|
867
|
+
* @memberof RolesApi
|
|
868
|
+
*/
|
|
869
|
+
getRolesWithHttpInfo(requestParameters?: RolesApiGetRolesRequest): Promise<ApiResponse<GetRolesResponse>>;
|
|
663
870
|
/**
|
|
664
871
|
* Updates the parent role and/or the name of a specific role.
|
|
665
872
|
* @summary Update role details
|
|
@@ -669,6 +876,15 @@ export declare class RolesApi extends BaseAPI {
|
|
|
669
876
|
* @memberof RolesApi
|
|
670
877
|
*/
|
|
671
878
|
updateRole(requestParameters: RolesApiUpdateRoleRequest): Promise<UpdateRoleResponse>;
|
|
879
|
+
/**
|
|
880
|
+
* Same as `updateRole`, but resolves with the response body together with the HTTP status and headers.
|
|
881
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
882
|
+
* @param {RolesApiUpdateRoleRequest} requestParameters Request parameters.
|
|
883
|
+
|
|
884
|
+
* @throws {RequiredError}
|
|
885
|
+
* @memberof RolesApi
|
|
886
|
+
*/
|
|
887
|
+
updateRoleWithHttpInfo(requestParameters: RolesApiUpdateRoleRequest): Promise<ApiResponse<UpdateRoleResponse>>;
|
|
672
888
|
/**
|
|
673
889
|
* Updates the specified pipelines to be visible and/or hidden for a specific role. For more information on pipeline visibility, please refer to the <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">Visibility groups article</a>.
|
|
674
890
|
* @summary Update pipeline visibility for a role
|
|
@@ -678,4 +894,13 @@ export declare class RolesApi extends BaseAPI {
|
|
|
678
894
|
* @memberof RolesApi
|
|
679
895
|
*/
|
|
680
896
|
updateRolePipelines(requestParameters: RolesApiUpdateRolePipelinesRequest): Promise<GetRolePipelinesResponse>;
|
|
897
|
+
/**
|
|
898
|
+
* Same as `updateRolePipelines`, but resolves with the response body together with the HTTP status and headers.
|
|
899
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
900
|
+
* @param {RolesApiUpdateRolePipelinesRequest} requestParameters Request parameters.
|
|
901
|
+
|
|
902
|
+
* @throws {RequiredError}
|
|
903
|
+
* @memberof RolesApi
|
|
904
|
+
*/
|
|
905
|
+
updateRolePipelinesWithHttpInfo(requestParameters: RolesApiUpdateRolePipelinesRequest): Promise<ApiResponse<GetRolePipelinesResponse>>;
|
|
681
906
|
}
|