@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
|
*/
|
|
@@ -30,9 +30,9 @@ const index_1 = require("../models/index");
|
|
|
30
30
|
*/
|
|
31
31
|
class ReportingApi extends runtime.BaseAPI {
|
|
32
32
|
/**
|
|
33
|
-
*
|
|
33
|
+
* Creates request options for getContentGradeDetail without sending the request
|
|
34
34
|
*/
|
|
35
|
-
|
|
35
|
+
getContentGradeDetailRequestOpts(requestParameters) {
|
|
36
36
|
return __awaiter(this, void 0, void 0, function* () {
|
|
37
37
|
if (requestParameters['courseId'] == null) {
|
|
38
38
|
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getContentGradeDetail().');
|
|
@@ -53,12 +53,21 @@ class ReportingApi extends runtime.BaseAPI {
|
|
|
53
53
|
urlPath = urlPath.replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId'])));
|
|
54
54
|
urlPath = urlPath.replace(`{${"contentId"}}`, encodeURIComponent(String(requestParameters['contentId'])));
|
|
55
55
|
urlPath = urlPath.replace(`{${"studentId"}}`, encodeURIComponent(String(requestParameters['studentId'])));
|
|
56
|
-
|
|
56
|
+
return {
|
|
57
57
|
path: urlPath,
|
|
58
58
|
method: 'GET',
|
|
59
59
|
headers: headerParameters,
|
|
60
60
|
query: queryParameters,
|
|
61
|
-
}
|
|
61
|
+
};
|
|
62
|
+
});
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* Get detailed grade information for a specific student and content (can use \'current\' for studentId)
|
|
66
|
+
*/
|
|
67
|
+
getContentGradeDetailRaw(requestParameters, initOverrides) {
|
|
68
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
69
|
+
const requestOptions = yield this.getContentGradeDetailRequestOpts(requestParameters);
|
|
70
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
62
71
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetContentGradeDetailFromJSON)(jsonValue));
|
|
63
72
|
});
|
|
64
73
|
}
|
|
@@ -72,9 +81,9 @@ class ReportingApi extends runtime.BaseAPI {
|
|
|
72
81
|
});
|
|
73
82
|
}
|
|
74
83
|
/**
|
|
75
|
-
*
|
|
84
|
+
* Creates request options for getContentGrades without sending the request
|
|
76
85
|
*/
|
|
77
|
-
|
|
86
|
+
getContentGradesRequestOpts(requestParameters) {
|
|
78
87
|
return __awaiter(this, void 0, void 0, function* () {
|
|
79
88
|
if (requestParameters['courseId'] == null) {
|
|
80
89
|
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getContentGrades().');
|
|
@@ -100,12 +109,21 @@ class ReportingApi extends runtime.BaseAPI {
|
|
|
100
109
|
urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
|
|
101
110
|
urlPath = urlPath.replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId'])));
|
|
102
111
|
urlPath = urlPath.replace(`{${"contentId"}}`, encodeURIComponent(String(requestParameters['contentId'])));
|
|
103
|
-
|
|
112
|
+
return {
|
|
104
113
|
path: urlPath,
|
|
105
114
|
method: 'GET',
|
|
106
115
|
headers: headerParameters,
|
|
107
116
|
query: queryParameters,
|
|
108
|
-
}
|
|
117
|
+
};
|
|
118
|
+
});
|
|
119
|
+
}
|
|
120
|
+
/**
|
|
121
|
+
* Get grades for all students enrolled in course for specific content
|
|
122
|
+
*/
|
|
123
|
+
getContentGradesRaw(requestParameters, initOverrides) {
|
|
124
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
125
|
+
const requestOptions = yield this.getContentGradesRequestOpts(requestParameters);
|
|
126
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
109
127
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetContentGradesFromJSON)(jsonValue));
|
|
110
128
|
});
|
|
111
129
|
}
|
|
@@ -119,9 +137,9 @@ class ReportingApi extends runtime.BaseAPI {
|
|
|
119
137
|
});
|
|
120
138
|
}
|
|
121
139
|
/**
|
|
122
|
-
*
|
|
140
|
+
* Creates request options for getContentInstructorBasicReporting without sending the request
|
|
123
141
|
*/
|
|
124
|
-
|
|
142
|
+
getContentInstructorBasicReportingRequestOpts(requestParameters) {
|
|
125
143
|
return __awaiter(this, void 0, void 0, function* () {
|
|
126
144
|
if (requestParameters['courseId'] == null) {
|
|
127
145
|
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getContentInstructorBasicReporting().');
|
|
@@ -138,12 +156,21 @@ class ReportingApi extends runtime.BaseAPI {
|
|
|
138
156
|
urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
|
|
139
157
|
urlPath = urlPath.replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId'])));
|
|
140
158
|
urlPath = urlPath.replace(`{${"contentId"}}`, encodeURIComponent(String(requestParameters['contentId'])));
|
|
141
|
-
|
|
159
|
+
return {
|
|
142
160
|
path: urlPath,
|
|
143
161
|
method: 'GET',
|
|
144
162
|
headers: headerParameters,
|
|
145
163
|
query: queryParameters,
|
|
146
|
-
}
|
|
164
|
+
};
|
|
165
|
+
});
|
|
166
|
+
}
|
|
167
|
+
/**
|
|
168
|
+
* Get basic instructor reporting for content
|
|
169
|
+
*/
|
|
170
|
+
getContentInstructorBasicReportingRaw(requestParameters, initOverrides) {
|
|
171
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
172
|
+
const requestOptions = yield this.getContentInstructorBasicReportingRequestOpts(requestParameters);
|
|
173
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
147
174
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetContentInstructorBasicReportingFromJSON)(jsonValue));
|
|
148
175
|
});
|
|
149
176
|
}
|
|
@@ -157,9 +184,9 @@ class ReportingApi extends runtime.BaseAPI {
|
|
|
157
184
|
});
|
|
158
185
|
}
|
|
159
186
|
/**
|
|
160
|
-
*
|
|
187
|
+
* Creates request options for getCourseInstructorReportingBasic without sending the request
|
|
161
188
|
*/
|
|
162
|
-
|
|
189
|
+
getCourseInstructorReportingBasicRequestOpts(requestParameters) {
|
|
163
190
|
return __awaiter(this, void 0, void 0, function* () {
|
|
164
191
|
if (requestParameters['courseId'] == null) {
|
|
165
192
|
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseInstructorReportingBasic().');
|
|
@@ -168,12 +195,21 @@ class ReportingApi extends runtime.BaseAPI {
|
|
|
168
195
|
const headerParameters = {};
|
|
169
196
|
let urlPath = `/courses/{courseId}/reporting/instructor/basic`;
|
|
170
197
|
urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
|
|
171
|
-
|
|
198
|
+
return {
|
|
172
199
|
path: urlPath,
|
|
173
200
|
method: 'GET',
|
|
174
201
|
headers: headerParameters,
|
|
175
202
|
query: queryParameters,
|
|
176
|
-
}
|
|
203
|
+
};
|
|
204
|
+
});
|
|
205
|
+
}
|
|
206
|
+
/**
|
|
207
|
+
* Get basic course reporting data for instructors
|
|
208
|
+
*/
|
|
209
|
+
getCourseInstructorReportingBasicRaw(requestParameters, initOverrides) {
|
|
210
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
211
|
+
const requestOptions = yield this.getCourseInstructorReportingBasicRequestOpts(requestParameters);
|
|
212
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
177
213
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetCourseReportingBasicFromJSON)(jsonValue));
|
|
178
214
|
});
|
|
179
215
|
}
|
|
@@ -187,9 +223,9 @@ class ReportingApi extends runtime.BaseAPI {
|
|
|
187
223
|
});
|
|
188
224
|
}
|
|
189
225
|
/**
|
|
190
|
-
*
|
|
226
|
+
* Creates request options for getCourseStudentReporting without sending the request
|
|
191
227
|
*/
|
|
192
|
-
|
|
228
|
+
getCourseStudentReportingRequestOpts(requestParameters) {
|
|
193
229
|
return __awaiter(this, void 0, void 0, function* () {
|
|
194
230
|
if (requestParameters['courseId'] == null) {
|
|
195
231
|
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseStudentReporting().');
|
|
@@ -202,12 +238,21 @@ class ReportingApi extends runtime.BaseAPI {
|
|
|
202
238
|
let urlPath = `/courses/{courseId}/reporting/students/{studentId}`;
|
|
203
239
|
urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
|
|
204
240
|
urlPath = urlPath.replace(`{${"studentId"}}`, encodeURIComponent(String(requestParameters['studentId'])));
|
|
205
|
-
|
|
241
|
+
return {
|
|
206
242
|
path: urlPath,
|
|
207
243
|
method: 'GET',
|
|
208
244
|
headers: headerParameters,
|
|
209
245
|
query: queryParameters,
|
|
210
|
-
}
|
|
246
|
+
};
|
|
247
|
+
});
|
|
248
|
+
}
|
|
249
|
+
/**
|
|
250
|
+
* Get student-specific reporting for a course (can use \'current\' for studentId)
|
|
251
|
+
*/
|
|
252
|
+
getCourseStudentReportingRaw(requestParameters, initOverrides) {
|
|
253
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
254
|
+
const requestOptions = yield this.getCourseStudentReportingRequestOpts(requestParameters);
|
|
255
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
211
256
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetCourseStudentReportingFromJSON)(jsonValue));
|
|
212
257
|
});
|
|
213
258
|
}
|
|
@@ -221,9 +266,9 @@ class ReportingApi extends runtime.BaseAPI {
|
|
|
221
266
|
});
|
|
222
267
|
}
|
|
223
268
|
/**
|
|
224
|
-
*
|
|
269
|
+
* Creates request options for getModuleInstructorBasicReporting without sending the request
|
|
225
270
|
*/
|
|
226
|
-
|
|
271
|
+
getModuleInstructorBasicReportingRequestOpts(requestParameters) {
|
|
227
272
|
return __awaiter(this, void 0, void 0, function* () {
|
|
228
273
|
if (requestParameters['courseId'] == null) {
|
|
229
274
|
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getModuleInstructorBasicReporting().');
|
|
@@ -236,12 +281,21 @@ class ReportingApi extends runtime.BaseAPI {
|
|
|
236
281
|
let urlPath = `/courses/{courseId}/modules/{moduleId}/reporting/instructor/basic`;
|
|
237
282
|
urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
|
|
238
283
|
urlPath = urlPath.replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId'])));
|
|
239
|
-
|
|
284
|
+
return {
|
|
240
285
|
path: urlPath,
|
|
241
286
|
method: 'GET',
|
|
242
287
|
headers: headerParameters,
|
|
243
288
|
query: queryParameters,
|
|
244
|
-
}
|
|
289
|
+
};
|
|
290
|
+
});
|
|
291
|
+
}
|
|
292
|
+
/**
|
|
293
|
+
* Get basic instructor reporting for a module
|
|
294
|
+
*/
|
|
295
|
+
getModuleInstructorBasicReportingRaw(requestParameters, initOverrides) {
|
|
296
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
297
|
+
const requestOptions = yield this.getModuleInstructorBasicReportingRequestOpts(requestParameters);
|
|
298
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
245
299
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetModuleInstructorBasicReportingFromJSON)(jsonValue));
|
|
246
300
|
});
|
|
247
301
|
}
|
|
@@ -255,9 +309,9 @@ class ReportingApi extends runtime.BaseAPI {
|
|
|
255
309
|
});
|
|
256
310
|
}
|
|
257
311
|
/**
|
|
258
|
-
*
|
|
312
|
+
* Creates request options for getModuleStudentReporting without sending the request
|
|
259
313
|
*/
|
|
260
|
-
|
|
314
|
+
getModuleStudentReportingRequestOpts(requestParameters) {
|
|
261
315
|
return __awaiter(this, void 0, void 0, function* () {
|
|
262
316
|
if (requestParameters['courseId'] == null) {
|
|
263
317
|
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getModuleStudentReporting().');
|
|
@@ -274,12 +328,21 @@ class ReportingApi extends runtime.BaseAPI {
|
|
|
274
328
|
urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
|
|
275
329
|
urlPath = urlPath.replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId'])));
|
|
276
330
|
urlPath = urlPath.replace(`{${"studentId"}}`, encodeURIComponent(String(requestParameters['studentId'])));
|
|
277
|
-
|
|
331
|
+
return {
|
|
278
332
|
path: urlPath,
|
|
279
333
|
method: 'GET',
|
|
280
334
|
headers: headerParameters,
|
|
281
335
|
query: queryParameters,
|
|
282
|
-
}
|
|
336
|
+
};
|
|
337
|
+
});
|
|
338
|
+
}
|
|
339
|
+
/**
|
|
340
|
+
* Get student-specific reporting for a module (can use \'current\' for studentId)
|
|
341
|
+
*/
|
|
342
|
+
getModuleStudentReportingRaw(requestParameters, initOverrides) {
|
|
343
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
344
|
+
const requestOptions = yield this.getModuleStudentReportingRequestOpts(requestParameters);
|
|
345
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
283
346
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetModuleStudentReportingFromJSON)(jsonValue));
|
|
284
347
|
});
|
|
285
348
|
}
|
|
@@ -293,9 +356,9 @@ class ReportingApi extends runtime.BaseAPI {
|
|
|
293
356
|
});
|
|
294
357
|
}
|
|
295
358
|
/**
|
|
296
|
-
*
|
|
359
|
+
* Creates request options for getPortalBasicReporting without sending the request
|
|
297
360
|
*/
|
|
298
|
-
|
|
361
|
+
getPortalBasicReportingRequestOpts(requestParameters) {
|
|
299
362
|
return __awaiter(this, void 0, void 0, function* () {
|
|
300
363
|
if (requestParameters['portalId'] == null) {
|
|
301
364
|
throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling getPortalBasicReporting().');
|
|
@@ -304,12 +367,21 @@ class ReportingApi extends runtime.BaseAPI {
|
|
|
304
367
|
const headerParameters = {};
|
|
305
368
|
let urlPath = `/portals/{portalId}/reporting/basic`;
|
|
306
369
|
urlPath = urlPath.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId'])));
|
|
307
|
-
|
|
370
|
+
return {
|
|
308
371
|
path: urlPath,
|
|
309
372
|
method: 'GET',
|
|
310
373
|
headers: headerParameters,
|
|
311
374
|
query: queryParameters,
|
|
312
|
-
}
|
|
375
|
+
};
|
|
376
|
+
});
|
|
377
|
+
}
|
|
378
|
+
/**
|
|
379
|
+
* Get basic reporting for a portal (can use \'current\' for portalId)
|
|
380
|
+
*/
|
|
381
|
+
getPortalBasicReportingRaw(requestParameters, initOverrides) {
|
|
382
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
383
|
+
const requestOptions = yield this.getPortalBasicReportingRequestOpts(requestParameters);
|
|
384
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
313
385
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetPortalBasicReportingFromJSON)(jsonValue));
|
|
314
386
|
});
|
|
315
387
|
}
|
|
@@ -323,9 +395,9 @@ class ReportingApi extends runtime.BaseAPI {
|
|
|
323
395
|
});
|
|
324
396
|
}
|
|
325
397
|
/**
|
|
326
|
-
*
|
|
398
|
+
* Creates request options for getPortalStudentReporting without sending the request
|
|
327
399
|
*/
|
|
328
|
-
|
|
400
|
+
getPortalStudentReportingRequestOpts(requestParameters) {
|
|
329
401
|
return __awaiter(this, void 0, void 0, function* () {
|
|
330
402
|
if (requestParameters['portalId'] == null) {
|
|
331
403
|
throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling getPortalStudentReporting().');
|
|
@@ -338,12 +410,21 @@ class ReportingApi extends runtime.BaseAPI {
|
|
|
338
410
|
let urlPath = `/portals/{portalId}/reporting/students/{studentId}`;
|
|
339
411
|
urlPath = urlPath.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId'])));
|
|
340
412
|
urlPath = urlPath.replace(`{${"studentId"}}`, encodeURIComponent(String(requestParameters['studentId'])));
|
|
341
|
-
|
|
413
|
+
return {
|
|
342
414
|
path: urlPath,
|
|
343
415
|
method: 'GET',
|
|
344
416
|
headers: headerParameters,
|
|
345
417
|
query: queryParameters,
|
|
346
|
-
}
|
|
418
|
+
};
|
|
419
|
+
});
|
|
420
|
+
}
|
|
421
|
+
/**
|
|
422
|
+
* Get student reporting for a portal (can use \'current\' for portalId and studentId)
|
|
423
|
+
*/
|
|
424
|
+
getPortalStudentReportingRaw(requestParameters, initOverrides) {
|
|
425
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
426
|
+
const requestOptions = yield this.getPortalStudentReportingRequestOpts(requestParameters);
|
|
427
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
347
428
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetPortalStudentReportingFromJSON)(jsonValue));
|
|
348
429
|
});
|
|
349
430
|
}
|
|
@@ -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
|
+
}
|