@easyedu/js-lsm-api 1.32.0 → 1.34.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +14 -0
- package/.openapi-generator/VERSION +1 -1
- package/README.md +20 -4
- package/dist/apis/ContentApi.d.ts +89 -0
- package/dist/apis/ContentApi.js +301 -102
- package/dist/apis/CourseApi.d.ts +48 -0
- package/dist/apis/CourseApi.js +157 -49
- package/dist/apis/ModuleApi.d.ts +16 -0
- package/dist/apis/ModuleApi.js +52 -16
- package/dist/apis/OtherApi.d.ts +4 -0
- package/dist/apis/OtherApi.js +13 -4
- package/dist/apis/PortalApi.d.ts +30 -3
- package/dist/apis/PortalApi.js +92 -32
- package/dist/apis/QuestionApi.d.ts +20 -0
- package/dist/apis/QuestionApi.js +65 -20
- package/dist/apis/QuizApi.d.ts +100 -0
- package/dist/apis/QuizApi.js +325 -100
- package/dist/apis/ReportingApi.d.ts +36 -0
- package/dist/apis/ReportingApi.js +117 -36
- package/dist/apis/RoleApi.d.ts +169 -0
- package/dist/apis/RoleApi.js +442 -0
- package/dist/apis/UserApi.d.ts +28 -0
- package/dist/apis/UserApi.js +91 -28
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/ContentApi.d.ts +89 -0
- package/dist/esm/apis/ContentApi.js +301 -102
- package/dist/esm/apis/CourseApi.d.ts +48 -0
- package/dist/esm/apis/CourseApi.js +157 -49
- package/dist/esm/apis/ModuleApi.d.ts +16 -0
- package/dist/esm/apis/ModuleApi.js +52 -16
- package/dist/esm/apis/OtherApi.d.ts +4 -0
- package/dist/esm/apis/OtherApi.js +13 -4
- package/dist/esm/apis/PortalApi.d.ts +30 -3
- package/dist/esm/apis/PortalApi.js +92 -32
- package/dist/esm/apis/QuestionApi.d.ts +20 -0
- package/dist/esm/apis/QuestionApi.js +65 -20
- package/dist/esm/apis/QuizApi.d.ts +100 -0
- package/dist/esm/apis/QuizApi.js +325 -100
- package/dist/esm/apis/ReportingApi.d.ts +36 -0
- package/dist/esm/apis/ReportingApi.js +117 -36
- package/dist/esm/apis/RoleApi.d.ts +169 -0
- package/dist/esm/apis/RoleApi.js +438 -0
- package/dist/esm/apis/UserApi.d.ts +28 -0
- package/dist/esm/apis/UserApi.js +91 -28
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/CriteriaBasedSelection.d.ts +1 -1
- package/dist/esm/models/CriteriaBasedSelectionCriteria.d.ts +2 -2
- package/dist/esm/models/FillInBlank.d.ts +1 -1
- package/dist/esm/models/FillInBlank1.d.ts +1 -1
- package/dist/esm/models/GetContent.d.ts +1 -1
- package/dist/esm/models/GetContentGradeDetail.d.ts +3 -3
- package/dist/esm/models/GetContentGradesItemsInner.d.ts +2 -2
- package/dist/esm/models/GetContentInstructorBasicReportingContentInfo.d.ts +1 -1
- package/dist/esm/models/GetContentSessionDetail.d.ts +2 -2
- package/dist/esm/models/GetCourseEnrollment.d.ts +2 -2
- package/dist/esm/models/GetCourseEnrollmentListItem.d.ts +2 -2
- package/dist/esm/models/GetCourseExport.d.ts +2 -2
- package/dist/esm/models/GetPermission.d.ts +50 -0
- package/dist/esm/models/GetPermission.js +53 -0
- package/dist/esm/models/GetPortal.d.ts +9 -20
- package/dist/esm/models/GetPortal.js +8 -14
- package/dist/esm/models/GetPortalUser.d.ts +2 -11
- package/dist/esm/models/GetPortalUser.js +0 -8
- package/dist/esm/models/GetQuestion.d.ts +2 -2
- package/dist/esm/models/GetQuestionListFilters.d.ts +2 -2
- package/dist/esm/models/GetQuiz.d.ts +1 -1
- package/dist/esm/models/GetQuizAttemptAnalyticsBasicInfo.d.ts +1 -1
- package/dist/esm/models/GetQuizAttemptAnalyticsPerformanceBreakdownByDifficultyInner.d.ts +1 -1
- package/dist/esm/models/GetQuizAttemptAnalyticsPerformanceBreakdownByQuestionTypeInner.d.ts +1 -1
- package/dist/esm/models/GetQuizAttemptAnalyticsQuestionAnalysisInner.d.ts +2 -2
- package/dist/esm/models/GetQuizAttemptAttempt.d.ts +1 -1
- package/dist/esm/models/GetQuizAttemptListAllOfAttempts.d.ts +1 -1
- package/dist/esm/models/GetQuizAttemptListAllOfFilters.d.ts +1 -1
- package/dist/esm/models/GetQuizAttemptQuestionsInner.d.ts +1 -1
- package/dist/esm/models/GetQuizCriteriaItem.d.ts +2 -2
- package/dist/esm/models/GetQuizCriteriaListItemsInner.d.ts +2 -2
- package/dist/esm/models/GetQuizListAllOfFilters.d.ts +1 -1
- package/dist/esm/models/GetQuizListAllOfQuizzes.d.ts +1 -1
- package/dist/esm/models/GetQuizQuestions.d.ts +1 -1
- package/dist/esm/models/GetQuizQuestionsItemsInnerQuestionDetails.d.ts +2 -2
- package/dist/esm/models/GetQuizResults.d.ts +1 -1
- package/dist/esm/models/GetQuizResultsFeedbackDifficultyPerformanceInner.d.ts +1 -1
- package/dist/esm/models/GetQuizResultsQuestionsInner.d.ts +1 -1
- package/dist/esm/models/GetRole.d.ts +88 -0
- package/dist/esm/models/GetRole.js +80 -0
- package/dist/esm/models/GetScormApiLogItem.d.ts +1 -1
- package/dist/esm/models/GetUserQuizAttemptsAllOfAttempts.d.ts +1 -1
- package/dist/esm/models/GetUserQuizAttemptsAllOfFilters.d.ts +1 -1
- package/dist/esm/models/GetUserRole.d.ts +63 -0
- package/dist/esm/models/GetUserRole.js +67 -0
- package/dist/esm/models/ManualSelection.d.ts +1 -1
- package/dist/esm/models/MultipleAnswer.d.ts +1 -1
- package/dist/esm/models/MultipleAnswer1.d.ts +1 -1
- package/dist/esm/models/NoAnswer.d.ts +1 -1
- package/dist/esm/models/PostContentUpload.d.ts +1 -1
- package/dist/esm/models/PostCourseExport.d.ts +1 -1
- package/dist/esm/models/PostPortalInvite.d.ts +6 -2
- package/dist/esm/models/PostPortalInvite.js +5 -1
- package/dist/esm/models/PostQuestion.d.ts +2 -2
- package/dist/esm/models/PostQuiz.d.ts +1 -1
- package/dist/esm/models/PostQuizAttemptAttempt.d.ts +1 -1
- package/dist/esm/models/PostQuizAttemptQuestionsInner.d.ts +1 -1
- package/dist/esm/models/PostQuizAttemptSubmit.d.ts +1 -1
- package/dist/esm/models/PostQuizCriteriaCriteriaInner.d.ts +2 -2
- package/dist/esm/models/PostRole.d.ts +57 -0
- package/dist/esm/models/PostRole.js +61 -0
- package/dist/esm/models/PutCourseEnrollment.d.ts +2 -2
- package/dist/esm/models/PutQuestion.d.ts +2 -2
- package/dist/esm/models/PutQuiz.d.ts +1 -1
- package/dist/esm/models/PutRole.d.ts +38 -0
- package/dist/esm/models/PutRole.js +45 -0
- package/dist/esm/models/PutRolePermissions.d.ts +32 -0
- package/dist/esm/models/PutRolePermissions.js +43 -0
- package/dist/esm/models/QuizContent.d.ts +1 -1
- package/dist/esm/models/SingleAnswer.d.ts +1 -1
- package/dist/esm/models/index.d.ts +6 -0
- package/dist/esm/models/index.js +6 -0
- package/dist/esm/runtime.js +15 -0
- package/dist/models/CriteriaBasedSelection.d.ts +1 -1
- package/dist/models/CriteriaBasedSelectionCriteria.d.ts +2 -2
- package/dist/models/FillInBlank.d.ts +1 -1
- package/dist/models/FillInBlank1.d.ts +1 -1
- package/dist/models/GetContent.d.ts +1 -1
- package/dist/models/GetContentGradeDetail.d.ts +3 -3
- package/dist/models/GetContentGradesItemsInner.d.ts +2 -2
- package/dist/models/GetContentInstructorBasicReportingContentInfo.d.ts +1 -1
- package/dist/models/GetContentSessionDetail.d.ts +2 -2
- package/dist/models/GetCourseEnrollment.d.ts +2 -2
- package/dist/models/GetCourseEnrollmentListItem.d.ts +2 -2
- package/dist/models/GetCourseExport.d.ts +2 -2
- package/dist/models/GetPermission.d.ts +50 -0
- package/dist/models/GetPermission.js +60 -0
- package/dist/models/GetPortal.d.ts +9 -20
- package/dist/models/GetPortal.js +9 -15
- package/dist/models/GetPortalUser.d.ts +2 -11
- package/dist/models/GetPortalUser.js +0 -9
- package/dist/models/GetQuestion.d.ts +2 -2
- package/dist/models/GetQuestionListFilters.d.ts +2 -2
- package/dist/models/GetQuiz.d.ts +1 -1
- package/dist/models/GetQuizAttemptAnalyticsBasicInfo.d.ts +1 -1
- package/dist/models/GetQuizAttemptAnalyticsPerformanceBreakdownByDifficultyInner.d.ts +1 -1
- package/dist/models/GetQuizAttemptAnalyticsPerformanceBreakdownByQuestionTypeInner.d.ts +1 -1
- package/dist/models/GetQuizAttemptAnalyticsQuestionAnalysisInner.d.ts +2 -2
- package/dist/models/GetQuizAttemptAttempt.d.ts +1 -1
- package/dist/models/GetQuizAttemptListAllOfAttempts.d.ts +1 -1
- package/dist/models/GetQuizAttemptListAllOfFilters.d.ts +1 -1
- package/dist/models/GetQuizAttemptQuestionsInner.d.ts +1 -1
- package/dist/models/GetQuizCriteriaItem.d.ts +2 -2
- package/dist/models/GetQuizCriteriaListItemsInner.d.ts +2 -2
- package/dist/models/GetQuizListAllOfFilters.d.ts +1 -1
- package/dist/models/GetQuizListAllOfQuizzes.d.ts +1 -1
- package/dist/models/GetQuizQuestions.d.ts +1 -1
- package/dist/models/GetQuizQuestionsItemsInnerQuestionDetails.d.ts +2 -2
- package/dist/models/GetQuizResults.d.ts +1 -1
- package/dist/models/GetQuizResultsFeedbackDifficultyPerformanceInner.d.ts +1 -1
- package/dist/models/GetQuizResultsQuestionsInner.d.ts +1 -1
- package/dist/models/GetRole.d.ts +88 -0
- package/dist/models/GetRole.js +88 -0
- package/dist/models/GetScormApiLogItem.d.ts +1 -1
- package/dist/models/GetUserQuizAttemptsAllOfAttempts.d.ts +1 -1
- package/dist/models/GetUserQuizAttemptsAllOfFilters.d.ts +1 -1
- package/dist/models/GetUserRole.d.ts +63 -0
- package/dist/models/GetUserRole.js +75 -0
- package/dist/models/ManualSelection.d.ts +1 -1
- package/dist/models/MultipleAnswer.d.ts +1 -1
- package/dist/models/MultipleAnswer1.d.ts +1 -1
- package/dist/models/NoAnswer.d.ts +1 -1
- package/dist/models/PostContentUpload.d.ts +1 -1
- package/dist/models/PostCourseExport.d.ts +1 -1
- package/dist/models/PostPortalInvite.d.ts +6 -2
- package/dist/models/PostPortalInvite.js +5 -1
- package/dist/models/PostQuestion.d.ts +2 -2
- package/dist/models/PostQuiz.d.ts +1 -1
- package/dist/models/PostQuizAttemptAttempt.d.ts +1 -1
- package/dist/models/PostQuizAttemptQuestionsInner.d.ts +1 -1
- package/dist/models/PostQuizAttemptSubmit.d.ts +1 -1
- package/dist/models/PostQuizCriteriaCriteriaInner.d.ts +2 -2
- package/dist/models/PostRole.d.ts +57 -0
- package/dist/models/PostRole.js +69 -0
- package/dist/models/PutCourseEnrollment.d.ts +2 -2
- package/dist/models/PutQuestion.d.ts +2 -2
- package/dist/models/PutQuiz.d.ts +1 -1
- package/dist/models/PutRole.d.ts +38 -0
- package/dist/models/PutRole.js +52 -0
- package/dist/models/PutRolePermissions.d.ts +32 -0
- package/dist/models/PutRolePermissions.js +50 -0
- package/dist/models/QuizContent.d.ts +1 -1
- package/dist/models/SingleAnswer.d.ts +1 -1
- package/dist/models/index.d.ts +6 -0
- package/dist/models/index.js +6 -0
- package/dist/runtime.js +15 -0
- package/docs/GetPermission.md +41 -0
- package/docs/GetPortal.md +2 -4
- package/docs/GetRole.md +49 -0
- package/docs/GetUserRole.md +41 -0
- package/docs/PortalApi.md +3 -6
- package/docs/PostRole.md +39 -0
- package/docs/PutRole.md +37 -0
- package/docs/PutRolePermissions.md +35 -0
- package/docs/RoleApi.md +685 -0
- package/package.json +1 -1
- package/src/apis/ContentApi.ts +279 -102
- package/src/apis/CourseApi.ts +145 -49
- package/src/apis/ModuleApi.ts +48 -16
- package/src/apis/OtherApi.ts +12 -4
- package/src/apis/PortalApi.ts +85 -34
- package/src/apis/QuestionApi.ts +60 -20
- package/src/apis/QuizApi.ts +300 -100
- package/src/apis/ReportingApi.ts +108 -36
- package/src/apis/RoleApi.ts +576 -0
- package/src/apis/UserApi.ts +84 -28
- package/src/apis/index.ts +1 -0
- package/src/models/CriteriaBasedSelection.ts +1 -1
- package/src/models/CriteriaBasedSelectionCriteria.ts +2 -2
- package/src/models/FillInBlank.ts +1 -1
- package/src/models/FillInBlank1.ts +1 -1
- package/src/models/GetContent.ts +1 -1
- package/src/models/GetContentGradeDetail.ts +3 -3
- package/src/models/GetContentGradesItemsInner.ts +2 -2
- package/src/models/GetContentInstructorBasicReportingContentInfo.ts +1 -1
- package/src/models/GetContentSessionDetail.ts +2 -2
- package/src/models/GetCourseEnrollment.ts +2 -2
- package/src/models/GetCourseEnrollmentListItem.ts +2 -2
- package/src/models/GetCourseExport.ts +2 -2
- package/src/models/GetPermission.ts +92 -0
- package/src/models/GetPortal.ts +12 -26
- package/src/models/GetPortalUser.ts +2 -14
- package/src/models/GetQuestion.ts +2 -2
- package/src/models/GetQuestionListFilters.ts +2 -2
- package/src/models/GetQuiz.ts +1 -1
- package/src/models/GetQuizAttemptAnalyticsBasicInfo.ts +1 -1
- package/src/models/GetQuizAttemptAnalyticsPerformanceBreakdownByDifficultyInner.ts +1 -1
- package/src/models/GetQuizAttemptAnalyticsPerformanceBreakdownByQuestionTypeInner.ts +1 -1
- package/src/models/GetQuizAttemptAnalyticsQuestionAnalysisInner.ts +2 -2
- package/src/models/GetQuizAttemptAttempt.ts +1 -1
- package/src/models/GetQuizAttemptListAllOfAttempts.ts +1 -1
- package/src/models/GetQuizAttemptListAllOfFilters.ts +1 -1
- package/src/models/GetQuizAttemptQuestionsInner.ts +1 -1
- package/src/models/GetQuizCriteriaItem.ts +2 -2
- package/src/models/GetQuizCriteriaListItemsInner.ts +2 -2
- package/src/models/GetQuizListAllOfFilters.ts +1 -1
- package/src/models/GetQuizListAllOfQuizzes.ts +1 -1
- package/src/models/GetQuizQuestions.ts +1 -1
- package/src/models/GetQuizQuestionsItemsInnerQuestionDetails.ts +2 -2
- package/src/models/GetQuizResults.ts +1 -1
- package/src/models/GetQuizResultsFeedbackDifficultyPerformanceInner.ts +1 -1
- package/src/models/GetQuizResultsQuestionsInner.ts +1 -1
- package/src/models/GetRole.ts +151 -0
- package/src/models/GetScormApiLogItem.ts +1 -1
- package/src/models/GetUserQuizAttemptsAllOfAttempts.ts +1 -1
- package/src/models/GetUserQuizAttemptsAllOfFilters.ts +1 -1
- package/src/models/GetUserRole.ts +109 -0
- package/src/models/ManualSelection.ts +1 -1
- package/src/models/MultipleAnswer.ts +1 -1
- package/src/models/MultipleAnswer1.ts +1 -1
- package/src/models/NoAnswer.ts +1 -1
- package/src/models/PostContentUpload.ts +1 -1
- package/src/models/PostCourseExport.ts +1 -1
- package/src/models/PostPortalInvite.ts +7 -3
- package/src/models/PostQuestion.ts +2 -2
- package/src/models/PostQuiz.ts +1 -1
- package/src/models/PostQuizAttemptAttempt.ts +1 -1
- package/src/models/PostQuizAttemptQuestionsInner.ts +1 -1
- package/src/models/PostQuizAttemptSubmit.ts +1 -1
- package/src/models/PostQuizCriteriaCriteriaInner.ts +2 -2
- package/src/models/PostRole.ts +99 -0
- package/src/models/PutCourseEnrollment.ts +2 -2
- package/src/models/PutQuestion.ts +2 -2
- package/src/models/PutQuiz.ts +1 -1
- package/src/models/PutRole.ts +74 -0
- package/src/models/PutRolePermissions.ts +66 -0
- package/src/models/QuizContent.ts +1 -1
- package/src/models/SingleAnswer.ts +1 -1
- package/src/models/index.ts +6 -0
- package/src/runtime.ts +18 -0
|
@@ -57,6 +57,10 @@ export interface GetPortalStudentReportingRequest {
|
|
|
57
57
|
*
|
|
58
58
|
*/
|
|
59
59
|
export declare class ReportingApi extends runtime.BaseAPI {
|
|
60
|
+
/**
|
|
61
|
+
* Creates request options for getContentGradeDetail without sending the request
|
|
62
|
+
*/
|
|
63
|
+
getContentGradeDetailRequestOpts(requestParameters: GetContentGradeDetailRequest): Promise<runtime.RequestOpts>;
|
|
60
64
|
/**
|
|
61
65
|
* Get detailed grade information for a specific student and content (can use \'current\' for studentId)
|
|
62
66
|
*/
|
|
@@ -65,6 +69,10 @@ export declare class ReportingApi extends runtime.BaseAPI {
|
|
|
65
69
|
* Get detailed grade information for a specific student and content (can use \'current\' for studentId)
|
|
66
70
|
*/
|
|
67
71
|
getContentGradeDetail(requestParameters: GetContentGradeDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentGradeDetail>;
|
|
72
|
+
/**
|
|
73
|
+
* Creates request options for getContentGrades without sending the request
|
|
74
|
+
*/
|
|
75
|
+
getContentGradesRequestOpts(requestParameters: GetContentGradesRequest): Promise<runtime.RequestOpts>;
|
|
68
76
|
/**
|
|
69
77
|
* Get grades for all students enrolled in course for specific content
|
|
70
78
|
*/
|
|
@@ -73,6 +81,10 @@ export declare class ReportingApi extends runtime.BaseAPI {
|
|
|
73
81
|
* Get grades for all students enrolled in course for specific content
|
|
74
82
|
*/
|
|
75
83
|
getContentGrades(requestParameters: GetContentGradesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentGrades>;
|
|
84
|
+
/**
|
|
85
|
+
* Creates request options for getContentInstructorBasicReporting without sending the request
|
|
86
|
+
*/
|
|
87
|
+
getContentInstructorBasicReportingRequestOpts(requestParameters: GetContentInstructorBasicReportingRequest): Promise<runtime.RequestOpts>;
|
|
76
88
|
/**
|
|
77
89
|
* Get basic instructor reporting for content
|
|
78
90
|
*/
|
|
@@ -81,6 +93,10 @@ export declare class ReportingApi extends runtime.BaseAPI {
|
|
|
81
93
|
* Get basic instructor reporting for content
|
|
82
94
|
*/
|
|
83
95
|
getContentInstructorBasicReporting(requestParameters: GetContentInstructorBasicReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentInstructorBasicReporting>;
|
|
96
|
+
/**
|
|
97
|
+
* Creates request options for getCourseInstructorReportingBasic without sending the request
|
|
98
|
+
*/
|
|
99
|
+
getCourseInstructorReportingBasicRequestOpts(requestParameters: GetCourseInstructorReportingBasicRequest): Promise<runtime.RequestOpts>;
|
|
84
100
|
/**
|
|
85
101
|
* Get basic course reporting data for instructors
|
|
86
102
|
*/
|
|
@@ -89,6 +105,10 @@ export declare class ReportingApi extends runtime.BaseAPI {
|
|
|
89
105
|
* Get basic course reporting data for instructors
|
|
90
106
|
*/
|
|
91
107
|
getCourseInstructorReportingBasic(requestParameters: GetCourseInstructorReportingBasicRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseReportingBasic>;
|
|
108
|
+
/**
|
|
109
|
+
* Creates request options for getCourseStudentReporting without sending the request
|
|
110
|
+
*/
|
|
111
|
+
getCourseStudentReportingRequestOpts(requestParameters: GetCourseStudentReportingRequest): Promise<runtime.RequestOpts>;
|
|
92
112
|
/**
|
|
93
113
|
* Get student-specific reporting for a course (can use \'current\' for studentId)
|
|
94
114
|
*/
|
|
@@ -97,6 +117,10 @@ export declare class ReportingApi extends runtime.BaseAPI {
|
|
|
97
117
|
* Get student-specific reporting for a course (can use \'current\' for studentId)
|
|
98
118
|
*/
|
|
99
119
|
getCourseStudentReporting(requestParameters: GetCourseStudentReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseStudentReporting>;
|
|
120
|
+
/**
|
|
121
|
+
* Creates request options for getModuleInstructorBasicReporting without sending the request
|
|
122
|
+
*/
|
|
123
|
+
getModuleInstructorBasicReportingRequestOpts(requestParameters: GetModuleInstructorBasicReportingRequest): Promise<runtime.RequestOpts>;
|
|
100
124
|
/**
|
|
101
125
|
* Get basic instructor reporting for a module
|
|
102
126
|
*/
|
|
@@ -105,6 +129,10 @@ export declare class ReportingApi extends runtime.BaseAPI {
|
|
|
105
129
|
* Get basic instructor reporting for a module
|
|
106
130
|
*/
|
|
107
131
|
getModuleInstructorBasicReporting(requestParameters: GetModuleInstructorBasicReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetModuleInstructorBasicReporting>;
|
|
132
|
+
/**
|
|
133
|
+
* Creates request options for getModuleStudentReporting without sending the request
|
|
134
|
+
*/
|
|
135
|
+
getModuleStudentReportingRequestOpts(requestParameters: GetModuleStudentReportingRequest): Promise<runtime.RequestOpts>;
|
|
108
136
|
/**
|
|
109
137
|
* Get student-specific reporting for a module (can use \'current\' for studentId)
|
|
110
138
|
*/
|
|
@@ -113,6 +141,10 @@ export declare class ReportingApi extends runtime.BaseAPI {
|
|
|
113
141
|
* Get student-specific reporting for a module (can use \'current\' for studentId)
|
|
114
142
|
*/
|
|
115
143
|
getModuleStudentReporting(requestParameters: GetModuleStudentReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetModuleStudentReporting>;
|
|
144
|
+
/**
|
|
145
|
+
* Creates request options for getPortalBasicReporting without sending the request
|
|
146
|
+
*/
|
|
147
|
+
getPortalBasicReportingRequestOpts(requestParameters: GetPortalBasicReportingRequest): Promise<runtime.RequestOpts>;
|
|
116
148
|
/**
|
|
117
149
|
* Get basic reporting for a portal (can use \'current\' for portalId)
|
|
118
150
|
*/
|
|
@@ -121,6 +153,10 @@ export declare class ReportingApi extends runtime.BaseAPI {
|
|
|
121
153
|
* Get basic reporting for a portal (can use \'current\' for portalId)
|
|
122
154
|
*/
|
|
123
155
|
getPortalBasicReporting(requestParameters: GetPortalBasicReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalBasicReporting>;
|
|
156
|
+
/**
|
|
157
|
+
* Creates request options for getPortalStudentReporting without sending the request
|
|
158
|
+
*/
|
|
159
|
+
getPortalStudentReportingRequestOpts(requestParameters: GetPortalStudentReportingRequest): Promise<runtime.RequestOpts>;
|
|
124
160
|
/**
|
|
125
161
|
* Get student reporting for a portal (can use \'current\' for portalId and studentId)
|
|
126
162
|
*/
|
|
@@ -27,9 +27,9 @@ import { GetContentGradeDetailFromJSON, GetContentGradesFromJSON, GetContentInst
|
|
|
27
27
|
*/
|
|
28
28
|
export class ReportingApi extends runtime.BaseAPI {
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* Creates request options for getContentGradeDetail without sending the request
|
|
31
31
|
*/
|
|
32
|
-
|
|
32
|
+
getContentGradeDetailRequestOpts(requestParameters) {
|
|
33
33
|
return __awaiter(this, void 0, void 0, function* () {
|
|
34
34
|
if (requestParameters['courseId'] == null) {
|
|
35
35
|
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getContentGradeDetail().');
|
|
@@ -50,12 +50,21 @@ export class ReportingApi extends runtime.BaseAPI {
|
|
|
50
50
|
urlPath = urlPath.replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId'])));
|
|
51
51
|
urlPath = urlPath.replace(`{${"contentId"}}`, encodeURIComponent(String(requestParameters['contentId'])));
|
|
52
52
|
urlPath = urlPath.replace(`{${"studentId"}}`, encodeURIComponent(String(requestParameters['studentId'])));
|
|
53
|
-
|
|
53
|
+
return {
|
|
54
54
|
path: urlPath,
|
|
55
55
|
method: 'GET',
|
|
56
56
|
headers: headerParameters,
|
|
57
57
|
query: queryParameters,
|
|
58
|
-
}
|
|
58
|
+
};
|
|
59
|
+
});
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Get detailed grade information for a specific student and content (can use \'current\' for studentId)
|
|
63
|
+
*/
|
|
64
|
+
getContentGradeDetailRaw(requestParameters, initOverrides) {
|
|
65
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
66
|
+
const requestOptions = yield this.getContentGradeDetailRequestOpts(requestParameters);
|
|
67
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
59
68
|
return new runtime.JSONApiResponse(response, (jsonValue) => GetContentGradeDetailFromJSON(jsonValue));
|
|
60
69
|
});
|
|
61
70
|
}
|
|
@@ -69,9 +78,9 @@ export class ReportingApi extends runtime.BaseAPI {
|
|
|
69
78
|
});
|
|
70
79
|
}
|
|
71
80
|
/**
|
|
72
|
-
*
|
|
81
|
+
* Creates request options for getContentGrades without sending the request
|
|
73
82
|
*/
|
|
74
|
-
|
|
83
|
+
getContentGradesRequestOpts(requestParameters) {
|
|
75
84
|
return __awaiter(this, void 0, void 0, function* () {
|
|
76
85
|
if (requestParameters['courseId'] == null) {
|
|
77
86
|
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getContentGrades().');
|
|
@@ -97,12 +106,21 @@ export class ReportingApi extends runtime.BaseAPI {
|
|
|
97
106
|
urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
|
|
98
107
|
urlPath = urlPath.replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId'])));
|
|
99
108
|
urlPath = urlPath.replace(`{${"contentId"}}`, encodeURIComponent(String(requestParameters['contentId'])));
|
|
100
|
-
|
|
109
|
+
return {
|
|
101
110
|
path: urlPath,
|
|
102
111
|
method: 'GET',
|
|
103
112
|
headers: headerParameters,
|
|
104
113
|
query: queryParameters,
|
|
105
|
-
}
|
|
114
|
+
};
|
|
115
|
+
});
|
|
116
|
+
}
|
|
117
|
+
/**
|
|
118
|
+
* Get grades for all students enrolled in course for specific content
|
|
119
|
+
*/
|
|
120
|
+
getContentGradesRaw(requestParameters, initOverrides) {
|
|
121
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
122
|
+
const requestOptions = yield this.getContentGradesRequestOpts(requestParameters);
|
|
123
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
106
124
|
return new runtime.JSONApiResponse(response, (jsonValue) => GetContentGradesFromJSON(jsonValue));
|
|
107
125
|
});
|
|
108
126
|
}
|
|
@@ -116,9 +134,9 @@ export class ReportingApi extends runtime.BaseAPI {
|
|
|
116
134
|
});
|
|
117
135
|
}
|
|
118
136
|
/**
|
|
119
|
-
*
|
|
137
|
+
* Creates request options for getContentInstructorBasicReporting without sending the request
|
|
120
138
|
*/
|
|
121
|
-
|
|
139
|
+
getContentInstructorBasicReportingRequestOpts(requestParameters) {
|
|
122
140
|
return __awaiter(this, void 0, void 0, function* () {
|
|
123
141
|
if (requestParameters['courseId'] == null) {
|
|
124
142
|
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getContentInstructorBasicReporting().');
|
|
@@ -135,12 +153,21 @@ export class ReportingApi extends runtime.BaseAPI {
|
|
|
135
153
|
urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
|
|
136
154
|
urlPath = urlPath.replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId'])));
|
|
137
155
|
urlPath = urlPath.replace(`{${"contentId"}}`, encodeURIComponent(String(requestParameters['contentId'])));
|
|
138
|
-
|
|
156
|
+
return {
|
|
139
157
|
path: urlPath,
|
|
140
158
|
method: 'GET',
|
|
141
159
|
headers: headerParameters,
|
|
142
160
|
query: queryParameters,
|
|
143
|
-
}
|
|
161
|
+
};
|
|
162
|
+
});
|
|
163
|
+
}
|
|
164
|
+
/**
|
|
165
|
+
* Get basic instructor reporting for content
|
|
166
|
+
*/
|
|
167
|
+
getContentInstructorBasicReportingRaw(requestParameters, initOverrides) {
|
|
168
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
169
|
+
const requestOptions = yield this.getContentInstructorBasicReportingRequestOpts(requestParameters);
|
|
170
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
144
171
|
return new runtime.JSONApiResponse(response, (jsonValue) => GetContentInstructorBasicReportingFromJSON(jsonValue));
|
|
145
172
|
});
|
|
146
173
|
}
|
|
@@ -154,9 +181,9 @@ export class ReportingApi extends runtime.BaseAPI {
|
|
|
154
181
|
});
|
|
155
182
|
}
|
|
156
183
|
/**
|
|
157
|
-
*
|
|
184
|
+
* Creates request options for getCourseInstructorReportingBasic without sending the request
|
|
158
185
|
*/
|
|
159
|
-
|
|
186
|
+
getCourseInstructorReportingBasicRequestOpts(requestParameters) {
|
|
160
187
|
return __awaiter(this, void 0, void 0, function* () {
|
|
161
188
|
if (requestParameters['courseId'] == null) {
|
|
162
189
|
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseInstructorReportingBasic().');
|
|
@@ -165,12 +192,21 @@ export class ReportingApi extends runtime.BaseAPI {
|
|
|
165
192
|
const headerParameters = {};
|
|
166
193
|
let urlPath = `/courses/{courseId}/reporting/instructor/basic`;
|
|
167
194
|
urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
|
|
168
|
-
|
|
195
|
+
return {
|
|
169
196
|
path: urlPath,
|
|
170
197
|
method: 'GET',
|
|
171
198
|
headers: headerParameters,
|
|
172
199
|
query: queryParameters,
|
|
173
|
-
}
|
|
200
|
+
};
|
|
201
|
+
});
|
|
202
|
+
}
|
|
203
|
+
/**
|
|
204
|
+
* Get basic course reporting data for instructors
|
|
205
|
+
*/
|
|
206
|
+
getCourseInstructorReportingBasicRaw(requestParameters, initOverrides) {
|
|
207
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
208
|
+
const requestOptions = yield this.getCourseInstructorReportingBasicRequestOpts(requestParameters);
|
|
209
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
174
210
|
return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseReportingBasicFromJSON(jsonValue));
|
|
175
211
|
});
|
|
176
212
|
}
|
|
@@ -184,9 +220,9 @@ export class ReportingApi extends runtime.BaseAPI {
|
|
|
184
220
|
});
|
|
185
221
|
}
|
|
186
222
|
/**
|
|
187
|
-
*
|
|
223
|
+
* Creates request options for getCourseStudentReporting without sending the request
|
|
188
224
|
*/
|
|
189
|
-
|
|
225
|
+
getCourseStudentReportingRequestOpts(requestParameters) {
|
|
190
226
|
return __awaiter(this, void 0, void 0, function* () {
|
|
191
227
|
if (requestParameters['courseId'] == null) {
|
|
192
228
|
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseStudentReporting().');
|
|
@@ -199,12 +235,21 @@ export class ReportingApi extends runtime.BaseAPI {
|
|
|
199
235
|
let urlPath = `/courses/{courseId}/reporting/students/{studentId}`;
|
|
200
236
|
urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
|
|
201
237
|
urlPath = urlPath.replace(`{${"studentId"}}`, encodeURIComponent(String(requestParameters['studentId'])));
|
|
202
|
-
|
|
238
|
+
return {
|
|
203
239
|
path: urlPath,
|
|
204
240
|
method: 'GET',
|
|
205
241
|
headers: headerParameters,
|
|
206
242
|
query: queryParameters,
|
|
207
|
-
}
|
|
243
|
+
};
|
|
244
|
+
});
|
|
245
|
+
}
|
|
246
|
+
/**
|
|
247
|
+
* Get student-specific reporting for a course (can use \'current\' for studentId)
|
|
248
|
+
*/
|
|
249
|
+
getCourseStudentReportingRaw(requestParameters, initOverrides) {
|
|
250
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
251
|
+
const requestOptions = yield this.getCourseStudentReportingRequestOpts(requestParameters);
|
|
252
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
208
253
|
return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseStudentReportingFromJSON(jsonValue));
|
|
209
254
|
});
|
|
210
255
|
}
|
|
@@ -218,9 +263,9 @@ export class ReportingApi extends runtime.BaseAPI {
|
|
|
218
263
|
});
|
|
219
264
|
}
|
|
220
265
|
/**
|
|
221
|
-
*
|
|
266
|
+
* Creates request options for getModuleInstructorBasicReporting without sending the request
|
|
222
267
|
*/
|
|
223
|
-
|
|
268
|
+
getModuleInstructorBasicReportingRequestOpts(requestParameters) {
|
|
224
269
|
return __awaiter(this, void 0, void 0, function* () {
|
|
225
270
|
if (requestParameters['courseId'] == null) {
|
|
226
271
|
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getModuleInstructorBasicReporting().');
|
|
@@ -233,12 +278,21 @@ export class ReportingApi extends runtime.BaseAPI {
|
|
|
233
278
|
let urlPath = `/courses/{courseId}/modules/{moduleId}/reporting/instructor/basic`;
|
|
234
279
|
urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
|
|
235
280
|
urlPath = urlPath.replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId'])));
|
|
236
|
-
|
|
281
|
+
return {
|
|
237
282
|
path: urlPath,
|
|
238
283
|
method: 'GET',
|
|
239
284
|
headers: headerParameters,
|
|
240
285
|
query: queryParameters,
|
|
241
|
-
}
|
|
286
|
+
};
|
|
287
|
+
});
|
|
288
|
+
}
|
|
289
|
+
/**
|
|
290
|
+
* Get basic instructor reporting for a module
|
|
291
|
+
*/
|
|
292
|
+
getModuleInstructorBasicReportingRaw(requestParameters, initOverrides) {
|
|
293
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
294
|
+
const requestOptions = yield this.getModuleInstructorBasicReportingRequestOpts(requestParameters);
|
|
295
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
242
296
|
return new runtime.JSONApiResponse(response, (jsonValue) => GetModuleInstructorBasicReportingFromJSON(jsonValue));
|
|
243
297
|
});
|
|
244
298
|
}
|
|
@@ -252,9 +306,9 @@ export class ReportingApi extends runtime.BaseAPI {
|
|
|
252
306
|
});
|
|
253
307
|
}
|
|
254
308
|
/**
|
|
255
|
-
*
|
|
309
|
+
* Creates request options for getModuleStudentReporting without sending the request
|
|
256
310
|
*/
|
|
257
|
-
|
|
311
|
+
getModuleStudentReportingRequestOpts(requestParameters) {
|
|
258
312
|
return __awaiter(this, void 0, void 0, function* () {
|
|
259
313
|
if (requestParameters['courseId'] == null) {
|
|
260
314
|
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getModuleStudentReporting().');
|
|
@@ -271,12 +325,21 @@ export class ReportingApi extends runtime.BaseAPI {
|
|
|
271
325
|
urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
|
|
272
326
|
urlPath = urlPath.replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId'])));
|
|
273
327
|
urlPath = urlPath.replace(`{${"studentId"}}`, encodeURIComponent(String(requestParameters['studentId'])));
|
|
274
|
-
|
|
328
|
+
return {
|
|
275
329
|
path: urlPath,
|
|
276
330
|
method: 'GET',
|
|
277
331
|
headers: headerParameters,
|
|
278
332
|
query: queryParameters,
|
|
279
|
-
}
|
|
333
|
+
};
|
|
334
|
+
});
|
|
335
|
+
}
|
|
336
|
+
/**
|
|
337
|
+
* Get student-specific reporting for a module (can use \'current\' for studentId)
|
|
338
|
+
*/
|
|
339
|
+
getModuleStudentReportingRaw(requestParameters, initOverrides) {
|
|
340
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
341
|
+
const requestOptions = yield this.getModuleStudentReportingRequestOpts(requestParameters);
|
|
342
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
280
343
|
return new runtime.JSONApiResponse(response, (jsonValue) => GetModuleStudentReportingFromJSON(jsonValue));
|
|
281
344
|
});
|
|
282
345
|
}
|
|
@@ -290,9 +353,9 @@ export class ReportingApi extends runtime.BaseAPI {
|
|
|
290
353
|
});
|
|
291
354
|
}
|
|
292
355
|
/**
|
|
293
|
-
*
|
|
356
|
+
* Creates request options for getPortalBasicReporting without sending the request
|
|
294
357
|
*/
|
|
295
|
-
|
|
358
|
+
getPortalBasicReportingRequestOpts(requestParameters) {
|
|
296
359
|
return __awaiter(this, void 0, void 0, function* () {
|
|
297
360
|
if (requestParameters['portalId'] == null) {
|
|
298
361
|
throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling getPortalBasicReporting().');
|
|
@@ -301,12 +364,21 @@ export class ReportingApi extends runtime.BaseAPI {
|
|
|
301
364
|
const headerParameters = {};
|
|
302
365
|
let urlPath = `/portals/{portalId}/reporting/basic`;
|
|
303
366
|
urlPath = urlPath.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId'])));
|
|
304
|
-
|
|
367
|
+
return {
|
|
305
368
|
path: urlPath,
|
|
306
369
|
method: 'GET',
|
|
307
370
|
headers: headerParameters,
|
|
308
371
|
query: queryParameters,
|
|
309
|
-
}
|
|
372
|
+
};
|
|
373
|
+
});
|
|
374
|
+
}
|
|
375
|
+
/**
|
|
376
|
+
* Get basic reporting for a portal (can use \'current\' for portalId)
|
|
377
|
+
*/
|
|
378
|
+
getPortalBasicReportingRaw(requestParameters, initOverrides) {
|
|
379
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
380
|
+
const requestOptions = yield this.getPortalBasicReportingRequestOpts(requestParameters);
|
|
381
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
310
382
|
return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalBasicReportingFromJSON(jsonValue));
|
|
311
383
|
});
|
|
312
384
|
}
|
|
@@ -320,9 +392,9 @@ export class ReportingApi extends runtime.BaseAPI {
|
|
|
320
392
|
});
|
|
321
393
|
}
|
|
322
394
|
/**
|
|
323
|
-
*
|
|
395
|
+
* Creates request options for getPortalStudentReporting without sending the request
|
|
324
396
|
*/
|
|
325
|
-
|
|
397
|
+
getPortalStudentReportingRequestOpts(requestParameters) {
|
|
326
398
|
return __awaiter(this, void 0, void 0, function* () {
|
|
327
399
|
if (requestParameters['portalId'] == null) {
|
|
328
400
|
throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling getPortalStudentReporting().');
|
|
@@ -335,12 +407,21 @@ export class ReportingApi extends runtime.BaseAPI {
|
|
|
335
407
|
let urlPath = `/portals/{portalId}/reporting/students/{studentId}`;
|
|
336
408
|
urlPath = urlPath.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId'])));
|
|
337
409
|
urlPath = urlPath.replace(`{${"studentId"}}`, encodeURIComponent(String(requestParameters['studentId'])));
|
|
338
|
-
|
|
410
|
+
return {
|
|
339
411
|
path: urlPath,
|
|
340
412
|
method: 'GET',
|
|
341
413
|
headers: headerParameters,
|
|
342
414
|
query: queryParameters,
|
|
343
|
-
}
|
|
415
|
+
};
|
|
416
|
+
});
|
|
417
|
+
}
|
|
418
|
+
/**
|
|
419
|
+
* Get student reporting for a portal (can use \'current\' for portalId and studentId)
|
|
420
|
+
*/
|
|
421
|
+
getPortalStudentReportingRaw(requestParameters, initOverrides) {
|
|
422
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
423
|
+
const requestOptions = yield this.getPortalStudentReportingRequestOpts(requestParameters);
|
|
424
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
344
425
|
return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalStudentReportingFromJSON(jsonValue));
|
|
345
426
|
});
|
|
346
427
|
}
|
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* LMS API
|
|
3
|
+
* LMS API
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import * as runtime from '../runtime';
|
|
13
|
+
import type { GetPermission, GetRole, GetUserRole, PostRole, PutRole, PutRolePermissions } from '../models/index';
|
|
14
|
+
export interface AssignUserRoleRequest {
|
|
15
|
+
userId: string;
|
|
16
|
+
portalId: string;
|
|
17
|
+
roleId: string;
|
|
18
|
+
}
|
|
19
|
+
export interface CreateRoleRequest {
|
|
20
|
+
postRole: PostRole;
|
|
21
|
+
}
|
|
22
|
+
export interface DeleteRoleRequest {
|
|
23
|
+
roleId: string;
|
|
24
|
+
}
|
|
25
|
+
export interface GetRoleRequest {
|
|
26
|
+
roleId: string;
|
|
27
|
+
}
|
|
28
|
+
export interface GetUserRolesRequest {
|
|
29
|
+
userId: string;
|
|
30
|
+
portalId: string;
|
|
31
|
+
}
|
|
32
|
+
export interface UnassignUserRoleRequest {
|
|
33
|
+
userId: string;
|
|
34
|
+
portalId: string;
|
|
35
|
+
roleId: string;
|
|
36
|
+
}
|
|
37
|
+
export interface UpdateRoleRequest {
|
|
38
|
+
roleId: string;
|
|
39
|
+
putRole: PutRole;
|
|
40
|
+
}
|
|
41
|
+
export interface UpdateRolePermissionsRequest {
|
|
42
|
+
roleId: string;
|
|
43
|
+
putRolePermissions: PutRolePermissions;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
*
|
|
47
|
+
*/
|
|
48
|
+
export declare class RoleApi extends runtime.BaseAPI {
|
|
49
|
+
/**
|
|
50
|
+
* Creates request options for assignUserRole without sending the request
|
|
51
|
+
*/
|
|
52
|
+
assignUserRoleRequestOpts(requestParameters: AssignUserRoleRequest): Promise<runtime.RequestOpts>;
|
|
53
|
+
/**
|
|
54
|
+
* Assign a role to a user for a portal
|
|
55
|
+
*/
|
|
56
|
+
assignUserRoleRaw(requestParameters: AssignUserRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
57
|
+
/**
|
|
58
|
+
* Assign a role to a user for a portal
|
|
59
|
+
*/
|
|
60
|
+
assignUserRole(requestParameters: AssignUserRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
61
|
+
/**
|
|
62
|
+
* Creates request options for createRole without sending the request
|
|
63
|
+
*/
|
|
64
|
+
createRoleRequestOpts(requestParameters: CreateRoleRequest): Promise<runtime.RequestOpts>;
|
|
65
|
+
/**
|
|
66
|
+
* Create a custom role scoped to the current portal
|
|
67
|
+
*/
|
|
68
|
+
createRoleRaw(requestParameters: CreateRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetRole>>;
|
|
69
|
+
/**
|
|
70
|
+
* Create a custom role scoped to the current portal
|
|
71
|
+
*/
|
|
72
|
+
createRole(requestParameters: CreateRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetRole>;
|
|
73
|
+
/**
|
|
74
|
+
* Creates request options for deleteRole without sending the request
|
|
75
|
+
*/
|
|
76
|
+
deleteRoleRequestOpts(requestParameters: DeleteRoleRequest): Promise<runtime.RequestOpts>;
|
|
77
|
+
/**
|
|
78
|
+
* Deactivate a custom role
|
|
79
|
+
*/
|
|
80
|
+
deleteRoleRaw(requestParameters: DeleteRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
81
|
+
/**
|
|
82
|
+
* Deactivate a custom role
|
|
83
|
+
*/
|
|
84
|
+
deleteRole(requestParameters: DeleteRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
85
|
+
/**
|
|
86
|
+
* Creates request options for getPermissions without sending the request
|
|
87
|
+
*/
|
|
88
|
+
getPermissionsRequestOpts(): Promise<runtime.RequestOpts>;
|
|
89
|
+
/**
|
|
90
|
+
* List all available permissions in the system
|
|
91
|
+
*/
|
|
92
|
+
getPermissionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetPermission>>>;
|
|
93
|
+
/**
|
|
94
|
+
* List all available permissions in the system
|
|
95
|
+
*/
|
|
96
|
+
getPermissions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetPermission>>;
|
|
97
|
+
/**
|
|
98
|
+
* Creates request options for getRole without sending the request
|
|
99
|
+
*/
|
|
100
|
+
getRoleRequestOpts(requestParameters: GetRoleRequest): Promise<runtime.RequestOpts>;
|
|
101
|
+
/**
|
|
102
|
+
* Get role details with permissions
|
|
103
|
+
*/
|
|
104
|
+
getRoleRaw(requestParameters: GetRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetRole>>;
|
|
105
|
+
/**
|
|
106
|
+
* Get role details with permissions
|
|
107
|
+
*/
|
|
108
|
+
getRole(requestParameters: GetRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetRole>;
|
|
109
|
+
/**
|
|
110
|
+
* Creates request options for getRoles without sending the request
|
|
111
|
+
*/
|
|
112
|
+
getRolesRequestOpts(): Promise<runtime.RequestOpts>;
|
|
113
|
+
/**
|
|
114
|
+
* List all roles available to the current portal
|
|
115
|
+
*/
|
|
116
|
+
getRolesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetRole>>>;
|
|
117
|
+
/**
|
|
118
|
+
* List all roles available to the current portal
|
|
119
|
+
*/
|
|
120
|
+
getRoles(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetRole>>;
|
|
121
|
+
/**
|
|
122
|
+
* Creates request options for getUserRoles without sending the request
|
|
123
|
+
*/
|
|
124
|
+
getUserRolesRequestOpts(requestParameters: GetUserRolesRequest): Promise<runtime.RequestOpts>;
|
|
125
|
+
/**
|
|
126
|
+
* Get all active roles for a user in a portal
|
|
127
|
+
*/
|
|
128
|
+
getUserRolesRaw(requestParameters: GetUserRolesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetUserRole>>>;
|
|
129
|
+
/**
|
|
130
|
+
* Get all active roles for a user in a portal
|
|
131
|
+
*/
|
|
132
|
+
getUserRoles(requestParameters: GetUserRolesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetUserRole>>;
|
|
133
|
+
/**
|
|
134
|
+
* Creates request options for unassignUserRole without sending the request
|
|
135
|
+
*/
|
|
136
|
+
unassignUserRoleRequestOpts(requestParameters: UnassignUserRoleRequest): Promise<runtime.RequestOpts>;
|
|
137
|
+
/**
|
|
138
|
+
* Remove a role from a user for a portal
|
|
139
|
+
*/
|
|
140
|
+
unassignUserRoleRaw(requestParameters: UnassignUserRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
141
|
+
/**
|
|
142
|
+
* Remove a role from a user for a portal
|
|
143
|
+
*/
|
|
144
|
+
unassignUserRole(requestParameters: UnassignUserRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
145
|
+
/**
|
|
146
|
+
* Creates request options for updateRole without sending the request
|
|
147
|
+
*/
|
|
148
|
+
updateRoleRequestOpts(requestParameters: UpdateRoleRequest): Promise<runtime.RequestOpts>;
|
|
149
|
+
/**
|
|
150
|
+
* Update a custom role name and description
|
|
151
|
+
*/
|
|
152
|
+
updateRoleRaw(requestParameters: UpdateRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetRole>>;
|
|
153
|
+
/**
|
|
154
|
+
* Update a custom role name and description
|
|
155
|
+
*/
|
|
156
|
+
updateRole(requestParameters: UpdateRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetRole>;
|
|
157
|
+
/**
|
|
158
|
+
* Creates request options for updateRolePermissions without sending the request
|
|
159
|
+
*/
|
|
160
|
+
updateRolePermissionsRequestOpts(requestParameters: UpdateRolePermissionsRequest): Promise<runtime.RequestOpts>;
|
|
161
|
+
/**
|
|
162
|
+
* Replace all permissions for a custom role
|
|
163
|
+
*/
|
|
164
|
+
updateRolePermissionsRaw(requestParameters: UpdateRolePermissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
165
|
+
/**
|
|
166
|
+
* Replace all permissions for a custom role
|
|
167
|
+
*/
|
|
168
|
+
updateRolePermissions(requestParameters: UpdateRolePermissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
169
|
+
}
|