@iblai/iblai-api 0.0.2-core → 0.0.12-scan-core

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (200) hide show
  1. package/dist/index.cjs.js +3800 -3143
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.esm.js +3800 -3143
  4. package/dist/index.esm.js.map +1 -1
  5. package/dist/index.umd.js +3800 -3143
  6. package/dist/index.umd.js.map +1 -1
  7. package/dist/types/index.d.ts +27 -5
  8. package/dist/types/models/CatalogAutoIncrementResponse.d.ts +11 -11
  9. package/dist/types/models/CourseGroupSuggestionDetail.d.ts +2 -2
  10. package/dist/types/models/CourseInvitationDetail.d.ts +2 -2
  11. package/dist/types/models/CourseLicenseAssignmentDetail.d.ts +2 -2
  12. package/dist/types/models/CourseLicenseDetail.d.ts +4 -0
  13. package/dist/types/models/CourseLicenseGroupAssignmentDetail.d.ts +2 -2
  14. package/dist/types/models/CourseReviewPaginatedResponse.d.ts +18 -0
  15. package/dist/types/models/CourseReviewRequest.d.ts +37 -0
  16. package/dist/types/models/CourseReviewResponse.d.ts +40 -0
  17. package/dist/types/models/PaginatedAssertionsResponse.d.ts +21 -0
  18. package/dist/types/models/PaginatedCourseAccessRequest.d.ts +2 -2
  19. package/dist/types/models/PaginatedCourseGroupSuggestion.d.ts +2 -2
  20. package/dist/types/models/PaginatedCourseInvitation.d.ts +2 -2
  21. package/dist/types/models/PaginatedCourseLicense.d.ts +2 -2
  22. package/dist/types/models/PaginatedCourseLicenseAssignment.d.ts +2 -2
  23. package/dist/types/models/PaginatedCourseLicenseGroupAssignment.d.ts +2 -2
  24. package/dist/types/models/PaginatedCourseSuggestion.d.ts +2 -2
  25. package/dist/types/models/PaginatedPathwayGroupSuggestion.d.ts +2 -2
  26. package/dist/types/models/PaginatedPathwaySuggestion.d.ts +2 -2
  27. package/dist/types/models/PaginatedPlatformInvitation.d.ts +2 -2
  28. package/dist/types/models/PaginatedPlatformLicense.d.ts +2 -2
  29. package/dist/types/models/PaginatedProgramGroupSuggestion.d.ts +2 -2
  30. package/dist/types/models/PaginatedProgramInvitation.d.ts +2 -2
  31. package/dist/types/models/PaginatedProgramLicense.d.ts +2 -2
  32. package/dist/types/models/PaginatedProgramLicenseAssignment.d.ts +2 -2
  33. package/dist/types/models/PaginatedProgramLicenseGroupAssignment.d.ts +2 -2
  34. package/dist/types/models/PaginatedProgramSuggestion.d.ts +2 -2
  35. package/dist/types/models/PaginatedRbacGroupList.d.ts +7 -0
  36. package/dist/types/models/PaginatedRbacPolicyList.d.ts +7 -0
  37. package/dist/types/models/PaginatedRbacRoleList.d.ts +7 -0
  38. package/dist/types/models/PaginatedSkill.d.ts +7 -0
  39. package/dist/types/models/PaginatedUserLicense.d.ts +2 -2
  40. package/dist/types/models/PaginatedUserLicenseAssignment.d.ts +2 -2
  41. package/dist/types/models/PaginatedUserLicenseGroupAssignment.d.ts +2 -2
  42. package/dist/types/models/PatchedRbacGroup.d.ts +34 -0
  43. package/dist/types/models/PatchedRbacPolicy.d.ts +48 -0
  44. package/dist/types/models/PatchedRbacRole.d.ts +20 -0
  45. package/dist/types/models/PathwayGroupSuggestionDetail.d.ts +2 -2
  46. package/dist/types/models/PlatformInvitationDetail.d.ts +2 -2
  47. package/dist/types/models/PlatformSkillPointResponse.d.ts +2 -2
  48. package/dist/types/models/ProgramEnrollmentSearchResponse.d.ts +22 -0
  49. package/dist/types/models/ProgramLicenseAssignmentDetail.d.ts +4 -9
  50. package/dist/types/models/ProgramLicenseDetail.d.ts +6 -2
  51. package/dist/types/models/ProgramMetadataRequest.d.ts +29 -0
  52. package/dist/types/models/ProgramMetadataResponse.d.ts +29 -0
  53. package/dist/types/models/ProgramReview.d.ts +41 -0
  54. package/dist/types/models/ProgramReviewPaginatedResponse.d.ts +22 -0
  55. package/dist/types/models/ProgramReviewRequest.d.ts +37 -0
  56. package/dist/types/models/RbacBaseRole.d.ts +15 -0
  57. package/dist/types/models/RbacGroup.d.ts +34 -0
  58. package/dist/types/models/RbacPlatform.d.ts +14 -0
  59. package/dist/types/models/RbacPolicy.d.ts +48 -0
  60. package/dist/types/models/RbacPolicyGroup.d.ts +20 -0
  61. package/dist/types/models/RbacRole.d.ts +20 -0
  62. package/dist/types/models/RbacUser.d.ts +13 -0
  63. package/dist/types/models/StripeBillingPageIdentifierResponse.d.ts +9 -0
  64. package/dist/types/models/StripeContext.d.ts +7 -0
  65. package/dist/types/models/StripeNewUserTenantLaunchRequest.d.ts +20 -0
  66. package/dist/types/models/UserApp.d.ts +0 -2
  67. package/dist/types/models/UserLicenseAssignmentDetail.d.ts +1 -1
  68. package/dist/types/models/UserLicenseDetail.d.ts +5 -1
  69. package/dist/types/models/UserLicenseGroupAssignmentDetail.d.ts +2 -2
  70. package/dist/types/services/AnalyticsService.d.ts +42 -13
  71. package/dist/types/services/AudienceService.d.ts +345 -149
  72. package/dist/types/services/CareerService.d.ts +117 -90
  73. package/dist/types/services/CatalogService.d.ts +3799 -1430
  74. package/dist/types/services/CoreService.d.ts +452 -126
  75. package/dist/types/services/CredentialsService.d.ts +177 -141
  76. package/dist/types/services/DepartmentsService.d.ts +53 -16
  77. package/dist/types/services/EngagementService.d.ts +459 -179
  78. package/dist/types/services/FeaturesService.d.ts +16 -7
  79. package/dist/types/services/FinanceService.d.ts +49 -20
  80. package/dist/types/services/MediaResourcesService.d.ts +243 -67
  81. package/dist/types/services/NotificationBuilderService.d.ts +31 -17
  82. package/dist/types/services/NotificationService.d.ts +56 -49
  83. package/dist/types/services/OrgsService.d.ts +106 -77
  84. package/dist/types/services/OverviewService.d.ts +154 -55
  85. package/dist/types/services/PerformanceService.d.ts +132 -56
  86. package/dist/types/services/PerlearnerService.d.ts +431 -217
  87. package/dist/types/services/PlatformService.d.ts +221 -116
  88. package/dist/types/services/ProviderAssociationService.d.ts +3 -2
  89. package/dist/types/services/ProvidersService.d.ts +40 -18
  90. package/dist/types/services/ProvisionService.d.ts +3 -2
  91. package/dist/types/services/RecommendationsService.d.ts +3 -3
  92. package/dist/types/services/ReportsService.d.ts +22 -16
  93. package/dist/types/services/RolesService.d.ts +8 -6
  94. package/dist/types/services/SearchService.d.ts +305 -80
  95. package/dist/types/services/ServiceService.d.ts +89 -29
  96. package/dist/types/services/SkillsService.d.ts +40 -32
  97. package/dist/types/services/UserGroupsService.d.ts +53 -16
  98. package/package.json +3 -2
  99. package/src/core/OpenAPI.ts +1 -1
  100. package/src/index.ts +27 -5
  101. package/src/models/CatalogAutoIncrementResponse.ts +11 -11
  102. package/src/models/CourseGroupSuggestionDetail.ts +2 -2
  103. package/src/models/CourseInvitationDetail.ts +2 -2
  104. package/src/models/CourseLicenseAssignmentDetail.ts +2 -2
  105. package/src/models/CourseLicenseDetail.ts +4 -0
  106. package/src/models/CourseLicenseGroupAssignmentDetail.ts +2 -2
  107. package/src/models/CourseReviewPaginatedResponse.ts +23 -0
  108. package/src/models/CourseReviewRequest.ts +42 -0
  109. package/src/models/CourseReviewResponse.ts +45 -0
  110. package/src/models/PaginatedAssertionsResponse.ts +26 -0
  111. package/src/models/PaginatedCourseAccessRequest.ts +2 -2
  112. package/src/models/PaginatedCourseGroupSuggestion.ts +2 -2
  113. package/src/models/PaginatedCourseInvitation.ts +2 -2
  114. package/src/models/PaginatedCourseLicense.ts +2 -2
  115. package/src/models/PaginatedCourseLicenseAssignment.ts +2 -2
  116. package/src/models/PaginatedCourseLicenseGroupAssignment.ts +2 -2
  117. package/src/models/PaginatedCourseSuggestion.ts +2 -2
  118. package/src/models/PaginatedPathwayGroupSuggestion.ts +2 -2
  119. package/src/models/PaginatedPathwaySuggestion.ts +2 -2
  120. package/src/models/PaginatedPlatformInvitation.ts +2 -2
  121. package/src/models/PaginatedPlatformLicense.ts +2 -2
  122. package/src/models/PaginatedProgramGroupSuggestion.ts +2 -2
  123. package/src/models/PaginatedProgramInvitation.ts +2 -2
  124. package/src/models/PaginatedProgramLicense.ts +2 -2
  125. package/src/models/PaginatedProgramLicenseAssignment.ts +2 -2
  126. package/src/models/PaginatedProgramLicenseGroupAssignment.ts +2 -2
  127. package/src/models/PaginatedProgramSuggestion.ts +2 -2
  128. package/src/models/PaginatedRbacGroupList.ts +12 -0
  129. package/src/models/PaginatedRbacPolicyList.ts +12 -0
  130. package/src/models/PaginatedRbacRoleList.ts +12 -0
  131. package/src/models/PaginatedSkill.ts +12 -0
  132. package/src/models/PaginatedUserLicense.ts +2 -2
  133. package/src/models/PaginatedUserLicenseAssignment.ts +2 -2
  134. package/src/models/PaginatedUserLicenseGroupAssignment.ts +2 -2
  135. package/src/models/PatchedRbacGroup.ts +39 -0
  136. package/src/models/PatchedRbacPolicy.ts +53 -0
  137. package/src/models/PatchedRbacRole.ts +25 -0
  138. package/src/models/PathwayGroupSuggestionDetail.ts +2 -2
  139. package/src/models/PlatformInvitationDetail.ts +2 -2
  140. package/src/models/PlatformSkillPointResponse.ts +2 -2
  141. package/src/models/ProgramEnrollmentSearchResponse.ts +27 -0
  142. package/src/models/ProgramLicenseAssignmentDetail.ts +4 -9
  143. package/src/models/ProgramLicenseDetail.ts +6 -2
  144. package/src/models/ProgramMetadataRequest.ts +34 -0
  145. package/src/models/ProgramMetadataResponse.ts +34 -0
  146. package/src/models/ProgramReview.ts +46 -0
  147. package/src/models/ProgramReviewPaginatedResponse.ts +27 -0
  148. package/src/models/ProgramReviewRequest.ts +42 -0
  149. package/src/models/RbacBaseRole.ts +20 -0
  150. package/src/models/RbacGroup.ts +39 -0
  151. package/src/models/RbacPlatform.ts +19 -0
  152. package/src/models/RbacPolicy.ts +53 -0
  153. package/src/models/RbacPolicyGroup.ts +25 -0
  154. package/src/models/RbacRole.ts +25 -0
  155. package/src/models/RbacUser.ts +18 -0
  156. package/src/models/StripeBillingPageIdentifierResponse.ts +14 -0
  157. package/src/models/StripeContext.ts +12 -0
  158. package/src/models/StripeNewUserTenantLaunchRequest.ts +25 -0
  159. package/src/models/UserApp.ts +0 -2
  160. package/src/models/UserLicenseAssignmentDetail.ts +1 -1
  161. package/src/models/UserLicenseDetail.ts +5 -1
  162. package/src/models/UserLicenseGroupAssignmentDetail.ts +2 -2
  163. package/src/services/AnalyticsService.ts +45 -16
  164. package/src/services/AudienceService.ts +380 -184
  165. package/src/services/CareerService.ts +144 -117
  166. package/src/services/CatalogService.ts +6902 -4245
  167. package/src/services/CoreService.ts +782 -172
  168. package/src/services/CredentialsService.ts +257 -176
  169. package/src/services/DepartmentsService.ts +56 -19
  170. package/src/services/EngagementService.ts +528 -236
  171. package/src/services/FeaturesService.ts +19 -10
  172. package/src/services/FinanceService.ts +54 -25
  173. package/src/services/MediaResourcesService.ts +251 -75
  174. package/src/services/NotificationBuilderService.ts +36 -22
  175. package/src/services/NotificationService.ts +73 -61
  176. package/src/services/OrgsService.ts +135 -106
  177. package/src/services/OverviewService.ts +172 -73
  178. package/src/services/PerformanceService.ts +153 -77
  179. package/src/services/PerlearnerService.ts +591 -279
  180. package/src/services/PlatformService.ts +278 -157
  181. package/src/services/ProviderAssociationService.ts +4 -3
  182. package/src/services/ProvidersService.ts +58 -27
  183. package/src/services/ProvisionService.ts +4 -3
  184. package/src/services/RecommendationsService.ts +5 -4
  185. package/src/services/ReportsService.ts +28 -22
  186. package/src/services/RolesService.ts +10 -8
  187. package/src/services/SearchService.ts +323 -98
  188. package/src/services/ServiceService.ts +149 -39
  189. package/src/services/SkillsService.ts +56 -44
  190. package/src/services/UserGroupsService.ts +56 -19
  191. package/dist/types/models/BlockSkillPointInfoResponse.d.ts +0 -10
  192. package/dist/types/models/CourseCompletionCatalogResponse.d.ts +0 -11
  193. package/dist/types/models/CourseEligibilityCheckResponse.d.ts +0 -25
  194. package/dist/types/models/CourseSkillPointInfoResponse.d.ts +0 -10
  195. package/dist/types/models/UserSkillPointInfoResponse.d.ts +0 -10
  196. package/src/models/BlockSkillPointInfoResponse.ts +0 -15
  197. package/src/models/CourseCompletionCatalogResponse.ts +0 -16
  198. package/src/models/CourseEligibilityCheckResponse.ts +0 -30
  199. package/src/models/CourseSkillPointInfoResponse.ts +0 -15
  200. package/src/models/UserSkillPointInfoResponse.ts +0 -15
@@ -0,0 +1,20 @@
1
+ import type { RbacPlatform } from './RbacPlatform';
2
+ /**
3
+ * Serializer for roles.
4
+ */
5
+ export type RbacRole = {
6
+ readonly id: number;
7
+ name: string;
8
+ /**
9
+ * Platform information (read-only)
10
+ */
11
+ readonly platform: RbacPlatform;
12
+ /**
13
+ * Platform key where this role belongs
14
+ */
15
+ platform_key: string;
16
+ /**
17
+ * List of actions/permissions this role can perform (e.g., ['Ibl.Mentor/Settings/read', 'Ibl.Mentor/Settings/write'])
18
+ */
19
+ actions: Array<string>;
20
+ };
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Serializer for users.
3
+ */
4
+ export type RbacUser = {
5
+ /**
6
+ * edX user ID
7
+ */
8
+ readonly id: number;
9
+ /**
10
+ * edX username
11
+ */
12
+ username?: string | null;
13
+ };
@@ -0,0 +1,9 @@
1
+ export type StripeBillingPageIdentifierResponse = {
2
+ publishable_key: string;
3
+ pricing_table_id: string;
4
+ pricing_table_js: any;
5
+ payment_link_id: string;
6
+ payment_link_url: string;
7
+ customer_email: string;
8
+ client_reference_id: string;
9
+ };
@@ -0,0 +1,7 @@
1
+ export type StripeContext = {
2
+ publishable_key: string;
3
+ pricing_table_id: string;
4
+ pricing_table_js: any;
5
+ payment_link_id: string;
6
+ payment_link_url: string;
7
+ };
@@ -0,0 +1,20 @@
1
+ export type StripeNewUserTenantLaunchRequest = {
2
+ username?: string;
3
+ email?: string;
4
+ firstname?: string;
5
+ lastname?: string;
6
+ password?: string;
7
+ /**
8
+ * Organization name
9
+ */
10
+ name: string;
11
+ /**
12
+ * Unique key for the organization
13
+ */
14
+ key: string;
15
+ ignore_user_exists?: boolean;
16
+ /**
17
+ * Stripe Checkout Id to launch the tenant
18
+ */
19
+ stripe_checkout_id_alt: string;
20
+ };
@@ -22,6 +22,4 @@ export type UserApp = {
22
22
  free_trial_started?: boolean;
23
23
  free_trial_expired?: boolean;
24
24
  has_active_subscription?: boolean;
25
- readonly created_at: string;
26
- readonly updated_at: string;
27
25
  };
@@ -29,7 +29,7 @@ export type UserLicenseAssignmentDetail = {
29
29
  /**
30
30
  * URL to redirect to after fulfillment
31
31
  */
32
- redirect_to: string | null;
32
+ redirect_to?: string | null;
33
33
  /**
34
34
  * Additional metadata for the assignment
35
35
  */
@@ -46,8 +46,12 @@ export type UserLicenseDetail = {
46
46
  * The platform key associated with the license
47
47
  */
48
48
  platform_key: string;
49
+ /**
50
+ * Number of assignments using this license
51
+ */
52
+ usage_count?: number;
49
53
  /**
50
54
  * Assignment counts by status (only included in verbose mode)
51
55
  */
52
- assignments?: Record<string, number>;
56
+ assignments?: any;
53
57
  };
@@ -21,11 +21,11 @@ export type UserLicenseGroupAssignmentDetail = {
21
21
  /**
22
22
  * Whether the assignment has been fulfilled
23
23
  */
24
- fulfilled: boolean;
24
+ fulfilled?: boolean;
25
25
  /**
26
26
  * URL to redirect to after fulfillment
27
27
  */
28
- redirect_to: string | null;
28
+ redirect_to?: string | null;
29
29
  /**
30
30
  * Additional metadata for the assignment
31
31
  */
@@ -26,29 +26,58 @@ export declare class AnalyticsService {
26
26
  *
27
27
  * Notes:
28
28
  * This API must be enabled via the ENABLE_TIME_SPENT_UPDATE_API setting.
29
- * @param org
30
- * @param requestBody
31
29
  * @returns TimeSpentUpdateResponse
32
30
  * @throws ApiError
33
31
  */
34
- static analyticsOrgsTimeUpdateCreate(org: string, requestBody: TimeSpentUpdateRequest): CancelablePromise<TimeSpentUpdateResponse>;
32
+ static analyticsOrgsTimeUpdateCreate({ org, requestBody, }: {
33
+ org: string;
34
+ requestBody: TimeSpentUpdateRequest;
35
+ }): CancelablePromise<TimeSpentUpdateResponse>;
35
36
  /**
36
37
  * Get total time spent for current user
37
38
  *
38
39
  * Returns the total time spent (in seconds) for the current authenticated user.
39
40
  * Can be filtered by platform, date range, course ID, URL, mentor UUID, and session UUID.
40
41
  *
41
- * @param courseId Course ID to filter by (can be partial)
42
- * @param endDate End date for time range (YYYY-MM-DD)
43
- * @param includeMainPlatform Whether to include main platform data
44
- * @param learnerId Username to get data for (admin users only)
45
- * @param mentorUuid Mentor UUID to filter by
46
- * @param platform Platform name or key to filter by
47
- * @param sessionUuid Session UUID to filter by
48
- * @param startDate Start date for time range (YYYY-MM-DD)
49
- * @param url URL to filter by (can be partial)
50
42
  * @returns TimeSpentPerUserResponse
51
43
  * @throws ApiError
52
44
  */
53
- static analyticsTimeSpentUserRetrieve(courseId?: string, endDate?: string, includeMainPlatform?: boolean, learnerId?: string, mentorUuid?: string, platform?: string | null, sessionUuid?: string, startDate?: string, url?: string): CancelablePromise<TimeSpentPerUserResponse>;
45
+ static analyticsTimeSpentUserRetrieve({ courseId, endDate, includeMainPlatform, learnerId, mentorUuid, platform, sessionUuid, startDate, url, }: {
46
+ /**
47
+ * Course ID to filter by (can be partial)
48
+ */
49
+ courseId?: string;
50
+ /**
51
+ * End date for time range (YYYY-MM-DD)
52
+ */
53
+ endDate?: string;
54
+ /**
55
+ * Whether to include main platform data
56
+ */
57
+ includeMainPlatform?: boolean;
58
+ /**
59
+ * Username to get data for (admin users only)
60
+ */
61
+ learnerId?: string;
62
+ /**
63
+ * Mentor UUID to filter by
64
+ */
65
+ mentorUuid?: string;
66
+ /**
67
+ * Platform name or key to filter by
68
+ */
69
+ platform?: string | null;
70
+ /**
71
+ * Session UUID to filter by
72
+ */
73
+ sessionUuid?: string;
74
+ /**
75
+ * Start date for time range (YYYY-MM-DD)
76
+ */
77
+ startDate?: string;
78
+ /**
79
+ * URL to filter by (can be partial)
80
+ */
81
+ url?: string;
82
+ }): CancelablePromise<TimeSpentPerUserResponse>;
54
83
  }