@iblai/iblai-api 4.391.0-ai → 4.392.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.
package/dist/index.cjs.js CHANGED
@@ -110,7 +110,7 @@ class CancelablePromise {
110
110
 
111
111
  const OpenAPI = {
112
112
  BASE: 'https://base.manager.iblai.app',
113
- VERSION: '4.391.0-ai-plus',
113
+ VERSION: '4.392.0-ai-plus',
114
114
  WITH_CREDENTIALS: false,
115
115
  CREDENTIALS: 'include',
116
116
  TOKEN: undefined,
@@ -10100,7 +10100,7 @@ class AiAnalyticsService {
10100
10100
  page = 1,
10101
10101
  platformKey,
10102
10102
  search,
10103
- sortBy = 'name',
10103
+ sortBy = 'enrollments',
10104
10104
  startDate,
10105
10105
  usergroupIds
10106
10106
  }) {
@@ -25866,7 +25866,7 @@ class AnalyticsService {
25866
25866
  page = 1,
25867
25867
  platformKey,
25868
25868
  search,
25869
- sortBy = 'name',
25869
+ sortBy = 'enrollments',
25870
25870
  startDate,
25871
25871
  usergroupIds
25872
25872
  }) {
package/dist/index.esm.js CHANGED
@@ -108,7 +108,7 @@ class CancelablePromise {
108
108
 
109
109
  const OpenAPI = {
110
110
  BASE: 'https://base.manager.iblai.app',
111
- VERSION: '4.391.0-ai-plus',
111
+ VERSION: '4.392.0-ai-plus',
112
112
  WITH_CREDENTIALS: false,
113
113
  CREDENTIALS: 'include',
114
114
  TOKEN: undefined,
@@ -10098,7 +10098,7 @@ class AiAnalyticsService {
10098
10098
  page = 1,
10099
10099
  platformKey,
10100
10100
  search,
10101
- sortBy = 'name',
10101
+ sortBy = 'enrollments',
10102
10102
  startDate,
10103
10103
  usergroupIds
10104
10104
  }) {
@@ -25864,7 +25864,7 @@ class AnalyticsService {
25864
25864
  page = 1,
25865
25865
  platformKey,
25866
25866
  search,
25867
- sortBy = 'name',
25867
+ sortBy = 'enrollments',
25868
25868
  startDate,
25869
25869
  usergroupIds
25870
25870
  }) {
package/dist/index.umd.js CHANGED
@@ -114,7 +114,7 @@
114
114
 
115
115
  const OpenAPI = {
116
116
  BASE: 'https://base.manager.iblai.app',
117
- VERSION: '4.391.0-ai-plus',
117
+ VERSION: '4.392.0-ai-plus',
118
118
  WITH_CREDENTIALS: false,
119
119
  CREDENTIALS: 'include',
120
120
  TOKEN: undefined,
@@ -10104,7 +10104,7 @@
10104
10104
  page = 1,
10105
10105
  platformKey,
10106
10106
  search,
10107
- sortBy = 'name',
10107
+ sortBy = 'enrollments',
10108
10108
  startDate,
10109
10109
  usergroupIds
10110
10110
  }) {
@@ -25870,7 +25870,7 @@
25870
25870
  page = 1,
25871
25871
  platformKey,
25872
25872
  search,
25873
- sortBy = 'name',
25873
+ sortBy = 'enrollments',
25874
25874
  startDate,
25875
25875
  usergroupIds
25876
25876
  }) {
@@ -4,9 +4,17 @@ import type { ContentAnalytics } from './ContentAnalytics';
4
4
  */
5
5
  export type ContentItem = {
6
6
  /**
7
- * Content identifier
7
+ * Content identifier. Deprecated for programs: use program_id / program_key instead.
8
8
  */
9
9
  id: string;
10
+ /**
11
+ * Program code (metric=program only), e.g. '2025'
12
+ */
13
+ program_id?: string;
14
+ /**
15
+ * Program key 'program-v1:<org>+<program_id>' (metric=program only)
16
+ */
17
+ program_key?: string;
10
18
  /**
11
19
  * Content name
12
20
  */
@@ -4374,12 +4374,13 @@ export declare class AiAnalyticsService {
4374
4374
  */
4375
4375
  search?: string;
4376
4376
  /**
4377
- * Sort order for results. 'active_enrollments' is only supported for course, program, and pathway metrics; it is ignored for skill.
4377
+ * Sort order for results. Enrollment counts use the same learner scope as each item's analytics; ties are ordered by name. 'enrollments' and 'active_enrollments' apply to course, program and pathway metrics; skills are always ordered by name.
4378
4378
  *
4379
- * * `name` - Name (default)
4379
+ * * `enrollments` - Total enrollments (descending, default)
4380
4380
  * * `active_enrollments` - Active enrollments (descending)
4381
+ * * `name` - Name (A-Z)
4381
4382
  */
4382
- sortBy?: 'name' | 'active_enrollments';
4383
+ sortBy?: 'enrollments' | 'active_enrollments' | 'name';
4383
4384
  startDate?: string;
4384
4385
  /**
4385
4386
  * Optional list of usergroup IDs to filter results
@@ -104,12 +104,13 @@ export declare class AnalyticsService {
104
104
  */
105
105
  search?: string;
106
106
  /**
107
- * Sort order for results. 'active_enrollments' is only supported for course, program, and pathway metrics; it is ignored for skill.
107
+ * Sort order for results. Enrollment counts use the same learner scope as each item's analytics; ties are ordered by name. 'enrollments' and 'active_enrollments' apply to course, program and pathway metrics; skills are always ordered by name.
108
108
  *
109
- * * `name` - Name (default)
109
+ * * `enrollments` - Total enrollments (descending, default)
110
110
  * * `active_enrollments` - Active enrollments (descending)
111
+ * * `name` - Name (A-Z)
111
112
  */
112
- sortBy?: 'name' | 'active_enrollments';
113
+ sortBy?: 'enrollments' | 'active_enrollments' | 'name';
113
114
  startDate?: string;
114
115
  /**
115
116
  * Optional list of usergroup IDs to filter results
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@iblai/iblai-api",
3
- "version": "4.391.0-ai",
3
+ "version": "4.392.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.391.0-ai-plus
4
+ version: 4.392.0-ai-plus
5
5
  description: API for iblai
6
6
  paths:
7
7
  /api/ai-account/connected-services/callback/:
@@ -53009,16 +53009,18 @@ paths:
53009
53009
  name: sort_by
53010
53010
  schema:
53011
53011
  enum:
53012
- - name
53012
+ - enrollments
53013
53013
  - active_enrollments
53014
+ - name
53014
53015
  type: string
53015
- default: name
53016
+ default: enrollments
53016
53017
  minLength: 1
53017
53018
  description: |-
53018
- Sort order for results. 'active_enrollments' is only supported for course, program, and pathway metrics; it is ignored for skill.
53019
+ Sort order for results. Enrollment counts use the same learner scope as each item's analytics; ties are ordered by name. 'enrollments' and 'active_enrollments' apply to course, program and pathway metrics; skills are always ordered by name.
53019
53020
 
53020
- * `name` - Name (default)
53021
+ * `enrollments` - Total enrollments (descending, default)
53021
53022
  * `active_enrollments` - Active enrollments (descending)
53023
+ * `name` - Name (A-Z)
53022
53024
  - in: query
53023
53025
  name: start_date
53024
53026
  schema:
@@ -103482,7 +103484,15 @@ components:
103482
103484
  properties:
103483
103485
  id:
103484
103486
  type: string
103485
- description: Content identifier
103487
+ description: 'Content identifier. Deprecated for programs: use program_id
103488
+ / program_key instead.'
103489
+ program_id:
103490
+ type: string
103491
+ description: Program code (metric=program only), e.g. '2025'
103492
+ program_key:
103493
+ type: string
103494
+ description: Program key 'program-v1:<org>+<program_id>' (metric=program
103495
+ only)
103486
103496
  name:
103487
103497
  type: string
103488
103498
  description: Content name
@@ -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.391.0-ai-plus',
24
+ VERSION: '4.392.0-ai-plus',
25
25
  WITH_CREDENTIALS: false,
26
26
  CREDENTIALS: 'include',
27
27
  TOKEN: undefined,
@@ -8,9 +8,17 @@ import type { ContentAnalytics } from './ContentAnalytics';
8
8
  */
9
9
  export type ContentItem = {
10
10
  /**
11
- * Content identifier
11
+ * Content identifier. Deprecated for programs: use program_id / program_key instead.
12
12
  */
13
13
  id: string;
14
+ /**
15
+ * Program code (metric=program only), e.g. '2025'
16
+ */
17
+ program_id?: string;
18
+ /**
19
+ * Program key 'program-v1:<org>+<program_id>' (metric=program only)
20
+ */
21
+ program_key?: string;
14
22
  /**
15
23
  * Content name
16
24
  */
@@ -7220,7 +7220,7 @@ export class AiAnalyticsService {
7220
7220
  page = 1,
7221
7221
  platformKey,
7222
7222
  search,
7223
- sortBy = 'name',
7223
+ sortBy = 'enrollments',
7224
7224
  startDate,
7225
7225
  usergroupIds,
7226
7226
  }: {
@@ -7276,12 +7276,13 @@ export class AiAnalyticsService {
7276
7276
  */
7277
7277
  search?: string,
7278
7278
  /**
7279
- * Sort order for results. 'active_enrollments' is only supported for course, program, and pathway metrics; it is ignored for skill.
7279
+ * Sort order for results. Enrollment counts use the same learner scope as each item's analytics; ties are ordered by name. 'enrollments' and 'active_enrollments' apply to course, program and pathway metrics; skills are always ordered by name.
7280
7280
  *
7281
- * * `name` - Name (default)
7281
+ * * `enrollments` - Total enrollments (descending, default)
7282
7282
  * * `active_enrollments` - Active enrollments (descending)
7283
+ * * `name` - Name (A-Z)
7283
7284
  */
7284
- sortBy?: 'name' | 'active_enrollments',
7285
+ sortBy?: 'enrollments' | 'active_enrollments' | 'name',
7285
7286
  startDate?: string,
7286
7287
  /**
7287
7288
  * Optional list of usergroup IDs to filter results
@@ -68,7 +68,7 @@ export class AnalyticsService {
68
68
  page = 1,
69
69
  platformKey,
70
70
  search,
71
- sortBy = 'name',
71
+ sortBy = 'enrollments',
72
72
  startDate,
73
73
  usergroupIds,
74
74
  }: {
@@ -124,12 +124,13 @@ export class AnalyticsService {
124
124
  */
125
125
  search?: string,
126
126
  /**
127
- * Sort order for results. 'active_enrollments' is only supported for course, program, and pathway metrics; it is ignored for skill.
127
+ * Sort order for results. Enrollment counts use the same learner scope as each item's analytics; ties are ordered by name. 'enrollments' and 'active_enrollments' apply to course, program and pathway metrics; skills are always ordered by name.
128
128
  *
129
- * * `name` - Name (default)
129
+ * * `enrollments` - Total enrollments (descending, default)
130
130
  * * `active_enrollments` - Active enrollments (descending)
131
+ * * `name` - Name (A-Z)
131
132
  */
132
- sortBy?: 'name' | 'active_enrollments',
133
+ sortBy?: 'enrollments' | 'active_enrollments' | 'name',
133
134
  startDate?: string,
134
135
  /**
135
136
  * Optional list of usergroup IDs to filter results