@iblai/iblai-api 4.109.0-ai → 4.110.0-ai

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 (13) hide show
  1. package/dist/index.cjs.js +31 -13
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.esm.js +31 -13
  4. package/dist/index.esm.js.map +1 -1
  5. package/dist/index.umd.js +31 -13
  6. package/dist/index.umd.js.map +1 -1
  7. package/dist/types/services/AiAnalyticsService.d.ts +18 -3
  8. package/dist/types/services/AnalyticsService.d.ts +18 -3
  9. package/package.json +1 -1
  10. package/sdk_schema.yml +28 -2
  11. package/src/core/OpenAPI.ts +1 -1
  12. package/src/services/AiAnalyticsService.ts +21 -0
  13. package/src/services/AnalyticsService.ts +21 -0
package/dist/types/services/AnalyticsService.d.ts CHANGED
@@ -25,6 +25,9 @@ export declare class AnalyticsService {
25
25
  * When a platform_key is provided, results are filtered to show only content consumed by
26
26
  * learners associated with that platform.
27
27
  *
28
+ * **RBAC Requirements:**
29
+ * - Requires: Analytics Viewer role (Ibl.Analytics/Core/read) or Tenant Admin role (Ibl.*)
30
+ *
28
31
  * **Metrics supported:**
29
32
  * - `course` or `courses`: Course analytics with time spent
30
33
  * - `program` or `programs`: Program analytics
@@ -48,7 +51,7 @@ export declare class AnalyticsService {
48
51
  * @returns ContentResponse
49
52
  * @throws ApiError
50
53
  */
51
- static getContentAnalytics({ metric, dateFilter, endDate, granularity, includeOvertime, limit, mentorUniqueId, page, platformKey, startDate, }: {
54
+ static getContentAnalytics({ metric, dateFilter, endDate, granularity, includeOvertime, limit, mentorUniqueId, page, platformKey, startDate, usergroupIds, }: {
52
55
  /**
53
56
  * The type of content to retrieve (course, program, pathway, skill)
54
57
  *
@@ -97,6 +100,10 @@ export declare class AnalyticsService {
97
100
  */
98
101
  platformKey?: string | null;
99
102
  startDate?: string;
103
+ /**
104
+ * Optional list of usergroup IDs to filter results
105
+ */
106
+ usergroupIds?: Array<number> | null;
100
107
  }): CancelablePromise<ContentResponse>;
101
108
  /**
102
109
  * Get Content Details
@@ -104,7 +111,7 @@ export declare class AnalyticsService {
104
111
  * @returns ContentDetailsResponse
105
112
  * @throws ApiError
106
113
  */
107
- static getContentDetails({ contentId, metric, dateFilter, endDate, limit, mentorUniqueId, page, platformKey, search, startDate, timeMetric, }: {
114
+ static getContentDetails({ contentId, metric, dateFilter, endDate, limit, mentorUniqueId, page, platformKey, search, startDate, timeMetric, usergroupIds, }: {
108
115
  contentId: string;
109
116
  /**
110
117
  * Content type to fetch (course, program, pathway, skill)
@@ -142,6 +149,10 @@ export declare class AnalyticsService {
142
149
  * Optional time series metric (enrollments, completions, ratings, time_spent)
143
150
  */
144
151
  timeMetric?: string | null;
152
+ /**
153
+ * Optional list of usergroup IDs to filter results
154
+ */
155
+ usergroupIds?: Array<number> | null;
145
156
  }): CancelablePromise<ContentDetailsResponse>;
146
157
  /**
147
158
  * Financial Analytics API - Get comprehensive cost metrics with comparison analysis.
@@ -537,7 +548,7 @@ export declare class AnalyticsService {
537
548
  * @returns LearnerListResponse Paginated list of learners with their metrics
538
549
  * @throws ApiError
539
550
  */
540
- static analyticsLearnersListRetrieve({ platformKey, dateFilter, endDate, granularity, limit, mentorUniqueId, page, search, sortBy, sortOrder, startDate, }: {
551
+ static analyticsLearnersListRetrieve({ platformKey, dateFilter, endDate, granularity, limit, mentorUniqueId, page, search, sortBy, sortOrder, startDate, usergroupIds, }: {
541
552
  /**
542
553
  * Platform key to filter learners by platform
543
554
  */
@@ -592,6 +603,10 @@ export declare class AnalyticsService {
592
603
  */
593
604
  sortOrder?: 'asc' | 'desc';
594
605
  startDate?: string;
606
+ /**
607
+ * Optional list of usergroup IDs to filter results
608
+ */
609
+ usergroupIds?: Array<number> | null;
595
610
  }): CancelablePromise<LearnerListResponse>;
596
611
  /**
597
612
  * Conversation list endpoint for analytics.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@iblai/iblai-api",
3
- "version": "4.109.0-ai",
3
+ "version": "4.110.0-ai",
4
4
  "main": "dist/index.cjs.js",
5
5
  "module": "dist/index.esm.js",
6
6
  "type": "module",
package/sdk_schema.yml CHANGED
@@ -1,7 +1,7 @@
1
1
  openapi: 3.0.3
2
2
  info:
3
3
  title: ibl-data-manager
4
- version: 4.109.0-ai-plus
4
+ version: 4.110.0-ai-plus
5
5
  description: API for iblai
6
6
  paths:
7
7
  /api/ai-account/connected-services/callback/:
@@ -34939,7 +34939,9 @@ paths:
34939
34939
  \ and paginated list of content items with individual analytics.\n \
34940
34940
  \ When a platform_key is provided, results are filtered to show only content\
34941
34941
  \ consumed by \n learners associated with that platform.\n \n\
34942
- \ **Metrics supported:**\n - `course` or `courses`: Course analytics\
34942
+ \ **RBAC Requirements:**\n - Requires: Analytics Viewer role\
34943
+ \ (Ibl.Analytics/Core/read) or Tenant Admin role (Ibl.*)\n \n \
34944
+ \ **Metrics supported:**\n - `course` or `courses`: Course analytics\
34943
34945
  \ with time spent\n - `program` or `programs`: Program analytics \n\
34944
34946
  \ - `pathway` or `pathways`: Pathway analytics\n - `skill` or\
34945
34947
  \ `skills`: Skill analytics\n \n **Platform Filtering:**\n \
@@ -35060,6 +35062,14 @@ paths:
35060
35062
  schema:
35061
35063
  type: string
35062
35064
  format: date
35065
+ - in: query
35066
+ name: usergroup_ids
35067
+ schema:
35068
+ type: array
35069
+ items:
35070
+ type: integer
35071
+ nullable: true
35072
+ description: Optional list of usergroup IDs to filter results
35063
35073
  tags:
35064
35074
  - ai-analytics
35065
35075
  - analytics
@@ -35193,6 +35203,14 @@ paths:
35193
35203
  nullable: true
35194
35204
  description: Optional time series metric (enrollments, completions, ratings,
35195
35205
  time_spent)
35206
+ - in: query
35207
+ name: usergroup_ids
35208
+ schema:
35209
+ type: array
35210
+ items:
35211
+ type: integer
35212
+ nullable: true
35213
+ description: Optional list of usergroup IDs to filter results
35196
35214
  tags:
35197
35215
  - ai-analytics
35198
35216
  - analytics
@@ -36349,6 +36367,14 @@ paths:
36349
36367
  schema:
36350
36368
  type: string
36351
36369
  format: date
36370
+ - in: query
36371
+ name: usergroup_ids
36372
+ schema:
36373
+ type: array
36374
+ items:
36375
+ type: integer
36376
+ nullable: true
36377
+ description: Optional list of usergroup IDs to filter results
36352
36378
  tags:
36353
36379
  - ai-analytics
36354
36380
  - analytics
package/src/core/OpenAPI.ts CHANGED
@@ -21,7 +21,7 @@ export type OpenAPIConfig = {
21
21
 
22
22
  export const OpenAPI: OpenAPIConfig = {
23
23
  BASE: 'https://base.manager.iblai.app',
24
- VERSION: '4.109.0-ai-plus',
24
+ VERSION: '4.110.0-ai-plus',
25
25
  WITH_CREDENTIALS: false,
26
26
  CREDENTIALS: 'include',
27
27
  TOKEN: undefined,
package/src/services/AiAnalyticsService.ts CHANGED
@@ -6628,6 +6628,9 @@ export class AiAnalyticsService {
6628
6628
  * When a platform_key is provided, results are filtered to show only content consumed by
6629
6629
  * learners associated with that platform.
6630
6630
  *
6631
+ * **RBAC Requirements:**
6632
+ * - Requires: Analytics Viewer role (Ibl.Analytics/Core/read) or Tenant Admin role (Ibl.*)
6633
+ *
6631
6634
  * **Metrics supported:**
6632
6635
  * - `course` or `courses`: Course analytics with time spent
6633
6636
  * - `program` or `programs`: Program analytics
@@ -6662,6 +6665,7 @@ export class AiAnalyticsService {
6662
6665
  page = 1,
6663
6666
  platformKey,
6664
6667
  startDate,
6668
+ usergroupIds,
6665
6669
  }: {
6666
6670
  /**
6667
6671
  * The type of content to retrieve (course, program, pathway, skill)
@@ -6711,6 +6715,10 @@ export class AiAnalyticsService {
6711
6715
  */
6712
6716
  platformKey?: string | null,
6713
6717
  startDate?: string,
6718
+ /**
6719
+ * Optional list of usergroup IDs to filter results
6720
+ */
6721
+ usergroupIds?: Array<number> | null,
6714
6722
  }): CancelablePromise<ContentResponse> {
6715
6723
  return __request(OpenAPI, {
6716
6724
  method: 'GET',
@@ -6726,6 +6734,7 @@ export class AiAnalyticsService {
6726
6734
  'page': page,
6727
6735
  'platform_key': platformKey,
6728
6736
  'start_date': startDate,
6737
+ 'usergroup_ids': usergroupIds,
6729
6738
  },
6730
6739
  });
6731
6740
  }
@@ -6747,6 +6756,7 @@ export class AiAnalyticsService {
6747
6756
  search,
6748
6757
  startDate,
6749
6758
  timeMetric,
6759
+ usergroupIds,
6750
6760
  }: {
6751
6761
  contentId: string,
6752
6762
  /**
@@ -6785,6 +6795,10 @@ export class AiAnalyticsService {
6785
6795
  * Optional time series metric (enrollments, completions, ratings, time_spent)
6786
6796
  */
6787
6797
  timeMetric?: string | null,
6798
+ /**
6799
+ * Optional list of usergroup IDs to filter results
6800
+ */
6801
+ usergroupIds?: Array<number> | null,
6788
6802
  }): CancelablePromise<ContentDetailsResponse> {
6789
6803
  return __request(OpenAPI, {
6790
6804
  method: 'GET',
@@ -6803,6 +6817,7 @@ export class AiAnalyticsService {
6803
6817
  'search': search,
6804
6818
  'start_date': startDate,
6805
6819
  'time_metric': timeMetric,
6820
+ 'usergroup_ids': usergroupIds,
6806
6821
  },
6807
6822
  });
6808
6823
  }
@@ -7462,6 +7477,7 @@ export class AiAnalyticsService {
7462
7477
  sortBy = 'last_activity',
7463
7478
  sortOrder = 'desc',
7464
7479
  startDate,
7480
+ usergroupIds,
7465
7481
  }: {
7466
7482
  /**
7467
7483
  * Platform key to filter learners by platform
@@ -7517,6 +7533,10 @@ export class AiAnalyticsService {
7517
7533
  */
7518
7534
  sortOrder?: 'asc' | 'desc',
7519
7535
  startDate?: string,
7536
+ /**
7537
+ * Optional list of usergroup IDs to filter results
7538
+ */
7539
+ usergroupIds?: Array<number> | null,
7520
7540
  }): CancelablePromise<LearnerListResponse> {
7521
7541
  return __request(OpenAPI, {
7522
7542
  method: 'GET',
@@ -7533,6 +7553,7 @@ export class AiAnalyticsService {
7533
7553
  'sort_by': sortBy,
7534
7554
  'sort_order': sortOrder,
7535
7555
  'start_date': startDate,
7556
+ 'usergroup_ids': usergroupIds,
7536
7557
  },
7537
7558
  errors: {
7538
7559
  400: `Bad Request - Invalid parameters supplied`,
package/src/services/AnalyticsService.ts CHANGED
@@ -31,6 +31,9 @@ export class AnalyticsService {
31
31
  * When a platform_key is provided, results are filtered to show only content consumed by
32
32
  * learners associated with that platform.
33
33
  *
34
+ * **RBAC Requirements:**
35
+ * - Requires: Analytics Viewer role (Ibl.Analytics/Core/read) or Tenant Admin role (Ibl.*)
36
+ *
34
37
  * **Metrics supported:**
35
38
  * - `course` or `courses`: Course analytics with time spent
36
39
  * - `program` or `programs`: Program analytics
@@ -65,6 +68,7 @@ export class AnalyticsService {
65
68
  page = 1,
66
69
  platformKey,
67
70
  startDate,
71
+ usergroupIds,
68
72
  }: {
69
73
  /**
70
74
  * The type of content to retrieve (course, program, pathway, skill)
@@ -114,6 +118,10 @@ export class AnalyticsService {
114
118
  */
115
119
  platformKey?: string | null,
116
120
  startDate?: string,
121
+ /**
122
+ * Optional list of usergroup IDs to filter results
123
+ */
124
+ usergroupIds?: Array<number> | null,
117
125
  }): CancelablePromise<ContentResponse> {
118
126
  return __request(OpenAPI, {
119
127
  method: 'GET',
@@ -129,6 +137,7 @@ export class AnalyticsService {
129
137
  'page': page,
130
138
  'platform_key': platformKey,
131
139
  'start_date': startDate,
140
+ 'usergroup_ids': usergroupIds,
132
141
  },
133
142
  });
134
143
  }
@@ -150,6 +159,7 @@ export class AnalyticsService {
150
159
  search,
151
160
  startDate,
152
161
  timeMetric,
162
+ usergroupIds,
153
163
  }: {
154
164
  contentId: string,
155
165
  /**
@@ -188,6 +198,10 @@ export class AnalyticsService {
188
198
  * Optional time series metric (enrollments, completions, ratings, time_spent)
189
199
  */
190
200
  timeMetric?: string | null,
201
+ /**
202
+ * Optional list of usergroup IDs to filter results
203
+ */
204
+ usergroupIds?: Array<number> | null,
191
205
  }): CancelablePromise<ContentDetailsResponse> {
192
206
  return __request(OpenAPI, {
193
207
  method: 'GET',
@@ -206,6 +220,7 @@ export class AnalyticsService {
206
220
  'search': search,
207
221
  'start_date': startDate,
208
222
  'time_metric': timeMetric,
223
+ 'usergroup_ids': usergroupIds,
209
224
  },
210
225
  });
211
226
  }
@@ -744,6 +759,7 @@ export class AnalyticsService {
744
759
  sortBy = 'last_activity',
745
760
  sortOrder = 'desc',
746
761
  startDate,
762
+ usergroupIds,
747
763
  }: {
748
764
  /**
749
765
  * Platform key to filter learners by platform
@@ -799,6 +815,10 @@ export class AnalyticsService {
799
815
  */
800
816
  sortOrder?: 'asc' | 'desc',
801
817
  startDate?: string,
818
+ /**
819
+ * Optional list of usergroup IDs to filter results
820
+ */
821
+ usergroupIds?: Array<number> | null,
802
822
  }): CancelablePromise<LearnerListResponse> {
803
823
  return __request(OpenAPI, {
804
824
  method: 'GET',
@@ -815,6 +835,7 @@ export class AnalyticsService {
815
835
  'sort_by': sortBy,
816
836
  'sort_order': sortOrder,
817
837
  'start_date': startDate,
838
+ 'usergroup_ids': usergroupIds,
818
839
  },
819
840
  errors: {
820
841
  400: `Bad Request - Invalid parameters supplied`,