@iblai/iblai-api 0.0.2-core → 0.0.12-scan-core
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/index.cjs.js +3800 -3143
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +3800 -3143
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +3800 -3143
- package/dist/index.umd.js.map +1 -1
- package/dist/types/index.d.ts +27 -5
- package/dist/types/models/CatalogAutoIncrementResponse.d.ts +11 -11
- package/dist/types/models/CourseGroupSuggestionDetail.d.ts +2 -2
- package/dist/types/models/CourseInvitationDetail.d.ts +2 -2
- package/dist/types/models/CourseLicenseAssignmentDetail.d.ts +2 -2
- package/dist/types/models/CourseLicenseDetail.d.ts +4 -0
- package/dist/types/models/CourseLicenseGroupAssignmentDetail.d.ts +2 -2
- package/dist/types/models/CourseReviewPaginatedResponse.d.ts +18 -0
- package/dist/types/models/CourseReviewRequest.d.ts +37 -0
- package/dist/types/models/CourseReviewResponse.d.ts +40 -0
- package/dist/types/models/PaginatedAssertionsResponse.d.ts +21 -0
- package/dist/types/models/PaginatedCourseAccessRequest.d.ts +2 -2
- package/dist/types/models/PaginatedCourseGroupSuggestion.d.ts +2 -2
- package/dist/types/models/PaginatedCourseInvitation.d.ts +2 -2
- package/dist/types/models/PaginatedCourseLicense.d.ts +2 -2
- package/dist/types/models/PaginatedCourseLicenseAssignment.d.ts +2 -2
- package/dist/types/models/PaginatedCourseLicenseGroupAssignment.d.ts +2 -2
- package/dist/types/models/PaginatedCourseSuggestion.d.ts +2 -2
- package/dist/types/models/PaginatedPathwayGroupSuggestion.d.ts +2 -2
- package/dist/types/models/PaginatedPathwaySuggestion.d.ts +2 -2
- package/dist/types/models/PaginatedPlatformInvitation.d.ts +2 -2
- package/dist/types/models/PaginatedPlatformLicense.d.ts +2 -2
- package/dist/types/models/PaginatedProgramGroupSuggestion.d.ts +2 -2
- package/dist/types/models/PaginatedProgramInvitation.d.ts +2 -2
- package/dist/types/models/PaginatedProgramLicense.d.ts +2 -2
- package/dist/types/models/PaginatedProgramLicenseAssignment.d.ts +2 -2
- package/dist/types/models/PaginatedProgramLicenseGroupAssignment.d.ts +2 -2
- package/dist/types/models/PaginatedProgramSuggestion.d.ts +2 -2
- package/dist/types/models/PaginatedRbacGroupList.d.ts +7 -0
- package/dist/types/models/PaginatedRbacPolicyList.d.ts +7 -0
- package/dist/types/models/PaginatedRbacRoleList.d.ts +7 -0
- package/dist/types/models/PaginatedSkill.d.ts +7 -0
- package/dist/types/models/PaginatedUserLicense.d.ts +2 -2
- package/dist/types/models/PaginatedUserLicenseAssignment.d.ts +2 -2
- package/dist/types/models/PaginatedUserLicenseGroupAssignment.d.ts +2 -2
- package/dist/types/models/PatchedRbacGroup.d.ts +34 -0
- package/dist/types/models/PatchedRbacPolicy.d.ts +48 -0
- package/dist/types/models/PatchedRbacRole.d.ts +20 -0
- package/dist/types/models/PathwayGroupSuggestionDetail.d.ts +2 -2
- package/dist/types/models/PlatformInvitationDetail.d.ts +2 -2
- package/dist/types/models/PlatformSkillPointResponse.d.ts +2 -2
- package/dist/types/models/ProgramEnrollmentSearchResponse.d.ts +22 -0
- package/dist/types/models/ProgramLicenseAssignmentDetail.d.ts +4 -9
- package/dist/types/models/ProgramLicenseDetail.d.ts +6 -2
- package/dist/types/models/ProgramMetadataRequest.d.ts +29 -0
- package/dist/types/models/ProgramMetadataResponse.d.ts +29 -0
- package/dist/types/models/ProgramReview.d.ts +41 -0
- package/dist/types/models/ProgramReviewPaginatedResponse.d.ts +22 -0
- package/dist/types/models/ProgramReviewRequest.d.ts +37 -0
- package/dist/types/models/RbacBaseRole.d.ts +15 -0
- package/dist/types/models/RbacGroup.d.ts +34 -0
- package/dist/types/models/RbacPlatform.d.ts +14 -0
- package/dist/types/models/RbacPolicy.d.ts +48 -0
- package/dist/types/models/RbacPolicyGroup.d.ts +20 -0
- package/dist/types/models/RbacRole.d.ts +20 -0
- package/dist/types/models/RbacUser.d.ts +13 -0
- package/dist/types/models/StripeBillingPageIdentifierResponse.d.ts +9 -0
- package/dist/types/models/StripeContext.d.ts +7 -0
- package/dist/types/models/StripeNewUserTenantLaunchRequest.d.ts +20 -0
- package/dist/types/models/UserApp.d.ts +0 -2
- package/dist/types/models/UserLicenseAssignmentDetail.d.ts +1 -1
- package/dist/types/models/UserLicenseDetail.d.ts +5 -1
- package/dist/types/models/UserLicenseGroupAssignmentDetail.d.ts +2 -2
- package/dist/types/services/AnalyticsService.d.ts +42 -13
- package/dist/types/services/AudienceService.d.ts +345 -149
- package/dist/types/services/CareerService.d.ts +117 -90
- package/dist/types/services/CatalogService.d.ts +3799 -1430
- package/dist/types/services/CoreService.d.ts +452 -126
- package/dist/types/services/CredentialsService.d.ts +177 -141
- package/dist/types/services/DepartmentsService.d.ts +53 -16
- package/dist/types/services/EngagementService.d.ts +459 -179
- package/dist/types/services/FeaturesService.d.ts +16 -7
- package/dist/types/services/FinanceService.d.ts +49 -20
- package/dist/types/services/MediaResourcesService.d.ts +243 -67
- package/dist/types/services/NotificationBuilderService.d.ts +31 -17
- package/dist/types/services/NotificationService.d.ts +56 -49
- package/dist/types/services/OrgsService.d.ts +106 -77
- package/dist/types/services/OverviewService.d.ts +154 -55
- package/dist/types/services/PerformanceService.d.ts +132 -56
- package/dist/types/services/PerlearnerService.d.ts +431 -217
- package/dist/types/services/PlatformService.d.ts +221 -116
- package/dist/types/services/ProviderAssociationService.d.ts +3 -2
- package/dist/types/services/ProvidersService.d.ts +40 -18
- package/dist/types/services/ProvisionService.d.ts +3 -2
- package/dist/types/services/RecommendationsService.d.ts +3 -3
- package/dist/types/services/ReportsService.d.ts +22 -16
- package/dist/types/services/RolesService.d.ts +8 -6
- package/dist/types/services/SearchService.d.ts +305 -80
- package/dist/types/services/ServiceService.d.ts +89 -29
- package/dist/types/services/SkillsService.d.ts +40 -32
- package/dist/types/services/UserGroupsService.d.ts +53 -16
- package/package.json +3 -2
- package/src/core/OpenAPI.ts +1 -1
- package/src/index.ts +27 -5
- package/src/models/CatalogAutoIncrementResponse.ts +11 -11
- package/src/models/CourseGroupSuggestionDetail.ts +2 -2
- package/src/models/CourseInvitationDetail.ts +2 -2
- package/src/models/CourseLicenseAssignmentDetail.ts +2 -2
- package/src/models/CourseLicenseDetail.ts +4 -0
- package/src/models/CourseLicenseGroupAssignmentDetail.ts +2 -2
- package/src/models/CourseReviewPaginatedResponse.ts +23 -0
- package/src/models/CourseReviewRequest.ts +42 -0
- package/src/models/CourseReviewResponse.ts +45 -0
- package/src/models/PaginatedAssertionsResponse.ts +26 -0
- package/src/models/PaginatedCourseAccessRequest.ts +2 -2
- package/src/models/PaginatedCourseGroupSuggestion.ts +2 -2
- package/src/models/PaginatedCourseInvitation.ts +2 -2
- package/src/models/PaginatedCourseLicense.ts +2 -2
- package/src/models/PaginatedCourseLicenseAssignment.ts +2 -2
- package/src/models/PaginatedCourseLicenseGroupAssignment.ts +2 -2
- package/src/models/PaginatedCourseSuggestion.ts +2 -2
- package/src/models/PaginatedPathwayGroupSuggestion.ts +2 -2
- package/src/models/PaginatedPathwaySuggestion.ts +2 -2
- package/src/models/PaginatedPlatformInvitation.ts +2 -2
- package/src/models/PaginatedPlatformLicense.ts +2 -2
- package/src/models/PaginatedProgramGroupSuggestion.ts +2 -2
- package/src/models/PaginatedProgramInvitation.ts +2 -2
- package/src/models/PaginatedProgramLicense.ts +2 -2
- package/src/models/PaginatedProgramLicenseAssignment.ts +2 -2
- package/src/models/PaginatedProgramLicenseGroupAssignment.ts +2 -2
- package/src/models/PaginatedProgramSuggestion.ts +2 -2
- package/src/models/PaginatedRbacGroupList.ts +12 -0
- package/src/models/PaginatedRbacPolicyList.ts +12 -0
- package/src/models/PaginatedRbacRoleList.ts +12 -0
- package/src/models/PaginatedSkill.ts +12 -0
- package/src/models/PaginatedUserLicense.ts +2 -2
- package/src/models/PaginatedUserLicenseAssignment.ts +2 -2
- package/src/models/PaginatedUserLicenseGroupAssignment.ts +2 -2
- package/src/models/PatchedRbacGroup.ts +39 -0
- package/src/models/PatchedRbacPolicy.ts +53 -0
- package/src/models/PatchedRbacRole.ts +25 -0
- package/src/models/PathwayGroupSuggestionDetail.ts +2 -2
- package/src/models/PlatformInvitationDetail.ts +2 -2
- package/src/models/PlatformSkillPointResponse.ts +2 -2
- package/src/models/ProgramEnrollmentSearchResponse.ts +27 -0
- package/src/models/ProgramLicenseAssignmentDetail.ts +4 -9
- package/src/models/ProgramLicenseDetail.ts +6 -2
- package/src/models/ProgramMetadataRequest.ts +34 -0
- package/src/models/ProgramMetadataResponse.ts +34 -0
- package/src/models/ProgramReview.ts +46 -0
- package/src/models/ProgramReviewPaginatedResponse.ts +27 -0
- package/src/models/ProgramReviewRequest.ts +42 -0
- package/src/models/RbacBaseRole.ts +20 -0
- package/src/models/RbacGroup.ts +39 -0
- package/src/models/RbacPlatform.ts +19 -0
- package/src/models/RbacPolicy.ts +53 -0
- package/src/models/RbacPolicyGroup.ts +25 -0
- package/src/models/RbacRole.ts +25 -0
- package/src/models/RbacUser.ts +18 -0
- package/src/models/StripeBillingPageIdentifierResponse.ts +14 -0
- package/src/models/StripeContext.ts +12 -0
- package/src/models/StripeNewUserTenantLaunchRequest.ts +25 -0
- package/src/models/UserApp.ts +0 -2
- package/src/models/UserLicenseAssignmentDetail.ts +1 -1
- package/src/models/UserLicenseDetail.ts +5 -1
- package/src/models/UserLicenseGroupAssignmentDetail.ts +2 -2
- package/src/services/AnalyticsService.ts +45 -16
- package/src/services/AudienceService.ts +380 -184
- package/src/services/CareerService.ts +144 -117
- package/src/services/CatalogService.ts +6902 -4245
- package/src/services/CoreService.ts +782 -172
- package/src/services/CredentialsService.ts +257 -176
- package/src/services/DepartmentsService.ts +56 -19
- package/src/services/EngagementService.ts +528 -236
- package/src/services/FeaturesService.ts +19 -10
- package/src/services/FinanceService.ts +54 -25
- package/src/services/MediaResourcesService.ts +251 -75
- package/src/services/NotificationBuilderService.ts +36 -22
- package/src/services/NotificationService.ts +73 -61
- package/src/services/OrgsService.ts +135 -106
- package/src/services/OverviewService.ts +172 -73
- package/src/services/PerformanceService.ts +153 -77
- package/src/services/PerlearnerService.ts +591 -279
- package/src/services/PlatformService.ts +278 -157
- package/src/services/ProviderAssociationService.ts +4 -3
- package/src/services/ProvidersService.ts +58 -27
- package/src/services/ProvisionService.ts +4 -3
- package/src/services/RecommendationsService.ts +5 -4
- package/src/services/ReportsService.ts +28 -22
- package/src/services/RolesService.ts +10 -8
- package/src/services/SearchService.ts +323 -98
- package/src/services/ServiceService.ts +149 -39
- package/src/services/SkillsService.ts +56 -44
- package/src/services/UserGroupsService.ts +56 -19
- package/dist/types/models/BlockSkillPointInfoResponse.d.ts +0 -10
- package/dist/types/models/CourseCompletionCatalogResponse.d.ts +0 -11
- package/dist/types/models/CourseEligibilityCheckResponse.d.ts +0 -25
- package/dist/types/models/CourseSkillPointInfoResponse.d.ts +0 -10
- package/dist/types/models/UserSkillPointInfoResponse.d.ts +0 -10
- package/src/models/BlockSkillPointInfoResponse.ts +0 -15
- package/src/models/CourseCompletionCatalogResponse.ts +0 -16
- package/src/models/CourseEligibilityCheckResponse.ts +0 -30
- package/src/models/CourseSkillPointInfoResponse.ts +0 -15
- package/src/models/UserSkillPointInfoResponse.ts +0 -15
|
@@ -4,11 +4,20 @@ import type { ImageUpload } from '../models/ImageUpload';
|
|
|
4
4
|
import type { LauncherViewPostRequest } from '../models/LauncherViewPostRequest';
|
|
5
5
|
import type { LtiKey } from '../models/LtiKey';
|
|
6
6
|
import type { LtiTool } from '../models/LtiTool';
|
|
7
|
+
import type { PaginatedRbacGroupList } from '../models/PaginatedRbacGroupList';
|
|
8
|
+
import type { PaginatedRbacPolicyList } from '../models/PaginatedRbacPolicyList';
|
|
9
|
+
import type { PaginatedRbacRoleList } from '../models/PaginatedRbacRoleList';
|
|
7
10
|
import type { PatchedPlatformPublicMetadata } from '../models/PatchedPlatformPublicMetadata';
|
|
11
|
+
import type { PatchedRbacGroup } from '../models/PatchedRbacGroup';
|
|
12
|
+
import type { PatchedRbacPolicy } from '../models/PatchedRbacPolicy';
|
|
13
|
+
import type { PatchedRbacRole } from '../models/PatchedRbacRole';
|
|
8
14
|
import type { PlatformApiKey } from '../models/PlatformApiKey';
|
|
9
15
|
import type { PlatformList } from '../models/PlatformList';
|
|
10
16
|
import type { PlatformPublicMetadata } from '../models/PlatformPublicMetadata';
|
|
11
17
|
import type { PlatformUpdatePostRequest } from '../models/PlatformUpdatePostRequest';
|
|
18
|
+
import type { RbacGroup } from '../models/RbacGroup';
|
|
19
|
+
import type { RbacPolicy } from '../models/RbacPolicy';
|
|
20
|
+
import type { RbacRole } from '../models/RbacRole';
|
|
12
21
|
import type { RedirectTokenRequest } from '../models/RedirectTokenRequest';
|
|
13
22
|
import type { RedirectTokenResponse } from '../models/RedirectTokenResponse';
|
|
14
23
|
import type { TokenProxyInput } from '../models/TokenProxyInput';
|
|
@@ -32,11 +41,12 @@ export declare class CoreService {
|
|
|
32
41
|
* Params:
|
|
33
42
|
* - Any of user_id, username, or email (choose one only, required)
|
|
34
43
|
* - platform_key: str (required)
|
|
35
|
-
* @param requestBody
|
|
36
44
|
* @returns TokenProxyOutput
|
|
37
45
|
* @throws ApiError
|
|
38
46
|
*/
|
|
39
|
-
static coreConsolidatedTokenProxyCreate(requestBody
|
|
47
|
+
static coreConsolidatedTokenProxyCreate({ requestBody, }: {
|
|
48
|
+
requestBody: TokenProxyInput;
|
|
49
|
+
}): CancelablePromise<TokenProxyOutput>;
|
|
40
50
|
/**
|
|
41
51
|
* Show (active) departments associated with a platform
|
|
42
52
|
* @returns any No response body
|
|
@@ -87,19 +97,21 @@ export declare class CoreService {
|
|
|
87
97
|
static coreDepartmentsMembersCheckRetrieve(): CancelablePromise<any>;
|
|
88
98
|
/**
|
|
89
99
|
* Check if a domain is whitelisted
|
|
90
|
-
* @param url
|
|
91
|
-
* @param isActive
|
|
92
100
|
* @returns any No response body
|
|
93
101
|
* @throws ApiError
|
|
94
102
|
*/
|
|
95
|
-
static coreDomainsWhitelistRetrieve(url
|
|
103
|
+
static coreDomainsWhitelistRetrieve({ url, isActive, }: {
|
|
104
|
+
url: string;
|
|
105
|
+
isActive?: boolean;
|
|
106
|
+
}): CancelablePromise<any>;
|
|
96
107
|
/**
|
|
97
108
|
* Add a new domain to whitelist
|
|
98
|
-
* @param requestBody
|
|
99
109
|
* @returns WhitelistedDomain
|
|
100
110
|
* @throws ApiError
|
|
101
111
|
*/
|
|
102
|
-
static coreDomainsWhitelistCreate(requestBody
|
|
112
|
+
static coreDomainsWhitelistCreate({ requestBody, }: {
|
|
113
|
+
requestBody: WhitelistedDomain;
|
|
114
|
+
}): CancelablePromise<WhitelistedDomain>;
|
|
103
115
|
/**
|
|
104
116
|
* **Use Case**
|
|
105
117
|
*
|
|
@@ -140,12 +152,12 @@ export declare class CoreService {
|
|
|
140
152
|
* Params:
|
|
141
153
|
* key
|
|
142
154
|
* user_id: Optional
|
|
143
|
-
* @param key
|
|
144
|
-
* @param userId
|
|
145
155
|
* @returns PlatformList
|
|
146
156
|
* @throws ApiError
|
|
147
157
|
*/
|
|
148
|
-
static coreLauncherRetrieve(key
|
|
158
|
+
static coreLauncherRetrieve({ key, userId, }: {
|
|
159
|
+
key: string;
|
|
160
|
+
}): CancelablePromise<PlatformList>;
|
|
149
161
|
/**
|
|
150
162
|
* POST: Launch a new edX platform
|
|
151
163
|
*
|
|
@@ -157,197 +169,240 @@ export declare class CoreService {
|
|
|
157
169
|
* lms_url: LMS URL ("optional")
|
|
158
170
|
* cms_url: CMS URL ("optional")
|
|
159
171
|
* portal_url: Portal URL ("optional")
|
|
160
|
-
* @param requestBody
|
|
161
172
|
* @returns PlatformList
|
|
162
173
|
* @throws ApiError
|
|
163
174
|
*/
|
|
164
|
-
static coreLauncherCreate(requestBody
|
|
175
|
+
static coreLauncherCreate({ requestBody, }: {
|
|
176
|
+
requestBody: LauncherViewPostRequest;
|
|
177
|
+
}): CancelablePromise<PlatformList>;
|
|
165
178
|
/**
|
|
166
179
|
* List your LTI Provider Key's
|
|
167
|
-
* @param platformKey Platform Key
|
|
168
180
|
* @returns LtiKey
|
|
169
181
|
* @throws ApiError
|
|
170
182
|
*/
|
|
171
|
-
static coreLti1P3ProviderLtiKeysList(platformKey
|
|
183
|
+
static coreLti1P3ProviderLtiKeysList({ platformKey, }: {
|
|
184
|
+
/**
|
|
185
|
+
* Platform Key
|
|
186
|
+
*/
|
|
187
|
+
platformKey: string;
|
|
188
|
+
}): CancelablePromise<Array<LtiKey>>;
|
|
172
189
|
/**
|
|
173
190
|
* Create a new LTI Provider Key
|
|
174
|
-
* @param requestBody
|
|
175
191
|
* @returns LtiKey
|
|
176
192
|
* @throws ApiError
|
|
177
193
|
*/
|
|
178
|
-
static coreLti1P3ProviderLtiKeysCreate(requestBody
|
|
194
|
+
static coreLti1P3ProviderLtiKeysCreate({ requestBody, }: {
|
|
195
|
+
requestBody: LtiKey;
|
|
196
|
+
}): CancelablePromise<LtiKey>;
|
|
179
197
|
/**
|
|
180
198
|
* Get details about a specific LTI Provider Key
|
|
181
|
-
* @param id
|
|
182
|
-
* @param platformKey Platform Key
|
|
183
199
|
* @returns LtiKey
|
|
184
200
|
* @throws ApiError
|
|
185
201
|
*/
|
|
186
|
-
static coreLti1P3ProviderLtiKeysRetrieve(id
|
|
202
|
+
static coreLti1P3ProviderLtiKeysRetrieve({ id, platformKey, }: {
|
|
203
|
+
id: string;
|
|
204
|
+
/**
|
|
205
|
+
* Platform Key
|
|
206
|
+
*/
|
|
207
|
+
platformKey: string;
|
|
208
|
+
}): CancelablePromise<LtiKey>;
|
|
187
209
|
/**
|
|
188
210
|
* Update an LTI Provider Key
|
|
189
|
-
* @param id
|
|
190
|
-
* @param requestBody
|
|
191
211
|
* @returns LtiKey
|
|
192
212
|
* @throws ApiError
|
|
193
213
|
*/
|
|
194
|
-
static coreLti1P3ProviderLtiKeysUpdate(id
|
|
214
|
+
static coreLti1P3ProviderLtiKeysUpdate({ id, requestBody, }: {
|
|
215
|
+
id: string;
|
|
216
|
+
requestBody: LtiKey;
|
|
217
|
+
}): CancelablePromise<LtiKey>;
|
|
195
218
|
/**
|
|
196
219
|
* Delete an LTI Provider Key
|
|
197
220
|
*
|
|
198
221
|
* **DANGER:** Deleting a key will also delete all Tools that reference that Key. If you need to delete a Key you should first create a new one and update all Tools to reference the new Key before deleting the old one.
|
|
199
|
-
* @param id
|
|
200
|
-
* @param platformKey Platform Key
|
|
201
222
|
* @returns void
|
|
202
223
|
* @throws ApiError
|
|
203
224
|
*/
|
|
204
|
-
static coreLti1P3ProviderLtiKeysDestroy(id
|
|
225
|
+
static coreLti1P3ProviderLtiKeysDestroy({ id, platformKey, }: {
|
|
226
|
+
id: string;
|
|
227
|
+
/**
|
|
228
|
+
* Platform Key
|
|
229
|
+
*/
|
|
230
|
+
platformKey: string;
|
|
231
|
+
}): CancelablePromise<void>;
|
|
205
232
|
/**
|
|
206
233
|
* List your LTI Tool's
|
|
207
|
-
* @param platformKey Platform Key
|
|
208
234
|
* @returns LtiTool
|
|
209
235
|
* @throws ApiError
|
|
210
236
|
*/
|
|
211
|
-
static coreLti1P3ProviderLtiToolsList(platformKey
|
|
237
|
+
static coreLti1P3ProviderLtiToolsList({ platformKey, }: {
|
|
238
|
+
/**
|
|
239
|
+
* Platform Key
|
|
240
|
+
*/
|
|
241
|
+
platformKey: string;
|
|
242
|
+
}): CancelablePromise<Array<LtiTool>>;
|
|
212
243
|
/**
|
|
213
244
|
* Create a new LTI Tool
|
|
214
|
-
* @param requestBody
|
|
215
245
|
* @returns LtiTool
|
|
216
246
|
* @throws ApiError
|
|
217
247
|
*/
|
|
218
|
-
static coreLti1P3ProviderLtiToolsCreate(requestBody
|
|
248
|
+
static coreLti1P3ProviderLtiToolsCreate({ requestBody, }: {
|
|
249
|
+
requestBody: LtiTool;
|
|
250
|
+
}): CancelablePromise<LtiTool>;
|
|
219
251
|
/**
|
|
220
252
|
* Get details about a specific LTI Tool
|
|
221
|
-
* @param id
|
|
222
|
-
* @param platformKey Platform Key
|
|
223
253
|
* @returns LtiTool
|
|
224
254
|
* @throws ApiError
|
|
225
255
|
*/
|
|
226
|
-
static coreLti1P3ProviderLtiToolsRetrieve(id
|
|
256
|
+
static coreLti1P3ProviderLtiToolsRetrieve({ id, platformKey, }: {
|
|
257
|
+
id: string;
|
|
258
|
+
/**
|
|
259
|
+
* Platform Key
|
|
260
|
+
*/
|
|
261
|
+
platformKey: string;
|
|
262
|
+
}): CancelablePromise<LtiTool>;
|
|
227
263
|
/**
|
|
228
264
|
* Update an LTI Tool
|
|
229
|
-
* @param id
|
|
230
|
-
* @param requestBody
|
|
231
265
|
* @returns LtiTool
|
|
232
266
|
* @throws ApiError
|
|
233
267
|
*/
|
|
234
|
-
static coreLti1P3ProviderLtiToolsUpdate(id
|
|
268
|
+
static coreLti1P3ProviderLtiToolsUpdate({ id, requestBody, }: {
|
|
269
|
+
id: string;
|
|
270
|
+
requestBody: LtiTool;
|
|
271
|
+
}): CancelablePromise<LtiTool>;
|
|
235
272
|
/**
|
|
236
273
|
* Delete an LTI Tool
|
|
237
|
-
* @param id
|
|
238
|
-
* @param platformKey Platform Key
|
|
239
274
|
* @returns void
|
|
240
275
|
* @throws ApiError
|
|
241
276
|
*/
|
|
242
|
-
static coreLti1P3ProviderLtiToolsDestroy(id
|
|
277
|
+
static coreLti1P3ProviderLtiToolsDestroy({ id, platformKey, }: {
|
|
278
|
+
id: string;
|
|
279
|
+
/**
|
|
280
|
+
* Platform Key
|
|
281
|
+
*/
|
|
282
|
+
platformKey: string;
|
|
283
|
+
}): CancelablePromise<void>;
|
|
243
284
|
/**
|
|
244
285
|
* Get platform logo
|
|
245
|
-
* @param org
|
|
246
286
|
* @returns any
|
|
247
287
|
* @throws ApiError
|
|
248
288
|
*/
|
|
249
|
-
static coreOrgsDarkModeLogoRetrieve(org
|
|
289
|
+
static coreOrgsDarkModeLogoRetrieve({ org, }: {
|
|
290
|
+
org: string;
|
|
291
|
+
}): CancelablePromise<Record<string, any>>;
|
|
250
292
|
/**
|
|
251
293
|
* Upload a new platform logo
|
|
252
|
-
* @param org
|
|
253
|
-
* @param requestBody
|
|
254
294
|
* @returns ImageUpload
|
|
255
295
|
* @throws ApiError
|
|
256
296
|
*/
|
|
257
|
-
static coreOrgsDarkModeLogoCreateCreate(org
|
|
297
|
+
static coreOrgsDarkModeLogoCreateCreate({ org, requestBody, }: {
|
|
298
|
+
org: string;
|
|
299
|
+
requestBody: ImageUpload;
|
|
300
|
+
}): CancelablePromise<ImageUpload>;
|
|
258
301
|
/**
|
|
259
302
|
* Get platform logo
|
|
260
|
-
* @param org
|
|
261
303
|
* @returns any
|
|
262
304
|
* @throws ApiError
|
|
263
305
|
*/
|
|
264
|
-
static coreOrgsFaviconRetrieve(org
|
|
306
|
+
static coreOrgsFaviconRetrieve({ org, }: {
|
|
307
|
+
org: string;
|
|
308
|
+
}): CancelablePromise<Record<string, any>>;
|
|
265
309
|
/**
|
|
266
310
|
* Upload a new platform logo
|
|
267
|
-
* @param org
|
|
268
|
-
* @param requestBody
|
|
269
311
|
* @returns ImageUpload
|
|
270
312
|
* @throws ApiError
|
|
271
313
|
*/
|
|
272
|
-
static coreOrgsFaviconCreateCreate(org
|
|
314
|
+
static coreOrgsFaviconCreateCreate({ org, requestBody, }: {
|
|
315
|
+
org: string;
|
|
316
|
+
requestBody: ImageUpload;
|
|
317
|
+
}): CancelablePromise<ImageUpload>;
|
|
273
318
|
/**
|
|
274
319
|
* Get platform logo
|
|
275
|
-
* @param org
|
|
276
320
|
* @returns any
|
|
277
321
|
* @throws ApiError
|
|
278
322
|
*/
|
|
279
|
-
static coreOrgsLogoRetrieve(org
|
|
323
|
+
static coreOrgsLogoRetrieve({ org, }: {
|
|
324
|
+
org: string;
|
|
325
|
+
}): CancelablePromise<Record<string, any>>;
|
|
280
326
|
/**
|
|
281
327
|
* Upload a new platform logo
|
|
282
|
-
* @param org
|
|
283
|
-
* @param requestBody
|
|
284
328
|
* @returns ImageUpload
|
|
285
329
|
* @throws ApiError
|
|
286
330
|
*/
|
|
287
|
-
static coreOrgsLogoCreateCreate(org
|
|
331
|
+
static coreOrgsLogoCreateCreate({ org, requestBody, }: {
|
|
332
|
+
org: string;
|
|
333
|
+
requestBody: ImageUpload;
|
|
334
|
+
}): CancelablePromise<ImageUpload>;
|
|
288
335
|
/**
|
|
289
|
-
* @param org
|
|
290
336
|
* @returns PlatformPublicMetadata
|
|
291
337
|
* @throws ApiError
|
|
292
338
|
*/
|
|
293
|
-
static coreOrgsMetadataRetrieve(org
|
|
339
|
+
static coreOrgsMetadataRetrieve({ org, }: {
|
|
340
|
+
org: string;
|
|
341
|
+
}): CancelablePromise<PlatformPublicMetadata>;
|
|
294
342
|
/**
|
|
295
|
-
* @param org
|
|
296
|
-
* @param requestBody
|
|
297
343
|
* @returns PlatformPublicMetadata
|
|
298
344
|
* @throws ApiError
|
|
299
345
|
*/
|
|
300
|
-
static coreOrgsMetadataUpdate(org
|
|
346
|
+
static coreOrgsMetadataUpdate({ org, requestBody, }: {
|
|
347
|
+
org: string;
|
|
348
|
+
requestBody?: PlatformPublicMetadata;
|
|
349
|
+
}): CancelablePromise<PlatformPublicMetadata>;
|
|
301
350
|
/**
|
|
302
|
-
* @param org
|
|
303
|
-
* @param requestBody
|
|
304
351
|
* @returns PlatformPublicMetadata
|
|
305
352
|
* @throws ApiError
|
|
306
353
|
*/
|
|
307
|
-
static coreOrgsMetadataPartialUpdate(org
|
|
354
|
+
static coreOrgsMetadataPartialUpdate({ org, requestBody, }: {
|
|
355
|
+
org: string;
|
|
356
|
+
requestBody?: PatchedPlatformPublicMetadata;
|
|
357
|
+
}): CancelablePromise<PlatformPublicMetadata>;
|
|
308
358
|
/**
|
|
309
359
|
* Creates redirect tokens for a URL specified by for a platform
|
|
310
|
-
* @param org
|
|
311
|
-
* @param requestBody
|
|
312
360
|
* @returns RedirectTokenResponse
|
|
313
361
|
* @throws ApiError
|
|
314
362
|
*/
|
|
315
|
-
static coreOrgsRedirectTokensCreate(org
|
|
363
|
+
static coreOrgsRedirectTokensCreate({ org, requestBody, }: {
|
|
364
|
+
org: string;
|
|
365
|
+
requestBody: RedirectTokenRequest;
|
|
366
|
+
}): CancelablePromise<RedirectTokenResponse>;
|
|
316
367
|
/**
|
|
317
368
|
* Returns Redirect URL for the token specified.
|
|
318
369
|
*
|
|
319
370
|
* ```
|
|
320
371
|
* Requires user to be a member of the platform with the token passed
|
|
321
372
|
* ```
|
|
322
|
-
* @param org
|
|
323
|
-
* @param redirectToken
|
|
324
373
|
* @returns RedirectTokenResponse
|
|
325
374
|
* @throws ApiError
|
|
326
375
|
*/
|
|
327
|
-
static coreOrgsRedirectTokensRetrieve(org
|
|
376
|
+
static coreOrgsRedirectTokensRetrieve({ org, redirectToken, }: {
|
|
377
|
+
org: string;
|
|
378
|
+
redirectToken: string;
|
|
379
|
+
}): CancelablePromise<RedirectTokenResponse>;
|
|
328
380
|
/**
|
|
329
381
|
* Delete specific token
|
|
330
|
-
* @param org
|
|
331
|
-
* @param redirectToken
|
|
332
382
|
* @returns void
|
|
333
383
|
* @throws ApiError
|
|
334
384
|
*/
|
|
335
|
-
static coreOrgsRedirectTokensDeleteDestroy(org
|
|
385
|
+
static coreOrgsRedirectTokensDeleteDestroy({ org, redirectToken, }: {
|
|
386
|
+
org: string;
|
|
387
|
+
redirectToken: string;
|
|
388
|
+
}): CancelablePromise<void>;
|
|
336
389
|
/**
|
|
337
390
|
* Get platform logo
|
|
338
|
-
* @param org
|
|
339
391
|
* @returns any
|
|
340
392
|
* @throws ApiError
|
|
341
393
|
*/
|
|
342
|
-
static coreOrgsThumbnailRetrieve(org
|
|
394
|
+
static coreOrgsThumbnailRetrieve({ org, }: {
|
|
395
|
+
org: string;
|
|
396
|
+
}): CancelablePromise<Record<string, any>>;
|
|
343
397
|
/**
|
|
344
398
|
* Upload a new platform logo
|
|
345
|
-
* @param org
|
|
346
|
-
* @param requestBody
|
|
347
399
|
* @returns ImageUpload
|
|
348
400
|
* @throws ApiError
|
|
349
401
|
*/
|
|
350
|
-
static coreOrgsThumbnailCreateCreate(org
|
|
402
|
+
static coreOrgsThumbnailCreateCreate({ org, requestBody, }: {
|
|
403
|
+
org: string;
|
|
404
|
+
requestBody: ImageUpload;
|
|
405
|
+
}): CancelablePromise<ImageUpload>;
|
|
351
406
|
/**
|
|
352
407
|
* GET /api/core/platform/
|
|
353
408
|
* Get main platform info.
|
|
@@ -360,12 +415,12 @@ export declare class CoreService {
|
|
|
360
415
|
* key
|
|
361
416
|
* field_key (POST)
|
|
362
417
|
* value (POST)
|
|
363
|
-
* @param key
|
|
364
|
-
* @param userId
|
|
365
418
|
* @returns PlatformList
|
|
366
419
|
* @throws ApiError
|
|
367
420
|
*/
|
|
368
|
-
static corePlatformRetrieve(key
|
|
421
|
+
static corePlatformRetrieve({ key, userId, }: {
|
|
422
|
+
key: string;
|
|
423
|
+
}): CancelablePromise<PlatformList>;
|
|
369
424
|
/**
|
|
370
425
|
* Update platform object
|
|
371
426
|
*
|
|
@@ -380,33 +435,43 @@ export declare class CoreService {
|
|
|
380
435
|
* lms_url
|
|
381
436
|
* cms_url
|
|
382
437
|
* portal_url
|
|
383
|
-
* @param requestBody
|
|
384
438
|
* @returns PlatformList
|
|
385
439
|
* @throws ApiError
|
|
386
440
|
*/
|
|
387
|
-
static corePlatformCreate(requestBody
|
|
441
|
+
static corePlatformCreate({ requestBody, }: {
|
|
442
|
+
requestBody: PlatformUpdatePostRequest;
|
|
443
|
+
}): CancelablePromise<PlatformList>;
|
|
388
444
|
/**
|
|
389
445
|
* List Platform API Key's belonging to the target platform
|
|
390
|
-
* @param platformKey Platform key of target platform
|
|
391
446
|
* @returns PlatformApiKey
|
|
392
447
|
* @throws ApiError
|
|
393
448
|
*/
|
|
394
|
-
static corePlatformApiTokensList(platformKey
|
|
449
|
+
static corePlatformApiTokensList({ platformKey, }: {
|
|
450
|
+
/**
|
|
451
|
+
* Platform key of target platform
|
|
452
|
+
*/
|
|
453
|
+
platformKey: string;
|
|
454
|
+
}): CancelablePromise<Array<PlatformApiKey>>;
|
|
395
455
|
/**
|
|
396
456
|
* Create a new Platform Api Key for the target platform
|
|
397
|
-
* @param requestBody
|
|
398
457
|
* @returns PlatformApiKey
|
|
399
458
|
* @throws ApiError
|
|
400
459
|
*/
|
|
401
|
-
static corePlatformApiTokensCreate(requestBody
|
|
460
|
+
static corePlatformApiTokensCreate({ requestBody, }: {
|
|
461
|
+
requestBody: PlatformApiKey;
|
|
462
|
+
}): CancelablePromise<PlatformApiKey>;
|
|
402
463
|
/**
|
|
403
464
|
* Delete Platform Api Key by name in the target platform
|
|
404
|
-
* @param name
|
|
405
|
-
* @param platformKey Platform key of target platform
|
|
406
465
|
* @returns void
|
|
407
466
|
* @throws ApiError
|
|
408
467
|
*/
|
|
409
|
-
static corePlatformApiTokensDestroy(name
|
|
468
|
+
static corePlatformApiTokensDestroy({ name, platformKey, }: {
|
|
469
|
+
name: string;
|
|
470
|
+
/**
|
|
471
|
+
* Platform key of target platform
|
|
472
|
+
*/
|
|
473
|
+
platformKey: string;
|
|
474
|
+
}): CancelablePromise<void>;
|
|
410
475
|
/**
|
|
411
476
|
* GET /site
|
|
412
477
|
* Get site settings.
|
|
@@ -419,12 +484,12 @@ export declare class CoreService {
|
|
|
419
484
|
* key
|
|
420
485
|
* field_key (POST)
|
|
421
486
|
* value (POST)
|
|
422
|
-
* @param key
|
|
423
|
-
* @param userId
|
|
424
487
|
* @returns any
|
|
425
488
|
* @throws ApiError
|
|
426
489
|
*/
|
|
427
|
-
static corePlatformConfigSiteRetrieve(key
|
|
490
|
+
static corePlatformConfigSiteRetrieve({ key, userId, }: {
|
|
491
|
+
key: string;
|
|
492
|
+
}): CancelablePromise<Record<string, any>>;
|
|
428
493
|
/**
|
|
429
494
|
* GET /site
|
|
430
495
|
* Get site settings.
|
|
@@ -437,11 +502,12 @@ export declare class CoreService {
|
|
|
437
502
|
* key
|
|
438
503
|
* field_key (POST)
|
|
439
504
|
* value (POST)
|
|
440
|
-
* @param requestBody
|
|
441
505
|
* @returns any
|
|
442
506
|
* @throws ApiError
|
|
443
507
|
*/
|
|
444
|
-
static corePlatformConfigSiteCreate(requestBody
|
|
508
|
+
static corePlatformConfigSiteCreate({ requestBody, }: {
|
|
509
|
+
requestBody?: Record<string, any>;
|
|
510
|
+
}): CancelablePromise<Record<string, any>>;
|
|
445
511
|
/**
|
|
446
512
|
* Retrieve users associated with platform
|
|
447
513
|
*
|
|
@@ -453,16 +519,270 @@ export declare class CoreService {
|
|
|
453
519
|
* sort
|
|
454
520
|
*
|
|
455
521
|
* is_admin: Return tenant admin users
|
|
456
|
-
* @param page
|
|
457
|
-
* @param pageSize
|
|
458
|
-
* @param platformKey
|
|
459
|
-
* @param platformOrg
|
|
460
|
-
* @param query
|
|
461
|
-
* @param sort
|
|
462
522
|
* @returns UserPlatformManagementListViewGetResponse
|
|
463
523
|
* @throws ApiError
|
|
464
524
|
*/
|
|
465
|
-
static corePlatformUsersRetrieve(page
|
|
525
|
+
static corePlatformUsersRetrieve({ page, pageSize, platformKey, platformOrg, query, sort, }: {
|
|
526
|
+
page?: number;
|
|
527
|
+
pageSize?: number;
|
|
528
|
+
platformKey?: string;
|
|
529
|
+
platformOrg?: string;
|
|
530
|
+
query?: string;
|
|
531
|
+
sort?: string;
|
|
532
|
+
}): CancelablePromise<UserPlatformManagementListViewGetResponse>;
|
|
533
|
+
/**
|
|
534
|
+
* List RBAC groups
|
|
535
|
+
* Retrieve a list of RBAC groups. Can be filtered by platform_key.
|
|
536
|
+
* @returns PaginatedRbacGroupList
|
|
537
|
+
* @throws ApiError
|
|
538
|
+
*/
|
|
539
|
+
static coreRbacGroupsList({ page, pageSize, platformKey, }: {
|
|
540
|
+
/**
|
|
541
|
+
* A page number within the paginated result set.
|
|
542
|
+
*/
|
|
543
|
+
page?: number;
|
|
544
|
+
/**
|
|
545
|
+
* Number of results to return per page.
|
|
546
|
+
*/
|
|
547
|
+
pageSize?: number;
|
|
548
|
+
/**
|
|
549
|
+
* Filter groups by platform key
|
|
550
|
+
*/
|
|
551
|
+
platformKey?: string;
|
|
552
|
+
}): CancelablePromise<PaginatedRbacGroupList>;
|
|
553
|
+
/**
|
|
554
|
+
* Create RBAC group
|
|
555
|
+
* Create a new RBAC group for a platform. Users can be assigned during creation.
|
|
556
|
+
* @returns RbacGroup
|
|
557
|
+
* @throws ApiError
|
|
558
|
+
*/
|
|
559
|
+
static coreRbacGroupsCreate({ requestBody, }: {
|
|
560
|
+
requestBody: RbacGroup;
|
|
561
|
+
}): CancelablePromise<RbacGroup>;
|
|
562
|
+
/**
|
|
563
|
+
* Retrieve RBAC group
|
|
564
|
+
* Retrieve details of a specific RBAC group including assigned users.
|
|
565
|
+
* @returns RbacGroup
|
|
566
|
+
* @throws ApiError
|
|
567
|
+
*/
|
|
568
|
+
static coreRbacGroupsRetrieve({ id, }: {
|
|
569
|
+
/**
|
|
570
|
+
* A unique integer value identifying this RBAC Group.
|
|
571
|
+
*/
|
|
572
|
+
id: number;
|
|
573
|
+
}): CancelablePromise<RbacGroup>;
|
|
574
|
+
/**
|
|
575
|
+
* Update RBAC group
|
|
576
|
+
* Update an existing RBAC group. Platform validation applies for user assignments.
|
|
577
|
+
* @returns RbacGroup
|
|
578
|
+
* @throws ApiError
|
|
579
|
+
*/
|
|
580
|
+
static coreRbacGroupsUpdate({ id, requestBody, }: {
|
|
581
|
+
/**
|
|
582
|
+
* A unique integer value identifying this RBAC Group.
|
|
583
|
+
*/
|
|
584
|
+
id: number;
|
|
585
|
+
requestBody: RbacGroup;
|
|
586
|
+
}): CancelablePromise<RbacGroup>;
|
|
587
|
+
/**
|
|
588
|
+
* Partially update RBAC group
|
|
589
|
+
* Partially update an existing RBAC group. Platform validation applies for user assignments.
|
|
590
|
+
* @returns RbacGroup
|
|
591
|
+
* @throws ApiError
|
|
592
|
+
*/
|
|
593
|
+
static coreRbacGroupsPartialUpdate({ id, requestBody, }: {
|
|
594
|
+
/**
|
|
595
|
+
* A unique integer value identifying this RBAC Group.
|
|
596
|
+
*/
|
|
597
|
+
id: number;
|
|
598
|
+
requestBody?: PatchedRbacGroup;
|
|
599
|
+
}): CancelablePromise<RbacGroup>;
|
|
600
|
+
/**
|
|
601
|
+
* Delete RBAC group
|
|
602
|
+
* Delete an RBAC group and all associated group role assignments.
|
|
603
|
+
* @returns void
|
|
604
|
+
* @throws ApiError
|
|
605
|
+
*/
|
|
606
|
+
static coreRbacGroupsDestroy({ id, platformKey, }: {
|
|
607
|
+
/**
|
|
608
|
+
* A unique integer value identifying this RBAC Group.
|
|
609
|
+
*/
|
|
610
|
+
id: number;
|
|
611
|
+
/**
|
|
612
|
+
* platform key for authorization check
|
|
613
|
+
*/
|
|
614
|
+
platformKey?: string;
|
|
615
|
+
}): CancelablePromise<void>;
|
|
616
|
+
/**
|
|
617
|
+
* List RBAC policies
|
|
618
|
+
* Retrieve a list of RBAC policies. Can be filtered by platform_key or role_id.
|
|
619
|
+
* @returns PaginatedRbacPolicyList
|
|
620
|
+
* @throws ApiError
|
|
621
|
+
*/
|
|
622
|
+
static coreRbacPoliciesList({ page, pageSize, platformKey, roleId, }: {
|
|
623
|
+
/**
|
|
624
|
+
* A page number within the paginated result set.
|
|
625
|
+
*/
|
|
626
|
+
page?: number;
|
|
627
|
+
/**
|
|
628
|
+
* Number of results to return per page.
|
|
629
|
+
*/
|
|
630
|
+
pageSize?: number;
|
|
631
|
+
/**
|
|
632
|
+
* Filter policies by platform key
|
|
633
|
+
*/
|
|
634
|
+
platformKey?: string;
|
|
635
|
+
/**
|
|
636
|
+
* Filter policies by role ID
|
|
637
|
+
*/
|
|
638
|
+
roleId?: number;
|
|
639
|
+
}): CancelablePromise<PaginatedRbacPolicyList>;
|
|
640
|
+
/**
|
|
641
|
+
* Create RBAC policy
|
|
642
|
+
* Create a new RBAC policy that defines resource access for a role
|
|
643
|
+
* @returns RbacPolicy
|
|
644
|
+
* @throws ApiError
|
|
645
|
+
*/
|
|
646
|
+
static coreRbacPoliciesCreate({ requestBody, }: {
|
|
647
|
+
requestBody: RbacPolicy;
|
|
648
|
+
}): CancelablePromise<RbacPolicy>;
|
|
649
|
+
/**
|
|
650
|
+
* Retrieve RBAC policy
|
|
651
|
+
* Retrieve details of a specific RBAC policy, including role, platform, resources, users, and groups.
|
|
652
|
+
* @returns RbacPolicy
|
|
653
|
+
* @throws ApiError
|
|
654
|
+
*/
|
|
655
|
+
static coreRbacPoliciesRetrieve({ id, }: {
|
|
656
|
+
/**
|
|
657
|
+
* A unique integer value identifying this RBAC Policy.
|
|
658
|
+
*/
|
|
659
|
+
id: number;
|
|
660
|
+
}): CancelablePromise<RbacPolicy>;
|
|
661
|
+
/**
|
|
662
|
+
* Update RBAC policy
|
|
663
|
+
* Update an existing RBAC policy.
|
|
664
|
+
* @returns RbacPolicy
|
|
665
|
+
* @throws ApiError
|
|
666
|
+
*/
|
|
667
|
+
static coreRbacPoliciesUpdate({ id, requestBody, }: {
|
|
668
|
+
/**
|
|
669
|
+
* A unique integer value identifying this RBAC Policy.
|
|
670
|
+
*/
|
|
671
|
+
id: number;
|
|
672
|
+
requestBody: RbacPolicy;
|
|
673
|
+
}): CancelablePromise<RbacPolicy>;
|
|
674
|
+
/**
|
|
675
|
+
* Partially update RBAC policy
|
|
676
|
+
* Partially update an existing RBAC policy. Only provided fields will be updated.
|
|
677
|
+
* @returns RbacPolicy
|
|
678
|
+
* @throws ApiError
|
|
679
|
+
*/
|
|
680
|
+
static coreRbacPoliciesPartialUpdate({ id, requestBody, }: {
|
|
681
|
+
/**
|
|
682
|
+
* A unique integer value identifying this RBAC Policy.
|
|
683
|
+
*/
|
|
684
|
+
id: number;
|
|
685
|
+
requestBody?: PatchedRbacPolicy;
|
|
686
|
+
}): CancelablePromise<RbacPolicy>;
|
|
687
|
+
/**
|
|
688
|
+
* Delete RBAC policy
|
|
689
|
+
* Delete an RBAC policy.
|
|
690
|
+
* @returns void
|
|
691
|
+
* @throws ApiError
|
|
692
|
+
*/
|
|
693
|
+
static coreRbacPoliciesDestroy({ id, platformKey, }: {
|
|
694
|
+
/**
|
|
695
|
+
* A unique integer value identifying this RBAC Policy.
|
|
696
|
+
*/
|
|
697
|
+
id: number;
|
|
698
|
+
/**
|
|
699
|
+
* platform key for authorization check
|
|
700
|
+
*/
|
|
701
|
+
platformKey?: string;
|
|
702
|
+
}): CancelablePromise<void>;
|
|
703
|
+
/**
|
|
704
|
+
* List RBAC roles
|
|
705
|
+
* Retrieve a list of RBAC roles. Can be filtered by platform_key.
|
|
706
|
+
* @returns PaginatedRbacRoleList
|
|
707
|
+
* @throws ApiError
|
|
708
|
+
*/
|
|
709
|
+
static coreRbacRolesList({ page, pageSize, platformKey, }: {
|
|
710
|
+
/**
|
|
711
|
+
* A page number within the paginated result set.
|
|
712
|
+
*/
|
|
713
|
+
page?: number;
|
|
714
|
+
/**
|
|
715
|
+
* Number of results to return per page.
|
|
716
|
+
*/
|
|
717
|
+
pageSize?: number;
|
|
718
|
+
/**
|
|
719
|
+
* Filter roles by platform key
|
|
720
|
+
*/
|
|
721
|
+
platformKey?: string;
|
|
722
|
+
}): CancelablePromise<PaginatedRbacRoleList>;
|
|
723
|
+
/**
|
|
724
|
+
* Create RBAC role
|
|
725
|
+
* Create a new RBAC role for a platform.
|
|
726
|
+
* @returns RbacRole
|
|
727
|
+
* @throws ApiError
|
|
728
|
+
*/
|
|
729
|
+
static coreRbacRolesCreate({ requestBody, }: {
|
|
730
|
+
requestBody: RbacRole;
|
|
731
|
+
}): CancelablePromise<RbacRole>;
|
|
732
|
+
/**
|
|
733
|
+
* Retrieve RBAC role
|
|
734
|
+
* Retrieve details of a specific RBAC role.
|
|
735
|
+
* @returns RbacRole
|
|
736
|
+
* @throws ApiError
|
|
737
|
+
*/
|
|
738
|
+
static coreRbacRolesRetrieve({ id, }: {
|
|
739
|
+
/**
|
|
740
|
+
* A unique integer value identifying this RBAC Role.
|
|
741
|
+
*/
|
|
742
|
+
id: number;
|
|
743
|
+
}): CancelablePromise<RbacRole>;
|
|
744
|
+
/**
|
|
745
|
+
* Update RBAC role
|
|
746
|
+
* Update an existing RBAC role.
|
|
747
|
+
* @returns RbacRole
|
|
748
|
+
* @throws ApiError
|
|
749
|
+
*/
|
|
750
|
+
static coreRbacRolesUpdate({ id, requestBody, }: {
|
|
751
|
+
/**
|
|
752
|
+
* A unique integer value identifying this RBAC Role.
|
|
753
|
+
*/
|
|
754
|
+
id: number;
|
|
755
|
+
requestBody: RbacRole;
|
|
756
|
+
}): CancelablePromise<RbacRole>;
|
|
757
|
+
/**
|
|
758
|
+
* Partially update RBAC role
|
|
759
|
+
* Partially update an existing RBAC role.
|
|
760
|
+
* @returns RbacRole
|
|
761
|
+
* @throws ApiError
|
|
762
|
+
*/
|
|
763
|
+
static coreRbacRolesPartialUpdate({ id, requestBody, }: {
|
|
764
|
+
/**
|
|
765
|
+
* A unique integer value identifying this RBAC Role.
|
|
766
|
+
*/
|
|
767
|
+
id: number;
|
|
768
|
+
requestBody?: PatchedRbacRole;
|
|
769
|
+
}): CancelablePromise<RbacRole>;
|
|
770
|
+
/**
|
|
771
|
+
* Delete RBAC role
|
|
772
|
+
* Delete an RBAC role.
|
|
773
|
+
* @returns void
|
|
774
|
+
* @throws ApiError
|
|
775
|
+
*/
|
|
776
|
+
static coreRbacRolesDestroy({ id, platformKey, }: {
|
|
777
|
+
/**
|
|
778
|
+
* A unique integer value identifying this RBAC Role.
|
|
779
|
+
*/
|
|
780
|
+
id: number;
|
|
781
|
+
/**
|
|
782
|
+
* platform key for authorization check
|
|
783
|
+
*/
|
|
784
|
+
platformKey?: string;
|
|
785
|
+
}): CancelablePromise<void>;
|
|
466
786
|
/**
|
|
467
787
|
* Invalidate all tokens for the authenticated user
|
|
468
788
|
* @returns any No response body
|
|
@@ -471,11 +791,12 @@ export declare class CoreService {
|
|
|
471
791
|
static coreSessionLogoutCreate(): CancelablePromise<any>;
|
|
472
792
|
/**
|
|
473
793
|
* POST signals/edx/
|
|
474
|
-
* @param requestBody
|
|
475
794
|
* @returns any No response body
|
|
476
795
|
* @throws ApiError
|
|
477
796
|
*/
|
|
478
|
-
static coreSignalsEdxCreate(requestBody
|
|
797
|
+
static coreSignalsEdxCreate({ requestBody, }: {
|
|
798
|
+
requestBody: EdxSignalReceiverRequest;
|
|
799
|
+
}): CancelablePromise<any>;
|
|
479
800
|
/**
|
|
480
801
|
* Param:
|
|
481
802
|
* Any of user_id/username/email
|
|
@@ -535,23 +856,24 @@ export declare class CoreService {
|
|
|
535
856
|
static coreUserGroupsLinkBulkCreate(): CancelablePromise<any>;
|
|
536
857
|
/**
|
|
537
858
|
* Initiates the account deletion process for the authenticated user or specified username.
|
|
538
|
-
* @param requestBody
|
|
539
859
|
* @returns UserDeleteAPIResponse
|
|
540
860
|
* @throws ApiError
|
|
541
861
|
*/
|
|
542
|
-
static coreUsersDeleteCreate(requestBody
|
|
862
|
+
static coreUsersDeleteCreate({ requestBody, }: {
|
|
863
|
+
requestBody?: UserDeleteAPIRequest;
|
|
864
|
+
}): CancelablePromise<UserDeleteAPIResponse>;
|
|
543
865
|
/**
|
|
544
866
|
* Get detailed user information.
|
|
545
867
|
*
|
|
546
868
|
* Make permission check for platform admins here,
|
|
547
869
|
* then proxy request to edx.
|
|
548
|
-
* @param email
|
|
549
|
-
* @param userId
|
|
550
|
-
* @param username
|
|
551
870
|
* @returns any No response body
|
|
552
871
|
* @throws ApiError
|
|
553
872
|
*/
|
|
554
|
-
static coreUsersMetadataProxyRetrieve(email
|
|
873
|
+
static coreUsersMetadataProxyRetrieve({ email, userId, username, }: {
|
|
874
|
+
email?: string;
|
|
875
|
+
username?: string;
|
|
876
|
+
}): CancelablePromise<any>;
|
|
555
877
|
/**
|
|
556
878
|
* Retrieve platforms associated with user_id
|
|
557
879
|
*
|
|
@@ -559,13 +881,13 @@ export declare class CoreService {
|
|
|
559
881
|
* user_id
|
|
560
882
|
* username
|
|
561
883
|
* email
|
|
562
|
-
* @param email
|
|
563
|
-
* @param userId
|
|
564
|
-
* @param username
|
|
565
884
|
* @returns UserPlatformLink
|
|
566
885
|
* @throws ApiError
|
|
567
886
|
*/
|
|
568
|
-
static coreUsersPlatformsList(email
|
|
887
|
+
static coreUsersPlatformsList({ email, userId, username, }: {
|
|
888
|
+
email?: string;
|
|
889
|
+
username?: string;
|
|
890
|
+
}): CancelablePromise<Array<UserPlatformLink>>;
|
|
569
891
|
/**
|
|
570
892
|
* Explicitly link platform to user_id
|
|
571
893
|
*
|
|
@@ -576,20 +898,21 @@ export declare class CoreService {
|
|
|
576
898
|
* expired_on (optional)
|
|
577
899
|
* is_admin (optional)
|
|
578
900
|
* active (optional)
|
|
579
|
-
* @param requestBody
|
|
580
901
|
* @returns any No response body
|
|
581
902
|
* @throws ApiError
|
|
582
903
|
*/
|
|
583
|
-
static coreUsersPlatformsCreate(requestBody
|
|
904
|
+
static coreUsersPlatformsCreate({ requestBody, }: {
|
|
905
|
+
requestBody: UserPlatformViewPostRequest;
|
|
906
|
+
}): CancelablePromise<any>;
|
|
584
907
|
/**
|
|
585
908
|
* Retrieve proxy user information by user_id
|
|
586
|
-
* @param email
|
|
587
|
-
* @param userId
|
|
588
|
-
* @param username
|
|
589
909
|
* @returns UserProxyGetResponse
|
|
590
910
|
* @throws ApiError
|
|
591
911
|
*/
|
|
592
|
-
static coreUsersProxyRetrieve(email
|
|
912
|
+
static coreUsersProxyRetrieve({ email, userId, username, }: {
|
|
913
|
+
email?: string;
|
|
914
|
+
username?: string;
|
|
915
|
+
}): CancelablePromise<UserProxyGetResponse>;
|
|
593
916
|
/**
|
|
594
917
|
* Add proxy user
|
|
595
918
|
*
|
|
@@ -599,11 +922,12 @@ export declare class CoreService {
|
|
|
599
922
|
* email
|
|
600
923
|
* edx_data
|
|
601
924
|
* data
|
|
602
|
-
* @param requestBody
|
|
603
925
|
* @returns UserProxyPostResponse
|
|
604
926
|
* @throws ApiError
|
|
605
927
|
*/
|
|
606
|
-
static coreUsersProxyCreate(requestBody
|
|
928
|
+
static coreUsersProxyCreate({ requestBody, }: {
|
|
929
|
+
requestBody: UserProxyPostRequest;
|
|
930
|
+
}): CancelablePromise<UserProxyPostResponse>;
|
|
607
931
|
/**
|
|
608
932
|
* Add proxy users by bulk
|
|
609
933
|
*
|
|
@@ -615,11 +939,12 @@ export declare class CoreService {
|
|
|
615
939
|
* {"user_id": 2, ...}
|
|
616
940
|
* ]
|
|
617
941
|
* ```
|
|
618
|
-
* @param requestBody
|
|
619
942
|
* @returns string
|
|
620
943
|
* @throws ApiError
|
|
621
944
|
*/
|
|
622
|
-
static coreUsersProxyBulkCreate(requestBody
|
|
945
|
+
static coreUsersProxyBulkCreate({ requestBody, }: {
|
|
946
|
+
requestBody: UserProxyBulkRequest;
|
|
947
|
+
}): CancelablePromise<Array<Record<string, string>>>;
|
|
623
948
|
/**
|
|
624
949
|
* Retrieve users based on query
|
|
625
950
|
* Not intended for public use with multitenant platforms
|
|
@@ -627,12 +952,13 @@ export declare class CoreService {
|
|
|
627
952
|
* Params:
|
|
628
953
|
* query
|
|
629
954
|
* sort
|
|
630
|
-
* @param page
|
|
631
|
-
* @param pageSize
|
|
632
|
-
* @param query
|
|
633
|
-
* @param sort
|
|
634
955
|
* @returns UserSearchViewGetResponse
|
|
635
956
|
* @throws ApiError
|
|
636
957
|
*/
|
|
637
|
-
static coreUsersSearchRetrieve(page
|
|
958
|
+
static coreUsersSearchRetrieve({ page, pageSize, query, sort, }: {
|
|
959
|
+
page?: number;
|
|
960
|
+
pageSize?: number;
|
|
961
|
+
query?: string;
|
|
962
|
+
sort?: string;
|
|
963
|
+
}): CancelablePromise<UserSearchViewGetResponse>;
|
|
638
964
|
}
|