@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
|
@@ -8,11 +8,20 @@ import type { ImageUpload } from '../models/ImageUpload';
|
|
|
8
8
|
import type { LauncherViewPostRequest } from '../models/LauncherViewPostRequest';
|
|
9
9
|
import type { LtiKey } from '../models/LtiKey';
|
|
10
10
|
import type { LtiTool } from '../models/LtiTool';
|
|
11
|
+
import type { PaginatedRbacGroupList } from '../models/PaginatedRbacGroupList';
|
|
12
|
+
import type { PaginatedRbacPolicyList } from '../models/PaginatedRbacPolicyList';
|
|
13
|
+
import type { PaginatedRbacRoleList } from '../models/PaginatedRbacRoleList';
|
|
11
14
|
import type { PatchedPlatformPublicMetadata } from '../models/PatchedPlatformPublicMetadata';
|
|
15
|
+
import type { PatchedRbacGroup } from '../models/PatchedRbacGroup';
|
|
16
|
+
import type { PatchedRbacPolicy } from '../models/PatchedRbacPolicy';
|
|
17
|
+
import type { PatchedRbacRole } from '../models/PatchedRbacRole';
|
|
12
18
|
import type { PlatformApiKey } from '../models/PlatformApiKey';
|
|
13
19
|
import type { PlatformList } from '../models/PlatformList';
|
|
14
20
|
import type { PlatformPublicMetadata } from '../models/PlatformPublicMetadata';
|
|
15
21
|
import type { PlatformUpdatePostRequest } from '../models/PlatformUpdatePostRequest';
|
|
22
|
+
import type { RbacGroup } from '../models/RbacGroup';
|
|
23
|
+
import type { RbacPolicy } from '../models/RbacPolicy';
|
|
24
|
+
import type { RbacRole } from '../models/RbacRole';
|
|
16
25
|
import type { RedirectTokenRequest } from '../models/RedirectTokenRequest';
|
|
17
26
|
import type { RedirectTokenResponse } from '../models/RedirectTokenResponse';
|
|
18
27
|
import type { TokenProxyInput } from '../models/TokenProxyInput';
|
|
@@ -38,13 +47,14 @@ export class CoreService {
|
|
|
38
47
|
* Params:
|
|
39
48
|
* - Any of user_id, username, or email (choose one only, required)
|
|
40
49
|
* - platform_key: str (required)
|
|
41
|
-
* @param requestBody
|
|
42
50
|
* @returns TokenProxyOutput
|
|
43
51
|
* @throws ApiError
|
|
44
52
|
*/
|
|
45
|
-
public static coreConsolidatedTokenProxyCreate(
|
|
53
|
+
public static coreConsolidatedTokenProxyCreate({
|
|
54
|
+
requestBody,
|
|
55
|
+
}: {
|
|
46
56
|
requestBody: TokenProxyInput,
|
|
47
|
-
): CancelablePromise<TokenProxyOutput> {
|
|
57
|
+
}): CancelablePromise<TokenProxyOutput> {
|
|
48
58
|
return __request(OpenAPI, {
|
|
49
59
|
method: 'POST',
|
|
50
60
|
url: '/api/core/consolidated-token/proxy/',
|
|
@@ -142,15 +152,16 @@ export class CoreService {
|
|
|
142
152
|
}
|
|
143
153
|
/**
|
|
144
154
|
* Check if a domain is whitelisted
|
|
145
|
-
* @param url
|
|
146
|
-
* @param isActive
|
|
147
155
|
* @returns any No response body
|
|
148
156
|
* @throws ApiError
|
|
149
157
|
*/
|
|
150
|
-
public static coreDomainsWhitelistRetrieve(
|
|
158
|
+
public static coreDomainsWhitelistRetrieve({
|
|
159
|
+
url,
|
|
160
|
+
isActive,
|
|
161
|
+
}: {
|
|
151
162
|
url: string,
|
|
152
163
|
isActive?: boolean,
|
|
153
|
-
): CancelablePromise<any> {
|
|
164
|
+
}): CancelablePromise<any> {
|
|
154
165
|
return __request(OpenAPI, {
|
|
155
166
|
method: 'GET',
|
|
156
167
|
url: '/api/core/domains/whitelist/',
|
|
@@ -162,13 +173,14 @@ export class CoreService {
|
|
|
162
173
|
}
|
|
163
174
|
/**
|
|
164
175
|
* Add a new domain to whitelist
|
|
165
|
-
* @param requestBody
|
|
166
176
|
* @returns WhitelistedDomain
|
|
167
177
|
* @throws ApiError
|
|
168
178
|
*/
|
|
169
|
-
public static coreDomainsWhitelistCreate(
|
|
179
|
+
public static coreDomainsWhitelistCreate({
|
|
180
|
+
requestBody,
|
|
181
|
+
}: {
|
|
170
182
|
requestBody: WhitelistedDomain,
|
|
171
|
-
): CancelablePromise<WhitelistedDomain> {
|
|
183
|
+
}): CancelablePromise<WhitelistedDomain> {
|
|
172
184
|
return __request(OpenAPI, {
|
|
173
185
|
method: 'POST',
|
|
174
186
|
url: '/api/core/domains/whitelist/',
|
|
@@ -226,15 +238,16 @@ export class CoreService {
|
|
|
226
238
|
* Params:
|
|
227
239
|
* key
|
|
228
240
|
* user_id: Optional
|
|
229
|
-
* @param key
|
|
230
|
-
* @param userId
|
|
231
241
|
* @returns PlatformList
|
|
232
242
|
* @throws ApiError
|
|
233
243
|
*/
|
|
234
|
-
public static coreLauncherRetrieve(
|
|
244
|
+
public static coreLauncherRetrieve({
|
|
245
|
+
key,
|
|
246
|
+
userId,
|
|
247
|
+
}: {
|
|
235
248
|
key: string,
|
|
236
249
|
userId?: number,
|
|
237
|
-
): CancelablePromise<PlatformList> {
|
|
250
|
+
}): CancelablePromise<PlatformList> {
|
|
238
251
|
return __request(OpenAPI, {
|
|
239
252
|
method: 'GET',
|
|
240
253
|
url: '/api/core/launcher/',
|
|
@@ -255,13 +268,14 @@ export class CoreService {
|
|
|
255
268
|
* lms_url: LMS URL ("optional")
|
|
256
269
|
* cms_url: CMS URL ("optional")
|
|
257
270
|
* portal_url: Portal URL ("optional")
|
|
258
|
-
* @param requestBody
|
|
259
271
|
* @returns PlatformList
|
|
260
272
|
* @throws ApiError
|
|
261
273
|
*/
|
|
262
|
-
public static coreLauncherCreate(
|
|
274
|
+
public static coreLauncherCreate({
|
|
275
|
+
requestBody,
|
|
276
|
+
}: {
|
|
263
277
|
requestBody: LauncherViewPostRequest,
|
|
264
|
-
): CancelablePromise<PlatformList> {
|
|
278
|
+
}): CancelablePromise<PlatformList> {
|
|
265
279
|
return __request(OpenAPI, {
|
|
266
280
|
method: 'POST',
|
|
267
281
|
url: '/api/core/launcher/',
|
|
@@ -271,13 +285,17 @@ export class CoreService {
|
|
|
271
285
|
}
|
|
272
286
|
/**
|
|
273
287
|
* List your LTI Provider Key's
|
|
274
|
-
* @param platformKey Platform Key
|
|
275
288
|
* @returns LtiKey
|
|
276
289
|
* @throws ApiError
|
|
277
290
|
*/
|
|
278
|
-
public static coreLti1P3ProviderLtiKeysList(
|
|
291
|
+
public static coreLti1P3ProviderLtiKeysList({
|
|
292
|
+
platformKey,
|
|
293
|
+
}: {
|
|
294
|
+
/**
|
|
295
|
+
* Platform Key
|
|
296
|
+
*/
|
|
279
297
|
platformKey: string,
|
|
280
|
-
): CancelablePromise<Array<LtiKey>> {
|
|
298
|
+
}): CancelablePromise<Array<LtiKey>> {
|
|
281
299
|
return __request(OpenAPI, {
|
|
282
300
|
method: 'GET',
|
|
283
301
|
url: '/api/core/lti/1p3/provider/lti-keys/',
|
|
@@ -288,13 +306,14 @@ export class CoreService {
|
|
|
288
306
|
}
|
|
289
307
|
/**
|
|
290
308
|
* Create a new LTI Provider Key
|
|
291
|
-
* @param requestBody
|
|
292
309
|
* @returns LtiKey
|
|
293
310
|
* @throws ApiError
|
|
294
311
|
*/
|
|
295
|
-
public static coreLti1P3ProviderLtiKeysCreate(
|
|
312
|
+
public static coreLti1P3ProviderLtiKeysCreate({
|
|
313
|
+
requestBody,
|
|
314
|
+
}: {
|
|
296
315
|
requestBody: LtiKey,
|
|
297
|
-
): CancelablePromise<LtiKey> {
|
|
316
|
+
}): CancelablePromise<LtiKey> {
|
|
298
317
|
return __request(OpenAPI, {
|
|
299
318
|
method: 'POST',
|
|
300
319
|
url: '/api/core/lti/1p3/provider/lti-keys/',
|
|
@@ -304,15 +323,19 @@ export class CoreService {
|
|
|
304
323
|
}
|
|
305
324
|
/**
|
|
306
325
|
* Get details about a specific LTI Provider Key
|
|
307
|
-
* @param id
|
|
308
|
-
* @param platformKey Platform Key
|
|
309
326
|
* @returns LtiKey
|
|
310
327
|
* @throws ApiError
|
|
311
328
|
*/
|
|
312
|
-
public static coreLti1P3ProviderLtiKeysRetrieve(
|
|
329
|
+
public static coreLti1P3ProviderLtiKeysRetrieve({
|
|
330
|
+
id,
|
|
331
|
+
platformKey,
|
|
332
|
+
}: {
|
|
313
333
|
id: string,
|
|
334
|
+
/**
|
|
335
|
+
* Platform Key
|
|
336
|
+
*/
|
|
314
337
|
platformKey: string,
|
|
315
|
-
): CancelablePromise<LtiKey> {
|
|
338
|
+
}): CancelablePromise<LtiKey> {
|
|
316
339
|
return __request(OpenAPI, {
|
|
317
340
|
method: 'GET',
|
|
318
341
|
url: '/api/core/lti/1p3/provider/lti-keys/{id}/',
|
|
@@ -326,15 +349,16 @@ export class CoreService {
|
|
|
326
349
|
}
|
|
327
350
|
/**
|
|
328
351
|
* Update an LTI Provider Key
|
|
329
|
-
* @param id
|
|
330
|
-
* @param requestBody
|
|
331
352
|
* @returns LtiKey
|
|
332
353
|
* @throws ApiError
|
|
333
354
|
*/
|
|
334
|
-
public static coreLti1P3ProviderLtiKeysUpdate(
|
|
355
|
+
public static coreLti1P3ProviderLtiKeysUpdate({
|
|
356
|
+
id,
|
|
357
|
+
requestBody,
|
|
358
|
+
}: {
|
|
335
359
|
id: string,
|
|
336
360
|
requestBody: LtiKey,
|
|
337
|
-
): CancelablePromise<LtiKey> {
|
|
361
|
+
}): CancelablePromise<LtiKey> {
|
|
338
362
|
return __request(OpenAPI, {
|
|
339
363
|
method: 'PUT',
|
|
340
364
|
url: '/api/core/lti/1p3/provider/lti-keys/{id}/',
|
|
@@ -349,15 +373,19 @@ export class CoreService {
|
|
|
349
373
|
* Delete an LTI Provider Key
|
|
350
374
|
*
|
|
351
375
|
* **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.
|
|
352
|
-
* @param id
|
|
353
|
-
* @param platformKey Platform Key
|
|
354
376
|
* @returns void
|
|
355
377
|
* @throws ApiError
|
|
356
378
|
*/
|
|
357
|
-
public static coreLti1P3ProviderLtiKeysDestroy(
|
|
379
|
+
public static coreLti1P3ProviderLtiKeysDestroy({
|
|
380
|
+
id,
|
|
381
|
+
platformKey,
|
|
382
|
+
}: {
|
|
358
383
|
id: string,
|
|
384
|
+
/**
|
|
385
|
+
* Platform Key
|
|
386
|
+
*/
|
|
359
387
|
platformKey: string,
|
|
360
|
-
): CancelablePromise<void> {
|
|
388
|
+
}): CancelablePromise<void> {
|
|
361
389
|
return __request(OpenAPI, {
|
|
362
390
|
method: 'DELETE',
|
|
363
391
|
url: '/api/core/lti/1p3/provider/lti-keys/{id}/',
|
|
@@ -371,13 +399,17 @@ export class CoreService {
|
|
|
371
399
|
}
|
|
372
400
|
/**
|
|
373
401
|
* List your LTI Tool's
|
|
374
|
-
* @param platformKey Platform Key
|
|
375
402
|
* @returns LtiTool
|
|
376
403
|
* @throws ApiError
|
|
377
404
|
*/
|
|
378
|
-
public static coreLti1P3ProviderLtiToolsList(
|
|
405
|
+
public static coreLti1P3ProviderLtiToolsList({
|
|
406
|
+
platformKey,
|
|
407
|
+
}: {
|
|
408
|
+
/**
|
|
409
|
+
* Platform Key
|
|
410
|
+
*/
|
|
379
411
|
platformKey: string,
|
|
380
|
-
): CancelablePromise<Array<LtiTool>> {
|
|
412
|
+
}): CancelablePromise<Array<LtiTool>> {
|
|
381
413
|
return __request(OpenAPI, {
|
|
382
414
|
method: 'GET',
|
|
383
415
|
url: '/api/core/lti/1p3/provider/lti-tools/',
|
|
@@ -388,13 +420,14 @@ export class CoreService {
|
|
|
388
420
|
}
|
|
389
421
|
/**
|
|
390
422
|
* Create a new LTI Tool
|
|
391
|
-
* @param requestBody
|
|
392
423
|
* @returns LtiTool
|
|
393
424
|
* @throws ApiError
|
|
394
425
|
*/
|
|
395
|
-
public static coreLti1P3ProviderLtiToolsCreate(
|
|
426
|
+
public static coreLti1P3ProviderLtiToolsCreate({
|
|
427
|
+
requestBody,
|
|
428
|
+
}: {
|
|
396
429
|
requestBody: LtiTool,
|
|
397
|
-
): CancelablePromise<LtiTool> {
|
|
430
|
+
}): CancelablePromise<LtiTool> {
|
|
398
431
|
return __request(OpenAPI, {
|
|
399
432
|
method: 'POST',
|
|
400
433
|
url: '/api/core/lti/1p3/provider/lti-tools/',
|
|
@@ -404,15 +437,19 @@ export class CoreService {
|
|
|
404
437
|
}
|
|
405
438
|
/**
|
|
406
439
|
* Get details about a specific LTI Tool
|
|
407
|
-
* @param id
|
|
408
|
-
* @param platformKey Platform Key
|
|
409
440
|
* @returns LtiTool
|
|
410
441
|
* @throws ApiError
|
|
411
442
|
*/
|
|
412
|
-
public static coreLti1P3ProviderLtiToolsRetrieve(
|
|
443
|
+
public static coreLti1P3ProviderLtiToolsRetrieve({
|
|
444
|
+
id,
|
|
445
|
+
platformKey,
|
|
446
|
+
}: {
|
|
413
447
|
id: string,
|
|
448
|
+
/**
|
|
449
|
+
* Platform Key
|
|
450
|
+
*/
|
|
414
451
|
platformKey: string,
|
|
415
|
-
): CancelablePromise<LtiTool> {
|
|
452
|
+
}): CancelablePromise<LtiTool> {
|
|
416
453
|
return __request(OpenAPI, {
|
|
417
454
|
method: 'GET',
|
|
418
455
|
url: '/api/core/lti/1p3/provider/lti-tools/{id}/',
|
|
@@ -426,15 +463,16 @@ export class CoreService {
|
|
|
426
463
|
}
|
|
427
464
|
/**
|
|
428
465
|
* Update an LTI Tool
|
|
429
|
-
* @param id
|
|
430
|
-
* @param requestBody
|
|
431
466
|
* @returns LtiTool
|
|
432
467
|
* @throws ApiError
|
|
433
468
|
*/
|
|
434
|
-
public static coreLti1P3ProviderLtiToolsUpdate(
|
|
469
|
+
public static coreLti1P3ProviderLtiToolsUpdate({
|
|
470
|
+
id,
|
|
471
|
+
requestBody,
|
|
472
|
+
}: {
|
|
435
473
|
id: string,
|
|
436
474
|
requestBody: LtiTool,
|
|
437
|
-
): CancelablePromise<LtiTool> {
|
|
475
|
+
}): CancelablePromise<LtiTool> {
|
|
438
476
|
return __request(OpenAPI, {
|
|
439
477
|
method: 'PUT',
|
|
440
478
|
url: '/api/core/lti/1p3/provider/lti-tools/{id}/',
|
|
@@ -447,15 +485,19 @@ export class CoreService {
|
|
|
447
485
|
}
|
|
448
486
|
/**
|
|
449
487
|
* Delete an LTI Tool
|
|
450
|
-
* @param id
|
|
451
|
-
* @param platformKey Platform Key
|
|
452
488
|
* @returns void
|
|
453
489
|
* @throws ApiError
|
|
454
490
|
*/
|
|
455
|
-
public static coreLti1P3ProviderLtiToolsDestroy(
|
|
491
|
+
public static coreLti1P3ProviderLtiToolsDestroy({
|
|
492
|
+
id,
|
|
493
|
+
platformKey,
|
|
494
|
+
}: {
|
|
456
495
|
id: string,
|
|
496
|
+
/**
|
|
497
|
+
* Platform Key
|
|
498
|
+
*/
|
|
457
499
|
platformKey: string,
|
|
458
|
-
): CancelablePromise<void> {
|
|
500
|
+
}): CancelablePromise<void> {
|
|
459
501
|
return __request(OpenAPI, {
|
|
460
502
|
method: 'DELETE',
|
|
461
503
|
url: '/api/core/lti/1p3/provider/lti-tools/{id}/',
|
|
@@ -469,13 +511,14 @@ export class CoreService {
|
|
|
469
511
|
}
|
|
470
512
|
/**
|
|
471
513
|
* Get platform logo
|
|
472
|
-
* @param org
|
|
473
514
|
* @returns any
|
|
474
515
|
* @throws ApiError
|
|
475
516
|
*/
|
|
476
|
-
public static coreOrgsDarkModeLogoRetrieve(
|
|
517
|
+
public static coreOrgsDarkModeLogoRetrieve({
|
|
518
|
+
org,
|
|
519
|
+
}: {
|
|
477
520
|
org: string,
|
|
478
|
-
): CancelablePromise<Record<string, any>> {
|
|
521
|
+
}): CancelablePromise<Record<string, any>> {
|
|
479
522
|
return __request(OpenAPI, {
|
|
480
523
|
method: 'GET',
|
|
481
524
|
url: '/api/core/orgs/{org}/dark-mode-logo/',
|
|
@@ -486,15 +529,16 @@ export class CoreService {
|
|
|
486
529
|
}
|
|
487
530
|
/**
|
|
488
531
|
* Upload a new platform logo
|
|
489
|
-
* @param org
|
|
490
|
-
* @param requestBody
|
|
491
532
|
* @returns ImageUpload
|
|
492
533
|
* @throws ApiError
|
|
493
534
|
*/
|
|
494
|
-
public static coreOrgsDarkModeLogoCreateCreate(
|
|
535
|
+
public static coreOrgsDarkModeLogoCreateCreate({
|
|
536
|
+
org,
|
|
537
|
+
requestBody,
|
|
538
|
+
}: {
|
|
495
539
|
org: string,
|
|
496
540
|
requestBody: ImageUpload,
|
|
497
|
-
): CancelablePromise<ImageUpload> {
|
|
541
|
+
}): CancelablePromise<ImageUpload> {
|
|
498
542
|
return __request(OpenAPI, {
|
|
499
543
|
method: 'POST',
|
|
500
544
|
url: '/api/core/orgs/{org}/dark-mode-logo/create/',
|
|
@@ -507,13 +551,14 @@ export class CoreService {
|
|
|
507
551
|
}
|
|
508
552
|
/**
|
|
509
553
|
* Get platform logo
|
|
510
|
-
* @param org
|
|
511
554
|
* @returns any
|
|
512
555
|
* @throws ApiError
|
|
513
556
|
*/
|
|
514
|
-
public static coreOrgsFaviconRetrieve(
|
|
557
|
+
public static coreOrgsFaviconRetrieve({
|
|
558
|
+
org,
|
|
559
|
+
}: {
|
|
515
560
|
org: string,
|
|
516
|
-
): CancelablePromise<Record<string, any>> {
|
|
561
|
+
}): CancelablePromise<Record<string, any>> {
|
|
517
562
|
return __request(OpenAPI, {
|
|
518
563
|
method: 'GET',
|
|
519
564
|
url: '/api/core/orgs/{org}/favicon/',
|
|
@@ -524,15 +569,16 @@ export class CoreService {
|
|
|
524
569
|
}
|
|
525
570
|
/**
|
|
526
571
|
* Upload a new platform logo
|
|
527
|
-
* @param org
|
|
528
|
-
* @param requestBody
|
|
529
572
|
* @returns ImageUpload
|
|
530
573
|
* @throws ApiError
|
|
531
574
|
*/
|
|
532
|
-
public static coreOrgsFaviconCreateCreate(
|
|
575
|
+
public static coreOrgsFaviconCreateCreate({
|
|
576
|
+
org,
|
|
577
|
+
requestBody,
|
|
578
|
+
}: {
|
|
533
579
|
org: string,
|
|
534
580
|
requestBody: ImageUpload,
|
|
535
|
-
): CancelablePromise<ImageUpload> {
|
|
581
|
+
}): CancelablePromise<ImageUpload> {
|
|
536
582
|
return __request(OpenAPI, {
|
|
537
583
|
method: 'POST',
|
|
538
584
|
url: '/api/core/orgs/{org}/favicon/create/',
|
|
@@ -545,13 +591,14 @@ export class CoreService {
|
|
|
545
591
|
}
|
|
546
592
|
/**
|
|
547
593
|
* Get platform logo
|
|
548
|
-
* @param org
|
|
549
594
|
* @returns any
|
|
550
595
|
* @throws ApiError
|
|
551
596
|
*/
|
|
552
|
-
public static coreOrgsLogoRetrieve(
|
|
597
|
+
public static coreOrgsLogoRetrieve({
|
|
598
|
+
org,
|
|
599
|
+
}: {
|
|
553
600
|
org: string,
|
|
554
|
-
): CancelablePromise<Record<string, any>> {
|
|
601
|
+
}): CancelablePromise<Record<string, any>> {
|
|
555
602
|
return __request(OpenAPI, {
|
|
556
603
|
method: 'GET',
|
|
557
604
|
url: '/api/core/orgs/{org}/logo/',
|
|
@@ -562,15 +609,16 @@ export class CoreService {
|
|
|
562
609
|
}
|
|
563
610
|
/**
|
|
564
611
|
* Upload a new platform logo
|
|
565
|
-
* @param org
|
|
566
|
-
* @param requestBody
|
|
567
612
|
* @returns ImageUpload
|
|
568
613
|
* @throws ApiError
|
|
569
614
|
*/
|
|
570
|
-
public static coreOrgsLogoCreateCreate(
|
|
615
|
+
public static coreOrgsLogoCreateCreate({
|
|
616
|
+
org,
|
|
617
|
+
requestBody,
|
|
618
|
+
}: {
|
|
571
619
|
org: string,
|
|
572
620
|
requestBody: ImageUpload,
|
|
573
|
-
): CancelablePromise<ImageUpload> {
|
|
621
|
+
}): CancelablePromise<ImageUpload> {
|
|
574
622
|
return __request(OpenAPI, {
|
|
575
623
|
method: 'POST',
|
|
576
624
|
url: '/api/core/orgs/{org}/logo/create/',
|
|
@@ -582,13 +630,14 @@ export class CoreService {
|
|
|
582
630
|
});
|
|
583
631
|
}
|
|
584
632
|
/**
|
|
585
|
-
* @param org
|
|
586
633
|
* @returns PlatformPublicMetadata
|
|
587
634
|
* @throws ApiError
|
|
588
635
|
*/
|
|
589
|
-
public static coreOrgsMetadataRetrieve(
|
|
636
|
+
public static coreOrgsMetadataRetrieve({
|
|
637
|
+
org,
|
|
638
|
+
}: {
|
|
590
639
|
org: string,
|
|
591
|
-
): CancelablePromise<PlatformPublicMetadata> {
|
|
640
|
+
}): CancelablePromise<PlatformPublicMetadata> {
|
|
592
641
|
return __request(OpenAPI, {
|
|
593
642
|
method: 'GET',
|
|
594
643
|
url: '/api/core/orgs/{org}/metadata/',
|
|
@@ -598,15 +647,16 @@ export class CoreService {
|
|
|
598
647
|
});
|
|
599
648
|
}
|
|
600
649
|
/**
|
|
601
|
-
* @param org
|
|
602
|
-
* @param requestBody
|
|
603
650
|
* @returns PlatformPublicMetadata
|
|
604
651
|
* @throws ApiError
|
|
605
652
|
*/
|
|
606
|
-
public static coreOrgsMetadataUpdate(
|
|
653
|
+
public static coreOrgsMetadataUpdate({
|
|
654
|
+
org,
|
|
655
|
+
requestBody,
|
|
656
|
+
}: {
|
|
607
657
|
org: string,
|
|
608
658
|
requestBody?: PlatformPublicMetadata,
|
|
609
|
-
): CancelablePromise<PlatformPublicMetadata> {
|
|
659
|
+
}): CancelablePromise<PlatformPublicMetadata> {
|
|
610
660
|
return __request(OpenAPI, {
|
|
611
661
|
method: 'PUT',
|
|
612
662
|
url: '/api/core/orgs/{org}/metadata/',
|
|
@@ -618,15 +668,16 @@ export class CoreService {
|
|
|
618
668
|
});
|
|
619
669
|
}
|
|
620
670
|
/**
|
|
621
|
-
* @param org
|
|
622
|
-
* @param requestBody
|
|
623
671
|
* @returns PlatformPublicMetadata
|
|
624
672
|
* @throws ApiError
|
|
625
673
|
*/
|
|
626
|
-
public static coreOrgsMetadataPartialUpdate(
|
|
674
|
+
public static coreOrgsMetadataPartialUpdate({
|
|
675
|
+
org,
|
|
676
|
+
requestBody,
|
|
677
|
+
}: {
|
|
627
678
|
org: string,
|
|
628
679
|
requestBody?: PatchedPlatformPublicMetadata,
|
|
629
|
-
): CancelablePromise<PlatformPublicMetadata> {
|
|
680
|
+
}): CancelablePromise<PlatformPublicMetadata> {
|
|
630
681
|
return __request(OpenAPI, {
|
|
631
682
|
method: 'PATCH',
|
|
632
683
|
url: '/api/core/orgs/{org}/metadata/',
|
|
@@ -639,15 +690,16 @@ export class CoreService {
|
|
|
639
690
|
}
|
|
640
691
|
/**
|
|
641
692
|
* Creates redirect tokens for a URL specified by for a platform
|
|
642
|
-
* @param org
|
|
643
|
-
* @param requestBody
|
|
644
693
|
* @returns RedirectTokenResponse
|
|
645
694
|
* @throws ApiError
|
|
646
695
|
*/
|
|
647
|
-
public static coreOrgsRedirectTokensCreate(
|
|
696
|
+
public static coreOrgsRedirectTokensCreate({
|
|
697
|
+
org,
|
|
698
|
+
requestBody,
|
|
699
|
+
}: {
|
|
648
700
|
org: string,
|
|
649
701
|
requestBody: RedirectTokenRequest,
|
|
650
|
-
): CancelablePromise<RedirectTokenResponse> {
|
|
702
|
+
}): CancelablePromise<RedirectTokenResponse> {
|
|
651
703
|
return __request(OpenAPI, {
|
|
652
704
|
method: 'POST',
|
|
653
705
|
url: '/api/core/orgs/{org}/redirect-tokens/',
|
|
@@ -664,15 +716,16 @@ export class CoreService {
|
|
|
664
716
|
* ```
|
|
665
717
|
* Requires user to be a member of the platform with the token passed
|
|
666
718
|
* ```
|
|
667
|
-
* @param org
|
|
668
|
-
* @param redirectToken
|
|
669
719
|
* @returns RedirectTokenResponse
|
|
670
720
|
* @throws ApiError
|
|
671
721
|
*/
|
|
672
|
-
public static coreOrgsRedirectTokensRetrieve(
|
|
722
|
+
public static coreOrgsRedirectTokensRetrieve({
|
|
723
|
+
org,
|
|
724
|
+
redirectToken,
|
|
725
|
+
}: {
|
|
673
726
|
org: string,
|
|
674
727
|
redirectToken: string,
|
|
675
|
-
): CancelablePromise<RedirectTokenResponse> {
|
|
728
|
+
}): CancelablePromise<RedirectTokenResponse> {
|
|
676
729
|
return __request(OpenAPI, {
|
|
677
730
|
method: 'GET',
|
|
678
731
|
url: '/api/core/orgs/{org}/redirect-tokens/{redirect_token}/',
|
|
@@ -684,15 +737,16 @@ export class CoreService {
|
|
|
684
737
|
}
|
|
685
738
|
/**
|
|
686
739
|
* Delete specific token
|
|
687
|
-
* @param org
|
|
688
|
-
* @param redirectToken
|
|
689
740
|
* @returns void
|
|
690
741
|
* @throws ApiError
|
|
691
742
|
*/
|
|
692
|
-
public static coreOrgsRedirectTokensDeleteDestroy(
|
|
743
|
+
public static coreOrgsRedirectTokensDeleteDestroy({
|
|
744
|
+
org,
|
|
745
|
+
redirectToken,
|
|
746
|
+
}: {
|
|
693
747
|
org: string,
|
|
694
748
|
redirectToken: string,
|
|
695
|
-
): CancelablePromise<void> {
|
|
749
|
+
}): CancelablePromise<void> {
|
|
696
750
|
return __request(OpenAPI, {
|
|
697
751
|
method: 'DELETE',
|
|
698
752
|
url: '/api/core/orgs/{org}/redirect-tokens/{redirect_token}/delete',
|
|
@@ -704,13 +758,14 @@ export class CoreService {
|
|
|
704
758
|
}
|
|
705
759
|
/**
|
|
706
760
|
* Get platform logo
|
|
707
|
-
* @param org
|
|
708
761
|
* @returns any
|
|
709
762
|
* @throws ApiError
|
|
710
763
|
*/
|
|
711
|
-
public static coreOrgsThumbnailRetrieve(
|
|
764
|
+
public static coreOrgsThumbnailRetrieve({
|
|
765
|
+
org,
|
|
766
|
+
}: {
|
|
712
767
|
org: string,
|
|
713
|
-
): CancelablePromise<Record<string, any>> {
|
|
768
|
+
}): CancelablePromise<Record<string, any>> {
|
|
714
769
|
return __request(OpenAPI, {
|
|
715
770
|
method: 'GET',
|
|
716
771
|
url: '/api/core/orgs/{org}/thumbnail/',
|
|
@@ -721,15 +776,16 @@ export class CoreService {
|
|
|
721
776
|
}
|
|
722
777
|
/**
|
|
723
778
|
* Upload a new platform logo
|
|
724
|
-
* @param org
|
|
725
|
-
* @param requestBody
|
|
726
779
|
* @returns ImageUpload
|
|
727
780
|
* @throws ApiError
|
|
728
781
|
*/
|
|
729
|
-
public static coreOrgsThumbnailCreateCreate(
|
|
782
|
+
public static coreOrgsThumbnailCreateCreate({
|
|
783
|
+
org,
|
|
784
|
+
requestBody,
|
|
785
|
+
}: {
|
|
730
786
|
org: string,
|
|
731
787
|
requestBody: ImageUpload,
|
|
732
|
-
): CancelablePromise<ImageUpload> {
|
|
788
|
+
}): CancelablePromise<ImageUpload> {
|
|
733
789
|
return __request(OpenAPI, {
|
|
734
790
|
method: 'POST',
|
|
735
791
|
url: '/api/core/orgs/{org}/thumbnail/create/',
|
|
@@ -752,15 +808,16 @@ export class CoreService {
|
|
|
752
808
|
* key
|
|
753
809
|
* field_key (POST)
|
|
754
810
|
* value (POST)
|
|
755
|
-
* @param key
|
|
756
|
-
* @param userId
|
|
757
811
|
* @returns PlatformList
|
|
758
812
|
* @throws ApiError
|
|
759
813
|
*/
|
|
760
|
-
public static corePlatformRetrieve(
|
|
814
|
+
public static corePlatformRetrieve({
|
|
815
|
+
key,
|
|
816
|
+
userId,
|
|
817
|
+
}: {
|
|
761
818
|
key: string,
|
|
762
819
|
userId?: number,
|
|
763
|
-
): CancelablePromise<PlatformList> {
|
|
820
|
+
}): CancelablePromise<PlatformList> {
|
|
764
821
|
return __request(OpenAPI, {
|
|
765
822
|
method: 'GET',
|
|
766
823
|
url: '/api/core/platform/',
|
|
@@ -784,13 +841,14 @@ export class CoreService {
|
|
|
784
841
|
* lms_url
|
|
785
842
|
* cms_url
|
|
786
843
|
* portal_url
|
|
787
|
-
* @param requestBody
|
|
788
844
|
* @returns PlatformList
|
|
789
845
|
* @throws ApiError
|
|
790
846
|
*/
|
|
791
|
-
public static corePlatformCreate(
|
|
847
|
+
public static corePlatformCreate({
|
|
848
|
+
requestBody,
|
|
849
|
+
}: {
|
|
792
850
|
requestBody: PlatformUpdatePostRequest,
|
|
793
|
-
): CancelablePromise<PlatformList> {
|
|
851
|
+
}): CancelablePromise<PlatformList> {
|
|
794
852
|
return __request(OpenAPI, {
|
|
795
853
|
method: 'POST',
|
|
796
854
|
url: '/api/core/platform/',
|
|
@@ -800,13 +858,17 @@ export class CoreService {
|
|
|
800
858
|
}
|
|
801
859
|
/**
|
|
802
860
|
* List Platform API Key's belonging to the target platform
|
|
803
|
-
* @param platformKey Platform key of target platform
|
|
804
861
|
* @returns PlatformApiKey
|
|
805
862
|
* @throws ApiError
|
|
806
863
|
*/
|
|
807
|
-
public static corePlatformApiTokensList(
|
|
864
|
+
public static corePlatformApiTokensList({
|
|
865
|
+
platformKey,
|
|
866
|
+
}: {
|
|
867
|
+
/**
|
|
868
|
+
* Platform key of target platform
|
|
869
|
+
*/
|
|
808
870
|
platformKey: string,
|
|
809
|
-
): CancelablePromise<Array<PlatformApiKey>> {
|
|
871
|
+
}): CancelablePromise<Array<PlatformApiKey>> {
|
|
810
872
|
return __request(OpenAPI, {
|
|
811
873
|
method: 'GET',
|
|
812
874
|
url: '/api/core/platform/api-tokens/',
|
|
@@ -817,13 +879,14 @@ export class CoreService {
|
|
|
817
879
|
}
|
|
818
880
|
/**
|
|
819
881
|
* Create a new Platform Api Key for the target platform
|
|
820
|
-
* @param requestBody
|
|
821
882
|
* @returns PlatformApiKey
|
|
822
883
|
* @throws ApiError
|
|
823
884
|
*/
|
|
824
|
-
public static corePlatformApiTokensCreate(
|
|
885
|
+
public static corePlatformApiTokensCreate({
|
|
886
|
+
requestBody,
|
|
887
|
+
}: {
|
|
825
888
|
requestBody: PlatformApiKey,
|
|
826
|
-
): CancelablePromise<PlatformApiKey> {
|
|
889
|
+
}): CancelablePromise<PlatformApiKey> {
|
|
827
890
|
return __request(OpenAPI, {
|
|
828
891
|
method: 'POST',
|
|
829
892
|
url: '/api/core/platform/api-tokens/',
|
|
@@ -833,15 +896,19 @@ export class CoreService {
|
|
|
833
896
|
}
|
|
834
897
|
/**
|
|
835
898
|
* Delete Platform Api Key by name in the target platform
|
|
836
|
-
* @param name
|
|
837
|
-
* @param platformKey Platform key of target platform
|
|
838
899
|
* @returns void
|
|
839
900
|
* @throws ApiError
|
|
840
901
|
*/
|
|
841
|
-
public static corePlatformApiTokensDestroy(
|
|
902
|
+
public static corePlatformApiTokensDestroy({
|
|
903
|
+
name,
|
|
904
|
+
platformKey,
|
|
905
|
+
}: {
|
|
842
906
|
name: string,
|
|
907
|
+
/**
|
|
908
|
+
* Platform key of target platform
|
|
909
|
+
*/
|
|
843
910
|
platformKey: string,
|
|
844
|
-
): CancelablePromise<void> {
|
|
911
|
+
}): CancelablePromise<void> {
|
|
845
912
|
return __request(OpenAPI, {
|
|
846
913
|
method: 'DELETE',
|
|
847
914
|
url: '/api/core/platform/api-tokens/{name}',
|
|
@@ -865,15 +932,16 @@ export class CoreService {
|
|
|
865
932
|
* key
|
|
866
933
|
* field_key (POST)
|
|
867
934
|
* value (POST)
|
|
868
|
-
* @param key
|
|
869
|
-
* @param userId
|
|
870
935
|
* @returns any
|
|
871
936
|
* @throws ApiError
|
|
872
937
|
*/
|
|
873
|
-
public static corePlatformConfigSiteRetrieve(
|
|
938
|
+
public static corePlatformConfigSiteRetrieve({
|
|
939
|
+
key,
|
|
940
|
+
userId,
|
|
941
|
+
}: {
|
|
874
942
|
key: string,
|
|
875
943
|
userId?: number,
|
|
876
|
-
): CancelablePromise<Record<string, any>> {
|
|
944
|
+
}): CancelablePromise<Record<string, any>> {
|
|
877
945
|
return __request(OpenAPI, {
|
|
878
946
|
method: 'GET',
|
|
879
947
|
url: '/api/core/platform/config/site/',
|
|
@@ -895,13 +963,14 @@ export class CoreService {
|
|
|
895
963
|
* key
|
|
896
964
|
* field_key (POST)
|
|
897
965
|
* value (POST)
|
|
898
|
-
* @param requestBody
|
|
899
966
|
* @returns any
|
|
900
967
|
* @throws ApiError
|
|
901
968
|
*/
|
|
902
|
-
public static corePlatformConfigSiteCreate(
|
|
969
|
+
public static corePlatformConfigSiteCreate({
|
|
970
|
+
requestBody,
|
|
971
|
+
}: {
|
|
903
972
|
requestBody?: Record<string, any>,
|
|
904
|
-
): CancelablePromise<Record<string, any>> {
|
|
973
|
+
}): CancelablePromise<Record<string, any>> {
|
|
905
974
|
return __request(OpenAPI, {
|
|
906
975
|
method: 'POST',
|
|
907
976
|
url: '/api/core/platform/config/site/',
|
|
@@ -920,23 +989,24 @@ export class CoreService {
|
|
|
920
989
|
* sort
|
|
921
990
|
*
|
|
922
991
|
* is_admin: Return tenant admin users
|
|
923
|
-
* @param page
|
|
924
|
-
* @param pageSize
|
|
925
|
-
* @param platformKey
|
|
926
|
-
* @param platformOrg
|
|
927
|
-
* @param query
|
|
928
|
-
* @param sort
|
|
929
992
|
* @returns UserPlatformManagementListViewGetResponse
|
|
930
993
|
* @throws ApiError
|
|
931
994
|
*/
|
|
932
|
-
public static corePlatformUsersRetrieve(
|
|
995
|
+
public static corePlatformUsersRetrieve({
|
|
996
|
+
page,
|
|
997
|
+
pageSize,
|
|
998
|
+
platformKey,
|
|
999
|
+
platformOrg,
|
|
1000
|
+
query,
|
|
1001
|
+
sort,
|
|
1002
|
+
}: {
|
|
933
1003
|
page?: number,
|
|
934
1004
|
pageSize?: number,
|
|
935
1005
|
platformKey?: string,
|
|
936
1006
|
platformOrg?: string,
|
|
937
1007
|
query?: string,
|
|
938
1008
|
sort?: string,
|
|
939
|
-
): CancelablePromise<UserPlatformManagementListViewGetResponse> {
|
|
1009
|
+
}): CancelablePromise<UserPlatformManagementListViewGetResponse> {
|
|
940
1010
|
return __request(OpenAPI, {
|
|
941
1011
|
method: 'GET',
|
|
942
1012
|
url: '/api/core/platform/users/',
|
|
@@ -950,6 +1020,537 @@ export class CoreService {
|
|
|
950
1020
|
},
|
|
951
1021
|
});
|
|
952
1022
|
}
|
|
1023
|
+
/**
|
|
1024
|
+
* List RBAC groups
|
|
1025
|
+
* Retrieve a list of RBAC groups. Can be filtered by platform_key.
|
|
1026
|
+
* @returns PaginatedRbacGroupList
|
|
1027
|
+
* @throws ApiError
|
|
1028
|
+
*/
|
|
1029
|
+
public static coreRbacGroupsList({
|
|
1030
|
+
page,
|
|
1031
|
+
pageSize,
|
|
1032
|
+
platformKey,
|
|
1033
|
+
}: {
|
|
1034
|
+
/**
|
|
1035
|
+
* A page number within the paginated result set.
|
|
1036
|
+
*/
|
|
1037
|
+
page?: number,
|
|
1038
|
+
/**
|
|
1039
|
+
* Number of results to return per page.
|
|
1040
|
+
*/
|
|
1041
|
+
pageSize?: number,
|
|
1042
|
+
/**
|
|
1043
|
+
* Filter groups by platform key
|
|
1044
|
+
*/
|
|
1045
|
+
platformKey?: string,
|
|
1046
|
+
}): CancelablePromise<PaginatedRbacGroupList> {
|
|
1047
|
+
return __request(OpenAPI, {
|
|
1048
|
+
method: 'GET',
|
|
1049
|
+
url: '/api/core/rbac/groups/',
|
|
1050
|
+
query: {
|
|
1051
|
+
'page': page,
|
|
1052
|
+
'page_size': pageSize,
|
|
1053
|
+
'platform_key': platformKey,
|
|
1054
|
+
},
|
|
1055
|
+
});
|
|
1056
|
+
}
|
|
1057
|
+
/**
|
|
1058
|
+
* Create RBAC group
|
|
1059
|
+
* Create a new RBAC group for a platform. Users can be assigned during creation.
|
|
1060
|
+
* @returns RbacGroup
|
|
1061
|
+
* @throws ApiError
|
|
1062
|
+
*/
|
|
1063
|
+
public static coreRbacGroupsCreate({
|
|
1064
|
+
requestBody,
|
|
1065
|
+
}: {
|
|
1066
|
+
requestBody: RbacGroup,
|
|
1067
|
+
}): CancelablePromise<RbacGroup> {
|
|
1068
|
+
return __request(OpenAPI, {
|
|
1069
|
+
method: 'POST',
|
|
1070
|
+
url: '/api/core/rbac/groups/',
|
|
1071
|
+
body: requestBody,
|
|
1072
|
+
mediaType: 'application/json',
|
|
1073
|
+
errors: {
|
|
1074
|
+
400: `Invalid input data. Common errors include:
|
|
1075
|
+
- Users do not belong to the specified platform
|
|
1076
|
+
- Invalid user IDs provided`,
|
|
1077
|
+
},
|
|
1078
|
+
});
|
|
1079
|
+
}
|
|
1080
|
+
/**
|
|
1081
|
+
* Retrieve RBAC group
|
|
1082
|
+
* Retrieve details of a specific RBAC group including assigned users.
|
|
1083
|
+
* @returns RbacGroup
|
|
1084
|
+
* @throws ApiError
|
|
1085
|
+
*/
|
|
1086
|
+
public static coreRbacGroupsRetrieve({
|
|
1087
|
+
id,
|
|
1088
|
+
}: {
|
|
1089
|
+
/**
|
|
1090
|
+
* A unique integer value identifying this RBAC Group.
|
|
1091
|
+
*/
|
|
1092
|
+
id: number,
|
|
1093
|
+
}): CancelablePromise<RbacGroup> {
|
|
1094
|
+
return __request(OpenAPI, {
|
|
1095
|
+
method: 'GET',
|
|
1096
|
+
url: '/api/core/rbac/groups/{id}/',
|
|
1097
|
+
path: {
|
|
1098
|
+
'id': id,
|
|
1099
|
+
},
|
|
1100
|
+
errors: {
|
|
1101
|
+
404: `Group not found`,
|
|
1102
|
+
},
|
|
1103
|
+
});
|
|
1104
|
+
}
|
|
1105
|
+
/**
|
|
1106
|
+
* Update RBAC group
|
|
1107
|
+
* Update an existing RBAC group. Platform validation applies for user assignments.
|
|
1108
|
+
* @returns RbacGroup
|
|
1109
|
+
* @throws ApiError
|
|
1110
|
+
*/
|
|
1111
|
+
public static coreRbacGroupsUpdate({
|
|
1112
|
+
id,
|
|
1113
|
+
requestBody,
|
|
1114
|
+
}: {
|
|
1115
|
+
/**
|
|
1116
|
+
* A unique integer value identifying this RBAC Group.
|
|
1117
|
+
*/
|
|
1118
|
+
id: number,
|
|
1119
|
+
requestBody: RbacGroup,
|
|
1120
|
+
}): CancelablePromise<RbacGroup> {
|
|
1121
|
+
return __request(OpenAPI, {
|
|
1122
|
+
method: 'PUT',
|
|
1123
|
+
url: '/api/core/rbac/groups/{id}/',
|
|
1124
|
+
path: {
|
|
1125
|
+
'id': id,
|
|
1126
|
+
},
|
|
1127
|
+
body: requestBody,
|
|
1128
|
+
mediaType: 'application/json',
|
|
1129
|
+
errors: {
|
|
1130
|
+
400: `Invalid input data. Common errors include:
|
|
1131
|
+
- Users do not belong to the specified platform
|
|
1132
|
+
- Invalid user IDs provided`,
|
|
1133
|
+
404: `Group not found`,
|
|
1134
|
+
},
|
|
1135
|
+
});
|
|
1136
|
+
}
|
|
1137
|
+
/**
|
|
1138
|
+
* Partially update RBAC group
|
|
1139
|
+
* Partially update an existing RBAC group. Platform validation applies for user assignments.
|
|
1140
|
+
* @returns RbacGroup
|
|
1141
|
+
* @throws ApiError
|
|
1142
|
+
*/
|
|
1143
|
+
public static coreRbacGroupsPartialUpdate({
|
|
1144
|
+
id,
|
|
1145
|
+
requestBody,
|
|
1146
|
+
}: {
|
|
1147
|
+
/**
|
|
1148
|
+
* A unique integer value identifying this RBAC Group.
|
|
1149
|
+
*/
|
|
1150
|
+
id: number,
|
|
1151
|
+
requestBody?: PatchedRbacGroup,
|
|
1152
|
+
}): CancelablePromise<RbacGroup> {
|
|
1153
|
+
return __request(OpenAPI, {
|
|
1154
|
+
method: 'PATCH',
|
|
1155
|
+
url: '/api/core/rbac/groups/{id}/',
|
|
1156
|
+
path: {
|
|
1157
|
+
'id': id,
|
|
1158
|
+
},
|
|
1159
|
+
body: requestBody,
|
|
1160
|
+
mediaType: 'application/json',
|
|
1161
|
+
errors: {
|
|
1162
|
+
400: `Invalid input data. Common errors include:
|
|
1163
|
+
- Users do not belong to the specified platform
|
|
1164
|
+
- Invalid user IDs provided`,
|
|
1165
|
+
404: `Group not found`,
|
|
1166
|
+
},
|
|
1167
|
+
});
|
|
1168
|
+
}
|
|
1169
|
+
/**
|
|
1170
|
+
* Delete RBAC group
|
|
1171
|
+
* Delete an RBAC group and all associated group role assignments.
|
|
1172
|
+
* @returns void
|
|
1173
|
+
* @throws ApiError
|
|
1174
|
+
*/
|
|
1175
|
+
public static coreRbacGroupsDestroy({
|
|
1176
|
+
id,
|
|
1177
|
+
platformKey,
|
|
1178
|
+
}: {
|
|
1179
|
+
/**
|
|
1180
|
+
* A unique integer value identifying this RBAC Group.
|
|
1181
|
+
*/
|
|
1182
|
+
id: number,
|
|
1183
|
+
/**
|
|
1184
|
+
* platform key for authorization check
|
|
1185
|
+
*/
|
|
1186
|
+
platformKey?: string,
|
|
1187
|
+
}): CancelablePromise<void> {
|
|
1188
|
+
return __request(OpenAPI, {
|
|
1189
|
+
method: 'DELETE',
|
|
1190
|
+
url: '/api/core/rbac/groups/{id}/',
|
|
1191
|
+
path: {
|
|
1192
|
+
'id': id,
|
|
1193
|
+
},
|
|
1194
|
+
query: {
|
|
1195
|
+
'platform_key': platformKey,
|
|
1196
|
+
},
|
|
1197
|
+
errors: {
|
|
1198
|
+
404: `Group not found`,
|
|
1199
|
+
},
|
|
1200
|
+
});
|
|
1201
|
+
}
|
|
1202
|
+
/**
|
|
1203
|
+
* List RBAC policies
|
|
1204
|
+
* Retrieve a list of RBAC policies. Can be filtered by platform_key or role_id.
|
|
1205
|
+
* @returns PaginatedRbacPolicyList
|
|
1206
|
+
* @throws ApiError
|
|
1207
|
+
*/
|
|
1208
|
+
public static coreRbacPoliciesList({
|
|
1209
|
+
page,
|
|
1210
|
+
pageSize,
|
|
1211
|
+
platformKey,
|
|
1212
|
+
roleId,
|
|
1213
|
+
}: {
|
|
1214
|
+
/**
|
|
1215
|
+
* A page number within the paginated result set.
|
|
1216
|
+
*/
|
|
1217
|
+
page?: number,
|
|
1218
|
+
/**
|
|
1219
|
+
* Number of results to return per page.
|
|
1220
|
+
*/
|
|
1221
|
+
pageSize?: number,
|
|
1222
|
+
/**
|
|
1223
|
+
* Filter policies by platform key
|
|
1224
|
+
*/
|
|
1225
|
+
platformKey?: string,
|
|
1226
|
+
/**
|
|
1227
|
+
* Filter policies by role ID
|
|
1228
|
+
*/
|
|
1229
|
+
roleId?: number,
|
|
1230
|
+
}): CancelablePromise<PaginatedRbacPolicyList> {
|
|
1231
|
+
return __request(OpenAPI, {
|
|
1232
|
+
method: 'GET',
|
|
1233
|
+
url: '/api/core/rbac/policies/',
|
|
1234
|
+
query: {
|
|
1235
|
+
'page': page,
|
|
1236
|
+
'page_size': pageSize,
|
|
1237
|
+
'platform_key': platformKey,
|
|
1238
|
+
'role_id': roleId,
|
|
1239
|
+
},
|
|
1240
|
+
});
|
|
1241
|
+
}
|
|
1242
|
+
/**
|
|
1243
|
+
* Create RBAC policy
|
|
1244
|
+
* Create a new RBAC policy that defines resource access for a role
|
|
1245
|
+
* @returns RbacPolicy
|
|
1246
|
+
* @throws ApiError
|
|
1247
|
+
*/
|
|
1248
|
+
public static coreRbacPoliciesCreate({
|
|
1249
|
+
requestBody,
|
|
1250
|
+
}: {
|
|
1251
|
+
requestBody: RbacPolicy,
|
|
1252
|
+
}): CancelablePromise<RbacPolicy> {
|
|
1253
|
+
return __request(OpenAPI, {
|
|
1254
|
+
method: 'POST',
|
|
1255
|
+
url: '/api/core/rbac/policies/',
|
|
1256
|
+
body: requestBody,
|
|
1257
|
+
mediaType: 'application/json',
|
|
1258
|
+
errors: {
|
|
1259
|
+
400: `Invalid input data. Common errors include: invalid user/group IDs, users/groups not belonging to the platform, or invalid resource paths.`,
|
|
1260
|
+
},
|
|
1261
|
+
});
|
|
1262
|
+
}
|
|
1263
|
+
/**
|
|
1264
|
+
* Retrieve RBAC policy
|
|
1265
|
+
* Retrieve details of a specific RBAC policy, including role, platform, resources, users, and groups.
|
|
1266
|
+
* @returns RbacPolicy
|
|
1267
|
+
* @throws ApiError
|
|
1268
|
+
*/
|
|
1269
|
+
public static coreRbacPoliciesRetrieve({
|
|
1270
|
+
id,
|
|
1271
|
+
}: {
|
|
1272
|
+
/**
|
|
1273
|
+
* A unique integer value identifying this RBAC Policy.
|
|
1274
|
+
*/
|
|
1275
|
+
id: number,
|
|
1276
|
+
}): CancelablePromise<RbacPolicy> {
|
|
1277
|
+
return __request(OpenAPI, {
|
|
1278
|
+
method: 'GET',
|
|
1279
|
+
url: '/api/core/rbac/policies/{id}/',
|
|
1280
|
+
path: {
|
|
1281
|
+
'id': id,
|
|
1282
|
+
},
|
|
1283
|
+
errors: {
|
|
1284
|
+
404: `Policy not found`,
|
|
1285
|
+
},
|
|
1286
|
+
});
|
|
1287
|
+
}
|
|
1288
|
+
/**
|
|
1289
|
+
* Update RBAC policy
|
|
1290
|
+
* Update an existing RBAC policy.
|
|
1291
|
+
* @returns RbacPolicy
|
|
1292
|
+
* @throws ApiError
|
|
1293
|
+
*/
|
|
1294
|
+
public static coreRbacPoliciesUpdate({
|
|
1295
|
+
id,
|
|
1296
|
+
requestBody,
|
|
1297
|
+
}: {
|
|
1298
|
+
/**
|
|
1299
|
+
* A unique integer value identifying this RBAC Policy.
|
|
1300
|
+
*/
|
|
1301
|
+
id: number,
|
|
1302
|
+
requestBody: RbacPolicy,
|
|
1303
|
+
}): CancelablePromise<RbacPolicy> {
|
|
1304
|
+
return __request(OpenAPI, {
|
|
1305
|
+
method: 'PUT',
|
|
1306
|
+
url: '/api/core/rbac/policies/{id}/',
|
|
1307
|
+
path: {
|
|
1308
|
+
'id': id,
|
|
1309
|
+
},
|
|
1310
|
+
body: requestBody,
|
|
1311
|
+
mediaType: 'application/json',
|
|
1312
|
+
errors: {
|
|
1313
|
+
400: `Invalid input data. Common errors include: invalid user/group IDs, users/groups not belonging to the platform, or invalid resource paths.`,
|
|
1314
|
+
404: `Policy not found`,
|
|
1315
|
+
},
|
|
1316
|
+
});
|
|
1317
|
+
}
|
|
1318
|
+
/**
|
|
1319
|
+
* Partially update RBAC policy
|
|
1320
|
+
* Partially update an existing RBAC policy. Only provided fields will be updated.
|
|
1321
|
+
* @returns RbacPolicy
|
|
1322
|
+
* @throws ApiError
|
|
1323
|
+
*/
|
|
1324
|
+
public static coreRbacPoliciesPartialUpdate({
|
|
1325
|
+
id,
|
|
1326
|
+
requestBody,
|
|
1327
|
+
}: {
|
|
1328
|
+
/**
|
|
1329
|
+
* A unique integer value identifying this RBAC Policy.
|
|
1330
|
+
*/
|
|
1331
|
+
id: number,
|
|
1332
|
+
requestBody?: PatchedRbacPolicy,
|
|
1333
|
+
}): CancelablePromise<RbacPolicy> {
|
|
1334
|
+
return __request(OpenAPI, {
|
|
1335
|
+
method: 'PATCH',
|
|
1336
|
+
url: '/api/core/rbac/policies/{id}/',
|
|
1337
|
+
path: {
|
|
1338
|
+
'id': id,
|
|
1339
|
+
},
|
|
1340
|
+
body: requestBody,
|
|
1341
|
+
mediaType: 'application/json',
|
|
1342
|
+
errors: {
|
|
1343
|
+
400: `Invalid input data. Common errors include: invalid user/group IDs, users/groups not belonging to the platform, or invalid resource paths.`,
|
|
1344
|
+
404: `Policy not found`,
|
|
1345
|
+
},
|
|
1346
|
+
});
|
|
1347
|
+
}
|
|
1348
|
+
/**
|
|
1349
|
+
* Delete RBAC policy
|
|
1350
|
+
* Delete an RBAC policy.
|
|
1351
|
+
* @returns void
|
|
1352
|
+
* @throws ApiError
|
|
1353
|
+
*/
|
|
1354
|
+
public static coreRbacPoliciesDestroy({
|
|
1355
|
+
id,
|
|
1356
|
+
platformKey,
|
|
1357
|
+
}: {
|
|
1358
|
+
/**
|
|
1359
|
+
* A unique integer value identifying this RBAC Policy.
|
|
1360
|
+
*/
|
|
1361
|
+
id: number,
|
|
1362
|
+
/**
|
|
1363
|
+
* platform key for authorization check
|
|
1364
|
+
*/
|
|
1365
|
+
platformKey?: string,
|
|
1366
|
+
}): CancelablePromise<void> {
|
|
1367
|
+
return __request(OpenAPI, {
|
|
1368
|
+
method: 'DELETE',
|
|
1369
|
+
url: '/api/core/rbac/policies/{id}/',
|
|
1370
|
+
path: {
|
|
1371
|
+
'id': id,
|
|
1372
|
+
},
|
|
1373
|
+
query: {
|
|
1374
|
+
'platform_key': platformKey,
|
|
1375
|
+
},
|
|
1376
|
+
errors: {
|
|
1377
|
+
404: `Policy not found`,
|
|
1378
|
+
},
|
|
1379
|
+
});
|
|
1380
|
+
}
|
|
1381
|
+
/**
|
|
1382
|
+
* List RBAC roles
|
|
1383
|
+
* Retrieve a list of RBAC roles. Can be filtered by platform_key.
|
|
1384
|
+
* @returns PaginatedRbacRoleList
|
|
1385
|
+
* @throws ApiError
|
|
1386
|
+
*/
|
|
1387
|
+
public static coreRbacRolesList({
|
|
1388
|
+
page,
|
|
1389
|
+
pageSize,
|
|
1390
|
+
platformKey,
|
|
1391
|
+
}: {
|
|
1392
|
+
/**
|
|
1393
|
+
* A page number within the paginated result set.
|
|
1394
|
+
*/
|
|
1395
|
+
page?: number,
|
|
1396
|
+
/**
|
|
1397
|
+
* Number of results to return per page.
|
|
1398
|
+
*/
|
|
1399
|
+
pageSize?: number,
|
|
1400
|
+
/**
|
|
1401
|
+
* Filter roles by platform key
|
|
1402
|
+
*/
|
|
1403
|
+
platformKey?: string,
|
|
1404
|
+
}): CancelablePromise<PaginatedRbacRoleList> {
|
|
1405
|
+
return __request(OpenAPI, {
|
|
1406
|
+
method: 'GET',
|
|
1407
|
+
url: '/api/core/rbac/roles/',
|
|
1408
|
+
query: {
|
|
1409
|
+
'page': page,
|
|
1410
|
+
'page_size': pageSize,
|
|
1411
|
+
'platform_key': platformKey,
|
|
1412
|
+
},
|
|
1413
|
+
});
|
|
1414
|
+
}
|
|
1415
|
+
/**
|
|
1416
|
+
* Create RBAC role
|
|
1417
|
+
* Create a new RBAC role for a platform.
|
|
1418
|
+
* @returns RbacRole
|
|
1419
|
+
* @throws ApiError
|
|
1420
|
+
*/
|
|
1421
|
+
public static coreRbacRolesCreate({
|
|
1422
|
+
requestBody,
|
|
1423
|
+
}: {
|
|
1424
|
+
requestBody: RbacRole,
|
|
1425
|
+
}): CancelablePromise<RbacRole> {
|
|
1426
|
+
return __request(OpenAPI, {
|
|
1427
|
+
method: 'POST',
|
|
1428
|
+
url: '/api/core/rbac/roles/',
|
|
1429
|
+
body: requestBody,
|
|
1430
|
+
mediaType: 'application/json',
|
|
1431
|
+
errors: {
|
|
1432
|
+
400: `Invalid input data`,
|
|
1433
|
+
},
|
|
1434
|
+
});
|
|
1435
|
+
}
|
|
1436
|
+
/**
|
|
1437
|
+
* Retrieve RBAC role
|
|
1438
|
+
* Retrieve details of a specific RBAC role.
|
|
1439
|
+
* @returns RbacRole
|
|
1440
|
+
* @throws ApiError
|
|
1441
|
+
*/
|
|
1442
|
+
public static coreRbacRolesRetrieve({
|
|
1443
|
+
id,
|
|
1444
|
+
}: {
|
|
1445
|
+
/**
|
|
1446
|
+
* A unique integer value identifying this RBAC Role.
|
|
1447
|
+
*/
|
|
1448
|
+
id: number,
|
|
1449
|
+
}): CancelablePromise<RbacRole> {
|
|
1450
|
+
return __request(OpenAPI, {
|
|
1451
|
+
method: 'GET',
|
|
1452
|
+
url: '/api/core/rbac/roles/{id}/',
|
|
1453
|
+
path: {
|
|
1454
|
+
'id': id,
|
|
1455
|
+
},
|
|
1456
|
+
errors: {
|
|
1457
|
+
404: `Role not found`,
|
|
1458
|
+
},
|
|
1459
|
+
});
|
|
1460
|
+
}
|
|
1461
|
+
/**
|
|
1462
|
+
* Update RBAC role
|
|
1463
|
+
* Update an existing RBAC role.
|
|
1464
|
+
* @returns RbacRole
|
|
1465
|
+
* @throws ApiError
|
|
1466
|
+
*/
|
|
1467
|
+
public static coreRbacRolesUpdate({
|
|
1468
|
+
id,
|
|
1469
|
+
requestBody,
|
|
1470
|
+
}: {
|
|
1471
|
+
/**
|
|
1472
|
+
* A unique integer value identifying this RBAC Role.
|
|
1473
|
+
*/
|
|
1474
|
+
id: number,
|
|
1475
|
+
requestBody: RbacRole,
|
|
1476
|
+
}): CancelablePromise<RbacRole> {
|
|
1477
|
+
return __request(OpenAPI, {
|
|
1478
|
+
method: 'PUT',
|
|
1479
|
+
url: '/api/core/rbac/roles/{id}/',
|
|
1480
|
+
path: {
|
|
1481
|
+
'id': id,
|
|
1482
|
+
},
|
|
1483
|
+
body: requestBody,
|
|
1484
|
+
mediaType: 'application/json',
|
|
1485
|
+
errors: {
|
|
1486
|
+
400: `Invalid input data`,
|
|
1487
|
+
404: `Role not found`,
|
|
1488
|
+
},
|
|
1489
|
+
});
|
|
1490
|
+
}
|
|
1491
|
+
/**
|
|
1492
|
+
* Partially update RBAC role
|
|
1493
|
+
* Partially update an existing RBAC role.
|
|
1494
|
+
* @returns RbacRole
|
|
1495
|
+
* @throws ApiError
|
|
1496
|
+
*/
|
|
1497
|
+
public static coreRbacRolesPartialUpdate({
|
|
1498
|
+
id,
|
|
1499
|
+
requestBody,
|
|
1500
|
+
}: {
|
|
1501
|
+
/**
|
|
1502
|
+
* A unique integer value identifying this RBAC Role.
|
|
1503
|
+
*/
|
|
1504
|
+
id: number,
|
|
1505
|
+
requestBody?: PatchedRbacRole,
|
|
1506
|
+
}): CancelablePromise<RbacRole> {
|
|
1507
|
+
return __request(OpenAPI, {
|
|
1508
|
+
method: 'PATCH',
|
|
1509
|
+
url: '/api/core/rbac/roles/{id}/',
|
|
1510
|
+
path: {
|
|
1511
|
+
'id': id,
|
|
1512
|
+
},
|
|
1513
|
+
body: requestBody,
|
|
1514
|
+
mediaType: 'application/json',
|
|
1515
|
+
errors: {
|
|
1516
|
+
400: `Invalid input data`,
|
|
1517
|
+
404: `Role not found`,
|
|
1518
|
+
},
|
|
1519
|
+
});
|
|
1520
|
+
}
|
|
1521
|
+
/**
|
|
1522
|
+
* Delete RBAC role
|
|
1523
|
+
* Delete an RBAC role.
|
|
1524
|
+
* @returns void
|
|
1525
|
+
* @throws ApiError
|
|
1526
|
+
*/
|
|
1527
|
+
public static coreRbacRolesDestroy({
|
|
1528
|
+
id,
|
|
1529
|
+
platformKey,
|
|
1530
|
+
}: {
|
|
1531
|
+
/**
|
|
1532
|
+
* A unique integer value identifying this RBAC Role.
|
|
1533
|
+
*/
|
|
1534
|
+
id: number,
|
|
1535
|
+
/**
|
|
1536
|
+
* platform key for authorization check
|
|
1537
|
+
*/
|
|
1538
|
+
platformKey?: string,
|
|
1539
|
+
}): CancelablePromise<void> {
|
|
1540
|
+
return __request(OpenAPI, {
|
|
1541
|
+
method: 'DELETE',
|
|
1542
|
+
url: '/api/core/rbac/roles/{id}/',
|
|
1543
|
+
path: {
|
|
1544
|
+
'id': id,
|
|
1545
|
+
},
|
|
1546
|
+
query: {
|
|
1547
|
+
'platform_key': platformKey,
|
|
1548
|
+
},
|
|
1549
|
+
errors: {
|
|
1550
|
+
404: `Role not found`,
|
|
1551
|
+
},
|
|
1552
|
+
});
|
|
1553
|
+
}
|
|
953
1554
|
/**
|
|
954
1555
|
* Invalidate all tokens for the authenticated user
|
|
955
1556
|
* @returns any No response body
|
|
@@ -963,13 +1564,14 @@ export class CoreService {
|
|
|
963
1564
|
}
|
|
964
1565
|
/**
|
|
965
1566
|
* POST signals/edx/
|
|
966
|
-
* @param requestBody
|
|
967
1567
|
* @returns any No response body
|
|
968
1568
|
* @throws ApiError
|
|
969
1569
|
*/
|
|
970
|
-
public static coreSignalsEdxCreate(
|
|
1570
|
+
public static coreSignalsEdxCreate({
|
|
1571
|
+
requestBody,
|
|
1572
|
+
}: {
|
|
971
1573
|
requestBody: EdxSignalReceiverRequest,
|
|
972
|
-
): CancelablePromise<any> {
|
|
1574
|
+
}): CancelablePromise<any> {
|
|
973
1575
|
return __request(OpenAPI, {
|
|
974
1576
|
method: 'POST',
|
|
975
1577
|
url: '/api/core/signals/edx/',
|
|
@@ -1081,13 +1683,14 @@ export class CoreService {
|
|
|
1081
1683
|
}
|
|
1082
1684
|
/**
|
|
1083
1685
|
* Initiates the account deletion process for the authenticated user or specified username.
|
|
1084
|
-
* @param requestBody
|
|
1085
1686
|
* @returns UserDeleteAPIResponse
|
|
1086
1687
|
* @throws ApiError
|
|
1087
1688
|
*/
|
|
1088
|
-
public static coreUsersDeleteCreate(
|
|
1689
|
+
public static coreUsersDeleteCreate({
|
|
1690
|
+
requestBody,
|
|
1691
|
+
}: {
|
|
1089
1692
|
requestBody?: UserDeleteAPIRequest,
|
|
1090
|
-
): CancelablePromise<UserDeleteAPIResponse> {
|
|
1693
|
+
}): CancelablePromise<UserDeleteAPIResponse> {
|
|
1091
1694
|
return __request(OpenAPI, {
|
|
1092
1695
|
method: 'POST',
|
|
1093
1696
|
url: '/api/core/users/delete/',
|
|
@@ -1100,17 +1703,18 @@ export class CoreService {
|
|
|
1100
1703
|
*
|
|
1101
1704
|
* Make permission check for platform admins here,
|
|
1102
1705
|
* then proxy request to edx.
|
|
1103
|
-
* @param email
|
|
1104
|
-
* @param userId
|
|
1105
|
-
* @param username
|
|
1106
1706
|
* @returns any No response body
|
|
1107
1707
|
* @throws ApiError
|
|
1108
1708
|
*/
|
|
1109
|
-
public static coreUsersMetadataProxyRetrieve(
|
|
1709
|
+
public static coreUsersMetadataProxyRetrieve({
|
|
1710
|
+
email,
|
|
1711
|
+
userId,
|
|
1712
|
+
username,
|
|
1713
|
+
}: {
|
|
1110
1714
|
email?: string,
|
|
1111
1715
|
userId?: number,
|
|
1112
1716
|
username?: string,
|
|
1113
|
-
): CancelablePromise<any> {
|
|
1717
|
+
}): CancelablePromise<any> {
|
|
1114
1718
|
return __request(OpenAPI, {
|
|
1115
1719
|
method: 'GET',
|
|
1116
1720
|
url: '/api/core/users/metadata/proxy/',
|
|
@@ -1128,17 +1732,18 @@ export class CoreService {
|
|
|
1128
1732
|
* user_id
|
|
1129
1733
|
* username
|
|
1130
1734
|
* email
|
|
1131
|
-
* @param email
|
|
1132
|
-
* @param userId
|
|
1133
|
-
* @param username
|
|
1134
1735
|
* @returns UserPlatformLink
|
|
1135
1736
|
* @throws ApiError
|
|
1136
1737
|
*/
|
|
1137
|
-
public static coreUsersPlatformsList(
|
|
1738
|
+
public static coreUsersPlatformsList({
|
|
1739
|
+
email,
|
|
1740
|
+
userId,
|
|
1741
|
+
username,
|
|
1742
|
+
}: {
|
|
1138
1743
|
email?: string,
|
|
1139
1744
|
userId?: number,
|
|
1140
1745
|
username?: string,
|
|
1141
|
-
): CancelablePromise<Array<UserPlatformLink>> {
|
|
1746
|
+
}): CancelablePromise<Array<UserPlatformLink>> {
|
|
1142
1747
|
return __request(OpenAPI, {
|
|
1143
1748
|
method: 'GET',
|
|
1144
1749
|
url: '/api/core/users/platforms/',
|
|
@@ -1159,13 +1764,14 @@ export class CoreService {
|
|
|
1159
1764
|
* expired_on (optional)
|
|
1160
1765
|
* is_admin (optional)
|
|
1161
1766
|
* active (optional)
|
|
1162
|
-
* @param requestBody
|
|
1163
1767
|
* @returns any No response body
|
|
1164
1768
|
* @throws ApiError
|
|
1165
1769
|
*/
|
|
1166
|
-
public static coreUsersPlatformsCreate(
|
|
1770
|
+
public static coreUsersPlatformsCreate({
|
|
1771
|
+
requestBody,
|
|
1772
|
+
}: {
|
|
1167
1773
|
requestBody: UserPlatformViewPostRequest,
|
|
1168
|
-
): CancelablePromise<any> {
|
|
1774
|
+
}): CancelablePromise<any> {
|
|
1169
1775
|
return __request(OpenAPI, {
|
|
1170
1776
|
method: 'POST',
|
|
1171
1777
|
url: '/api/core/users/platforms/',
|
|
@@ -1175,17 +1781,18 @@ export class CoreService {
|
|
|
1175
1781
|
}
|
|
1176
1782
|
/**
|
|
1177
1783
|
* Retrieve proxy user information by user_id
|
|
1178
|
-
* @param email
|
|
1179
|
-
* @param userId
|
|
1180
|
-
* @param username
|
|
1181
1784
|
* @returns UserProxyGetResponse
|
|
1182
1785
|
* @throws ApiError
|
|
1183
1786
|
*/
|
|
1184
|
-
public static coreUsersProxyRetrieve(
|
|
1787
|
+
public static coreUsersProxyRetrieve({
|
|
1788
|
+
email,
|
|
1789
|
+
userId,
|
|
1790
|
+
username,
|
|
1791
|
+
}: {
|
|
1185
1792
|
email?: string,
|
|
1186
1793
|
userId?: number,
|
|
1187
1794
|
username?: string,
|
|
1188
|
-
): CancelablePromise<UserProxyGetResponse> {
|
|
1795
|
+
}): CancelablePromise<UserProxyGetResponse> {
|
|
1189
1796
|
return __request(OpenAPI, {
|
|
1190
1797
|
method: 'GET',
|
|
1191
1798
|
url: '/api/core/users/proxy/',
|
|
@@ -1205,13 +1812,14 @@ export class CoreService {
|
|
|
1205
1812
|
* email
|
|
1206
1813
|
* edx_data
|
|
1207
1814
|
* data
|
|
1208
|
-
* @param requestBody
|
|
1209
1815
|
* @returns UserProxyPostResponse
|
|
1210
1816
|
* @throws ApiError
|
|
1211
1817
|
*/
|
|
1212
|
-
public static coreUsersProxyCreate(
|
|
1818
|
+
public static coreUsersProxyCreate({
|
|
1819
|
+
requestBody,
|
|
1820
|
+
}: {
|
|
1213
1821
|
requestBody: UserProxyPostRequest,
|
|
1214
|
-
): CancelablePromise<UserProxyPostResponse> {
|
|
1822
|
+
}): CancelablePromise<UserProxyPostResponse> {
|
|
1215
1823
|
return __request(OpenAPI, {
|
|
1216
1824
|
method: 'POST',
|
|
1217
1825
|
url: '/api/core/users/proxy/',
|
|
@@ -1230,13 +1838,14 @@ export class CoreService {
|
|
|
1230
1838
|
* {"user_id": 2, ...}
|
|
1231
1839
|
* ]
|
|
1232
1840
|
* ```
|
|
1233
|
-
* @param requestBody
|
|
1234
1841
|
* @returns string
|
|
1235
1842
|
* @throws ApiError
|
|
1236
1843
|
*/
|
|
1237
|
-
public static coreUsersProxyBulkCreate(
|
|
1844
|
+
public static coreUsersProxyBulkCreate({
|
|
1845
|
+
requestBody,
|
|
1846
|
+
}: {
|
|
1238
1847
|
requestBody: UserProxyBulkRequest,
|
|
1239
|
-
): CancelablePromise<Array<Record<string, string>>> {
|
|
1848
|
+
}): CancelablePromise<Array<Record<string, string>>> {
|
|
1240
1849
|
return __request(OpenAPI, {
|
|
1241
1850
|
method: 'POST',
|
|
1242
1851
|
url: '/api/core/users/proxy/bulk/',
|
|
@@ -1251,19 +1860,20 @@ export class CoreService {
|
|
|
1251
1860
|
* Params:
|
|
1252
1861
|
* query
|
|
1253
1862
|
* sort
|
|
1254
|
-
* @param page
|
|
1255
|
-
* @param pageSize
|
|
1256
|
-
* @param query
|
|
1257
|
-
* @param sort
|
|
1258
1863
|
* @returns UserSearchViewGetResponse
|
|
1259
1864
|
* @throws ApiError
|
|
1260
1865
|
*/
|
|
1261
|
-
public static coreUsersSearchRetrieve(
|
|
1866
|
+
public static coreUsersSearchRetrieve({
|
|
1867
|
+
page,
|
|
1868
|
+
pageSize,
|
|
1869
|
+
query,
|
|
1870
|
+
sort,
|
|
1871
|
+
}: {
|
|
1262
1872
|
page?: number,
|
|
1263
1873
|
pageSize?: number,
|
|
1264
1874
|
query?: string,
|
|
1265
1875
|
sort?: string,
|
|
1266
|
-
): CancelablePromise<UserSearchViewGetResponse> {
|
|
1876
|
+
}): CancelablePromise<UserSearchViewGetResponse> {
|
|
1267
1877
|
return __request(OpenAPI, {
|
|
1268
1878
|
method: 'GET',
|
|
1269
1879
|
url: '/api/core/users/search/',
|