@iblai/iblai-api 4.233.0-core → 4.234.0-core
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs.js +40 -55
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +41 -56
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +40 -55
- package/dist/index.umd.js.map +1 -1
- package/dist/types/index.d.ts +1 -1
- package/dist/types/models/NotificationTemplateDetail.d.ts +4 -2
- package/dist/types/models/NotificationTemplateList.d.ts +4 -2
- package/dist/types/models/PatchedNotificationTemplateDetail.d.ts +4 -2
- package/dist/types/models/{Type414Enum.d.ts → TypeB04Enum.d.ts} +5 -1
- package/dist/types/services/ReportsService.d.ts +7 -26
- package/package.json +1 -1
- package/sdk_schema.yml +27 -32
- package/src/core/OpenAPI.ts +1 -1
- package/src/index.ts +1 -1
- package/src/models/NotificationTemplateDetail.ts +4 -2
- package/src/models/NotificationTemplateList.ts +4 -2
- package/src/models/PatchedNotificationTemplateDetail.ts +4 -2
- package/src/models/{Type414Enum.ts → TypeB04Enum.ts} +5 -1
- package/src/services/ReportsService.ts +10 -25
|
@@ -8,7 +8,7 @@ import type { NullEnum } from './NullEnum';
|
|
|
8
8
|
import type { PeriodicFrequencyEnum } from './PeriodicFrequencyEnum';
|
|
9
9
|
import type { PeriodicLearnerScopeEnum } from './PeriodicLearnerScopeEnum';
|
|
10
10
|
import type { Spa } from './Spa';
|
|
11
|
-
import type {
|
|
11
|
+
import type { TypeB04Enum } from './TypeB04Enum';
|
|
12
12
|
/**
|
|
13
13
|
* Serializer for detailed template view and editing
|
|
14
14
|
*/
|
|
@@ -29,9 +29,11 @@ export type NotificationTemplateDetail = {
|
|
|
29
29
|
* * `CUSTOM_NOTIFICATION` - Custom Notification
|
|
30
30
|
* * `DEFAULT_TEMPLATE` - Default Template
|
|
31
31
|
* * `HUMAN_SUPPORT_NOTIFICATION` - Human Support Notification
|
|
32
|
+
* * `PATHWAY_ENROLLMENT_CONFIRMATION` - Pathway Enrollment Confirmation
|
|
32
33
|
* * `PLATFORM_INVITATION` - Platform Invitation
|
|
33
34
|
* * `POLICY_ASSIGNMENT` - Policy Assignment
|
|
34
35
|
* * `PROACTIVE_LEARNER_NOTIFICATION` - Proactive Learner Notification
|
|
36
|
+
* * `PROGRAM_ENROLLMENT_CONFIRMATION` - Program Enrollment Confirmation
|
|
35
37
|
* * `PROGRAM_INVITATION` - Program Invitation
|
|
36
38
|
* * `PROGRAM_LICENSE_ASSIGNMENT` - Program License Assignment
|
|
37
39
|
* * `PROGRAM_LICENSE_GROUP_ASSIGNMENT` - Program License Group Assignment
|
|
@@ -46,7 +48,7 @@ export type NotificationTemplateDetail = {
|
|
|
46
48
|
* * `USER_NOTIF_USER_INACTIVITY` - User Notif User Inactivity
|
|
47
49
|
* * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
|
|
48
50
|
*/
|
|
49
|
-
readonly type: (
|
|
51
|
+
readonly type: (TypeB04Enum | NullEnum) | null;
|
|
50
52
|
/**
|
|
51
53
|
* Template display name
|
|
52
54
|
*/
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
/* eslint-disable */
|
|
5
5
|
import type { BlankEnum } from './BlankEnum';
|
|
6
6
|
import type { NullEnum } from './NullEnum';
|
|
7
|
-
import type {
|
|
7
|
+
import type { TypeB04Enum } from './TypeB04Enum';
|
|
8
8
|
/**
|
|
9
9
|
* Serializer for listing notification templates with inheritance info
|
|
10
10
|
*/
|
|
@@ -25,9 +25,11 @@ export type NotificationTemplateList = {
|
|
|
25
25
|
* * `CUSTOM_NOTIFICATION` - Custom Notification
|
|
26
26
|
* * `DEFAULT_TEMPLATE` - Default Template
|
|
27
27
|
* * `HUMAN_SUPPORT_NOTIFICATION` - Human Support Notification
|
|
28
|
+
* * `PATHWAY_ENROLLMENT_CONFIRMATION` - Pathway Enrollment Confirmation
|
|
28
29
|
* * `PLATFORM_INVITATION` - Platform Invitation
|
|
29
30
|
* * `POLICY_ASSIGNMENT` - Policy Assignment
|
|
30
31
|
* * `PROACTIVE_LEARNER_NOTIFICATION` - Proactive Learner Notification
|
|
32
|
+
* * `PROGRAM_ENROLLMENT_CONFIRMATION` - Program Enrollment Confirmation
|
|
31
33
|
* * `PROGRAM_INVITATION` - Program Invitation
|
|
32
34
|
* * `PROGRAM_LICENSE_ASSIGNMENT` - Program License Assignment
|
|
33
35
|
* * `PROGRAM_LICENSE_GROUP_ASSIGNMENT` - Program License Group Assignment
|
|
@@ -42,7 +44,7 @@ export type NotificationTemplateList = {
|
|
|
42
44
|
* * `USER_NOTIF_USER_INACTIVITY` - User Notif User Inactivity
|
|
43
45
|
* * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
|
|
44
46
|
*/
|
|
45
|
-
type?: (
|
|
47
|
+
type?: (TypeB04Enum | BlankEnum | NullEnum) | null;
|
|
46
48
|
/**
|
|
47
49
|
* A friendly name for the notification template.
|
|
48
50
|
*/
|
|
@@ -8,7 +8,7 @@ import type { NullEnum } from './NullEnum';
|
|
|
8
8
|
import type { PeriodicFrequencyEnum } from './PeriodicFrequencyEnum';
|
|
9
9
|
import type { PeriodicLearnerScopeEnum } from './PeriodicLearnerScopeEnum';
|
|
10
10
|
import type { Spa } from './Spa';
|
|
11
|
-
import type {
|
|
11
|
+
import type { TypeB04Enum } from './TypeB04Enum';
|
|
12
12
|
/**
|
|
13
13
|
* Serializer for detailed template view and editing
|
|
14
14
|
*/
|
|
@@ -29,9 +29,11 @@ export type PatchedNotificationTemplateDetail = {
|
|
|
29
29
|
* * `CUSTOM_NOTIFICATION` - Custom Notification
|
|
30
30
|
* * `DEFAULT_TEMPLATE` - Default Template
|
|
31
31
|
* * `HUMAN_SUPPORT_NOTIFICATION` - Human Support Notification
|
|
32
|
+
* * `PATHWAY_ENROLLMENT_CONFIRMATION` - Pathway Enrollment Confirmation
|
|
32
33
|
* * `PLATFORM_INVITATION` - Platform Invitation
|
|
33
34
|
* * `POLICY_ASSIGNMENT` - Policy Assignment
|
|
34
35
|
* * `PROACTIVE_LEARNER_NOTIFICATION` - Proactive Learner Notification
|
|
36
|
+
* * `PROGRAM_ENROLLMENT_CONFIRMATION` - Program Enrollment Confirmation
|
|
35
37
|
* * `PROGRAM_INVITATION` - Program Invitation
|
|
36
38
|
* * `PROGRAM_LICENSE_ASSIGNMENT` - Program License Assignment
|
|
37
39
|
* * `PROGRAM_LICENSE_GROUP_ASSIGNMENT` - Program License Group Assignment
|
|
@@ -46,7 +48,7 @@ export type PatchedNotificationTemplateDetail = {
|
|
|
46
48
|
* * `USER_NOTIF_USER_INACTIVITY` - User Notif User Inactivity
|
|
47
49
|
* * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
|
|
48
50
|
*/
|
|
49
|
-
readonly type?: (
|
|
51
|
+
readonly type?: (TypeB04Enum | NullEnum) | null;
|
|
50
52
|
/**
|
|
51
53
|
* Template display name
|
|
52
54
|
*/
|
|
@@ -12,9 +12,11 @@
|
|
|
12
12
|
* * `CUSTOM_NOTIFICATION` - Custom Notification
|
|
13
13
|
* * `DEFAULT_TEMPLATE` - Default Template
|
|
14
14
|
* * `HUMAN_SUPPORT_NOTIFICATION` - Human Support Notification
|
|
15
|
+
* * `PATHWAY_ENROLLMENT_CONFIRMATION` - Pathway Enrollment Confirmation
|
|
15
16
|
* * `PLATFORM_INVITATION` - Platform Invitation
|
|
16
17
|
* * `POLICY_ASSIGNMENT` - Policy Assignment
|
|
17
18
|
* * `PROACTIVE_LEARNER_NOTIFICATION` - Proactive Learner Notification
|
|
19
|
+
* * `PROGRAM_ENROLLMENT_CONFIRMATION` - Program Enrollment Confirmation
|
|
18
20
|
* * `PROGRAM_INVITATION` - Program Invitation
|
|
19
21
|
* * `PROGRAM_LICENSE_ASSIGNMENT` - Program License Assignment
|
|
20
22
|
* * `PROGRAM_LICENSE_GROUP_ASSIGNMENT` - Program License Group Assignment
|
|
@@ -29,7 +31,7 @@
|
|
|
29
31
|
* * `USER_NOTIF_USER_INACTIVITY` - User Notif User Inactivity
|
|
30
32
|
* * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
|
|
31
33
|
*/
|
|
32
|
-
export enum
|
|
34
|
+
export enum TypeB04Enum {
|
|
33
35
|
ACTIVITY_NEW_CONTENT = 'ACTIVITY_NEW_CONTENT',
|
|
34
36
|
ADMIN_NOTIF_COURSE_ENROLLMENT = 'ADMIN_NOTIF_COURSE_ENROLLMENT',
|
|
35
37
|
APP_REGISTRATION = 'APP_REGISTRATION',
|
|
@@ -39,9 +41,11 @@ export enum Type414Enum {
|
|
|
39
41
|
CUSTOM_NOTIFICATION = 'CUSTOM_NOTIFICATION',
|
|
40
42
|
DEFAULT_TEMPLATE = 'DEFAULT_TEMPLATE',
|
|
41
43
|
HUMAN_SUPPORT_NOTIFICATION = 'HUMAN_SUPPORT_NOTIFICATION',
|
|
44
|
+
PATHWAY_ENROLLMENT_CONFIRMATION = 'PATHWAY_ENROLLMENT_CONFIRMATION',
|
|
42
45
|
PLATFORM_INVITATION = 'PLATFORM_INVITATION',
|
|
43
46
|
POLICY_ASSIGNMENT = 'POLICY_ASSIGNMENT',
|
|
44
47
|
PROACTIVE_LEARNER_NOTIFICATION = 'PROACTIVE_LEARNER_NOTIFICATION',
|
|
48
|
+
PROGRAM_ENROLLMENT_CONFIRMATION = 'PROGRAM_ENROLLMENT_CONFIRMATION',
|
|
45
49
|
PROGRAM_INVITATION = 'PROGRAM_INVITATION',
|
|
46
50
|
PROGRAM_LICENSE_ASSIGNMENT = 'PROGRAM_LICENSE_ASSIGNMENT',
|
|
47
51
|
PROGRAM_LICENSE_GROUP_ASSIGNMENT = 'PROGRAM_LICENSE_GROUP_ASSIGNMENT',
|
|
@@ -11,38 +11,20 @@ import { OpenAPI } from '../core/OpenAPI';
|
|
|
11
11
|
import { request as __request } from '../core/request';
|
|
12
12
|
export class ReportsService {
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
* For each report, it includes:
|
|
17
|
-
* - display_name: Human-readable name of the report
|
|
18
|
-
* - description: Description of what the report contains
|
|
19
|
-
* - icon: URL to an icon representing the report
|
|
20
|
-
* - report_name: Unique identifier for the report
|
|
21
|
-
* - extra_query_params: Additional parameters that can be passed when creating the report
|
|
22
|
-
* - result_columns: Columns that will be included in the report results
|
|
23
|
-
* - status: Current status of the report if it has been previously requested
|
|
24
|
-
*
|
|
25
|
-
* The status will include details like the report ID, state, and download URL if completed.
|
|
26
|
-
*
|
|
27
|
-
* Required RBAC Permissions:
|
|
28
|
-
* 1. CanViewAnalytics (kill switch):
|
|
29
|
-
* - Action: "Ibl.Analytics/CanViewAnalytics/action"
|
|
30
|
-
* - Resource: /platforms/{platform_pk}/
|
|
31
|
-
*
|
|
32
|
-
* 2. Reports access to at least one user or usergroup:
|
|
33
|
-
* - Action: "Ibl.Analytics/Reports/read"
|
|
34
|
-
* - Resource: /platforms/{platform_pk}/users/{user_pk}/ OR
|
|
35
|
-
* /platforms/{platform_pk}/usergroups/{group_pk}/
|
|
36
|
-
* - Note: User must have access to at least one user or usergroup resource
|
|
37
|
-
* with Reports/read permission. Unrestricted access to all users
|
|
38
|
-
* (/platforms/{platform_pk}/users/) also satisfies this requirement.
|
|
14
|
+
* List available reports
|
|
15
|
+
* Return the reports available on the platform along with the latest status for each report previously requested by the caller. When ``mentor_id`` is supplied, access validation is scoped to that mentor.
|
|
39
16
|
* @returns ReportList
|
|
40
17
|
* @throws ApiError
|
|
41
18
|
*/
|
|
42
19
|
public static reportsPlatformsRetrieve({
|
|
43
20
|
key,
|
|
21
|
+
mentorId,
|
|
44
22
|
}: {
|
|
45
23
|
key: string,
|
|
24
|
+
/**
|
|
25
|
+
* Mentor primary key. When provided, access validation is scoped to that mentor.
|
|
26
|
+
*/
|
|
27
|
+
mentorId?: number,
|
|
46
28
|
}): CancelablePromise<ReportList> {
|
|
47
29
|
return __request(OpenAPI, {
|
|
48
30
|
method: 'GET',
|
|
@@ -50,6 +32,9 @@ export class ReportsService {
|
|
|
50
32
|
path: {
|
|
51
33
|
'key': key,
|
|
52
34
|
},
|
|
35
|
+
query: {
|
|
36
|
+
'mentor_id': mentorId,
|
|
37
|
+
},
|
|
53
38
|
});
|
|
54
39
|
}
|
|
55
40
|
/**
|