@iblai/iblai-api 4.338.1-core → 4.340.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.
@@ -7,7 +7,6 @@
7
7
  * * `COURSE_LICENSE_ASSIGNMENT` - Course License Assignment
8
8
  * * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
9
9
  * * `COURSE_SCHEDULE_CHANGE` - Course Schedule Change
10
- * * `COURSES_PROGRESS_SUMMARY` - Courses Progress Summary
11
10
  * * `CRM_DEAL_STAGE_CHANGED` - Crm Deal Stage Changed
12
11
  * * `CRM_PERSON_CREATED` - Crm Person Created
13
12
  * * `CRM_PERSON_LINKED_TO_USER` - Crm Person Linked To User
@@ -37,8 +36,9 @@
37
36
  * * `USER_NOTIF_LEARNER_PROGRESS` - User Notif Learner Progress
38
37
  * * `USER_NOTIF_USER_INACTIVITY` - User Notif User Inactivity
39
38
  * * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
39
+ * * `COURSES_PROGRESS_SUMMARY` - User Progress Summary
40
40
  */
41
- export declare enum TypeAf9Enum {
41
+ export declare enum TypeF30Enum {
42
42
  ACTIVITY_COURSE_MILESTONE = "ACTIVITY_COURSE_MILESTONE",
43
43
  ACTIVITY_NEW_CONTENT = "ACTIVITY_NEW_CONTENT",
44
44
  ADMIN_NOTIF_COURSE_ENROLLMENT = "ADMIN_NOTIF_COURSE_ENROLLMENT",
@@ -47,7 +47,6 @@ export declare enum TypeAf9Enum {
47
47
  COURSE_LICENSE_ASSIGNMENT = "COURSE_LICENSE_ASSIGNMENT",
48
48
  COURSE_LICENSE_GROUP_ASSIGNMENT = "COURSE_LICENSE_GROUP_ASSIGNMENT",
49
49
  COURSE_SCHEDULE_CHANGE = "COURSE_SCHEDULE_CHANGE",
50
- COURSES_PROGRESS_SUMMARY = "COURSES_PROGRESS_SUMMARY",
51
50
  CRM_DEAL_STAGE_CHANGED = "CRM_DEAL_STAGE_CHANGED",
52
51
  CRM_PERSON_CREATED = "CRM_PERSON_CREATED",
53
52
  CRM_PERSON_LINKED_TO_USER = "CRM_PERSON_LINKED_TO_USER",
@@ -76,5 +75,6 @@ export declare enum TypeAf9Enum {
76
75
  USER_NOTIF_CREDENTIALS = "USER_NOTIF_CREDENTIALS",
77
76
  USER_NOTIF_LEARNER_PROGRESS = "USER_NOTIF_LEARNER_PROGRESS",
78
77
  USER_NOTIF_USER_INACTIVITY = "USER_NOTIF_USER_INACTIVITY",
79
- USER_NOTIF_USER_REGISTRATION = "USER_NOTIF_USER_REGISTRATION"
78
+ USER_NOTIF_USER_REGISTRATION = "USER_NOTIF_USER_REGISTRATION",
79
+ COURSES_PROGRESS_SUMMARY = "COURSES_PROGRESS_SUMMARY"
80
80
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@iblai/iblai-api",
3
- "version": "4.338.1-core",
3
+ "version": "4.340.0-core",
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.338.1-core
4
+ version: 4.340.0-core
5
5
  description: API for iblai
6
6
  paths:
7
7
  /api/analytics/content/:
@@ -47254,7 +47254,7 @@ components:
47254
47254
  * `PROGRAM_ENROLLMENT_CONFIRMATION` - Program Enrollment Confirmed
47255
47255
  * `PATHWAY_ENROLLMENT_CONFIRMATION` - Pathway Enrollment Confirmed
47256
47256
  * `COURSE_SCHEDULE_CHANGE` - Course Schedule Change
47257
- * `COURSES_PROGRESS_SUMMARY` - Courses Progress Summary
47257
+ * `COURSES_PROGRESS_SUMMARY` - User Progress Summary
47258
47258
  * `SUBSECTION_GRADE_UPDATE` - Subsection Grade Update
47259
47259
  EximTask:
47260
47260
  type: object
@@ -49617,7 +49617,6 @@ components:
49617
49617
  * `COURSE_LICENSE_ASSIGNMENT` - Course License Assignment
49618
49618
  * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
49619
49619
  * `COURSE_SCHEDULE_CHANGE` - Course Schedule Change
49620
- * `COURSES_PROGRESS_SUMMARY` - Courses Progress Summary
49621
49620
  * `CRM_DEAL_STAGE_CHANGED` - Crm Deal Stage Changed
49622
49621
  * `CRM_PERSON_CREATED` - Crm Person Created
49623
49622
  * `CRM_PERSON_LINKED_TO_USER` - Crm Person Linked To User
@@ -49647,8 +49646,9 @@ components:
49647
49646
  * `USER_NOTIF_LEARNER_PROGRESS` - User Notif Learner Progress
49648
49647
  * `USER_NOTIF_USER_INACTIVITY` - User Notif User Inactivity
49649
49648
  * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
49649
+ * `COURSES_PROGRESS_SUMMARY` - User Progress Summary
49650
49650
  oneOf:
49651
- - $ref: '#/components/schemas/TypeAf9Enum'
49651
+ - $ref: '#/components/schemas/TypeF30Enum'
49652
49652
  - $ref: '#/components/schemas/NullEnum'
49653
49653
  name:
49654
49654
  type: string
@@ -49683,6 +49683,17 @@ components:
49683
49683
  type: string
49684
49684
  nullable: true
49685
49685
  description: HTML email body (supports Django template syntax)
49686
+ watcher_email_html_template:
49687
+ type: string
49688
+ nullable: true
49689
+ description: Watcher-variant email HTML template (e.g., 'Your child completed...').
49690
+ Falls back to email_html_template if null.
49691
+ watcher_email_subject:
49692
+ type: string
49693
+ nullable: true
49694
+ description: Watcher-variant email subject. Falls back to email_subject
49695
+ if null.
49696
+ maxLength: 255
49686
49697
  tags:
49687
49698
  description: Free-form tags for categorization (e.g. ['activity', 'learning'])
49688
49699
  spas_detail:
@@ -49731,6 +49742,11 @@ components:
49731
49742
  type: string
49732
49743
  readOnly: true
49733
49744
  description: Context variables available for template rendering
49745
+ watcher_available_context:
49746
+ type: string
49747
+ readOnly: true
49748
+ description: Context variables available in the watcher email variant (null
49749
+ for notification types without a watcher variant)
49734
49750
  proactive_prompt_message:
49735
49751
  type: string
49736
49752
  nullable: true
@@ -49763,7 +49779,7 @@ components:
49763
49779
  description: 'Deprecated: use periodic_lookback_days instead'
49764
49780
  periodic_frequency:
49765
49781
  allOf:
49766
- - $ref: '#/components/schemas/PeriodicFrequencyEnum'
49782
+ - $ref: '#/components/schemas/CoursesProgressFrequencyEnum'
49767
49783
  writeOnly: true
49768
49784
  description: |-
49769
49785
  How often to send: DAILY, WEEKLY, MONTHLY, or CUSTOM
@@ -49911,29 +49927,73 @@ components:
49911
49927
  writeOnly: true
49912
49928
  description: 'Signal types to trigger notifications: ["course_overview.start_date_changed",
49913
49929
  "course_overview.pacing_changed", "course_overview.cert_date_changed"]'
49930
+ user_progress_config:
49931
+ type: object
49932
+ additionalProperties: {}
49933
+ nullable: true
49934
+ readOnly: true
49935
+ description: User progress summary config (COURSES_PROGRESS_SUMMARY only)
49936
+ user_progress_lookback_days:
49937
+ type: integer
49938
+ writeOnly: true
49939
+ description: Lookback window in days for the user progress summary
49940
+ user_progress_enabled_data_points:
49941
+ type: array
49942
+ items:
49943
+ type: string
49944
+ writeOnly: true
49945
+ description: 'Data points to include: courses_progressed, courses_completed,
49946
+ credentials_earned, time_spent, active_days, mentors_accessed (AI agent
49947
+ activity)'
49948
+ user_progress_frequency:
49949
+ allOf:
49950
+ - $ref: '#/components/schemas/CoursesProgressFrequencyEnum'
49951
+ writeOnly: true
49952
+ description: |-
49953
+ How often to send the user progress summary
49954
+
49955
+ * `DAILY` - DAILY
49956
+ * `WEEKLY` - WEEKLY
49957
+ * `MONTHLY` - MONTHLY
49958
+ * `CUSTOM` - CUSTOM
49959
+ user_progress_custom_interval_days:
49960
+ type: integer
49961
+ maximum: 365
49962
+ minimum: 1
49963
+ writeOnly: true
49964
+ description: Custom interval in days (when frequency is CUSTOM)
49965
+ user_progress_execution_time:
49966
+ type: string
49967
+ writeOnly: true
49968
+ description: Time of day to send (HH:MM format)
49969
+ pattern: ^\d{2}:\d{2}$
49970
+ user_progress_timezone:
49971
+ type: string
49972
+ writeOnly: true
49973
+ description: Timezone for execution (e.g. America/New_York)
49914
49974
  courses_progress_config:
49915
49975
  type: object
49916
49976
  additionalProperties: {}
49917
49977
  nullable: true
49918
49978
  readOnly: true
49919
- description: Courses progress config (COURSES_PROGRESS_SUMMARY only)
49979
+ description: Deprecated alias of user_progress_config (COURSES_PROGRESS_SUMMARY
49980
+ only)
49920
49981
  courses_progress_lookback_days:
49921
49982
  type: integer
49922
49983
  writeOnly: true
49923
- description: Lookback period in days for courses progress summary
49984
+ description: Deprecated alias of user_progress_lookback_days
49924
49985
  courses_progress_enabled_data_points:
49925
49986
  type: array
49926
49987
  items:
49927
49988
  type: string
49928
49989
  writeOnly: true
49929
- description: 'Data points to include: courses_progressed, courses_completed,
49930
- credentials_earned, time_spent, active_days, mentors_accessed'
49990
+ description: Deprecated alias of user_progress_enabled_data_points
49931
49991
  courses_progress_frequency:
49932
49992
  allOf:
49933
49993
  - $ref: '#/components/schemas/CoursesProgressFrequencyEnum'
49934
49994
  writeOnly: true
49935
49995
  description: |-
49936
- How often to send courses progress summary
49996
+ Deprecated alias of user_progress_frequency
49937
49997
 
49938
49998
  * `DAILY` - DAILY
49939
49999
  * `WEEKLY` - WEEKLY
@@ -49944,16 +50004,16 @@ components:
49944
50004
  maximum: 365
49945
50005
  minimum: 1
49946
50006
  writeOnly: true
49947
- description: Custom interval in days (when frequency is CUSTOM)
50007
+ description: Deprecated alias of user_progress_custom_interval_days
49948
50008
  courses_progress_execution_time:
49949
50009
  type: string
49950
50010
  writeOnly: true
49951
- description: Time of day to send (HH:MM format)
50011
+ description: Deprecated alias of user_progress_execution_time
49952
50012
  pattern: ^\d{2}:\d{2}$
49953
50013
  courses_progress_timezone:
49954
50014
  type: string
49955
50015
  writeOnly: true
49956
- description: Timezone for execution (e.g. America/New_York)
50016
+ description: Deprecated alias of user_progress_timezone
49957
50017
  grade_posted_config:
49958
50018
  type: object
49959
50019
  additionalProperties: {}
@@ -50006,6 +50066,8 @@ components:
50006
50066
  - spas_detail
50007
50067
  - type
50008
50068
  - updated_at
50069
+ - user_progress_config
50070
+ - watcher_available_context
50009
50071
  NotificationTemplateList:
50010
50072
  type: object
50011
50073
  description: Serializer for listing notification templates with inheritance
@@ -50029,7 +50091,6 @@ components:
50029
50091
  * `COURSE_LICENSE_ASSIGNMENT` - Course License Assignment
50030
50092
  * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
50031
50093
  * `COURSE_SCHEDULE_CHANGE` - Course Schedule Change
50032
- * `COURSES_PROGRESS_SUMMARY` - Courses Progress Summary
50033
50094
  * `CRM_DEAL_STAGE_CHANGED` - Crm Deal Stage Changed
50034
50095
  * `CRM_PERSON_CREATED` - Crm Person Created
50035
50096
  * `CRM_PERSON_LINKED_TO_USER` - Crm Person Linked To User
@@ -50059,8 +50120,9 @@ components:
50059
50120
  * `USER_NOTIF_LEARNER_PROGRESS` - User Notif Learner Progress
50060
50121
  * `USER_NOTIF_USER_INACTIVITY` - User Notif User Inactivity
50061
50122
  * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
50123
+ * `COURSES_PROGRESS_SUMMARY` - User Progress Summary
50062
50124
  oneOf:
50063
- - $ref: '#/components/schemas/TypeAf9Enum'
50125
+ - $ref: '#/components/schemas/TypeF30Enum'
50064
50126
  - $ref: '#/components/schemas/BlankEnum'
50065
50127
  - $ref: '#/components/schemas/NullEnum'
50066
50128
  name:
@@ -52101,7 +52163,6 @@ components:
52101
52163
  * `COURSE_LICENSE_ASSIGNMENT` - Course License Assignment
52102
52164
  * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
52103
52165
  * `COURSE_SCHEDULE_CHANGE` - Course Schedule Change
52104
- * `COURSES_PROGRESS_SUMMARY` - Courses Progress Summary
52105
52166
  * `CRM_DEAL_STAGE_CHANGED` - Crm Deal Stage Changed
52106
52167
  * `CRM_PERSON_CREATED` - Crm Person Created
52107
52168
  * `CRM_PERSON_LINKED_TO_USER` - Crm Person Linked To User
@@ -52131,8 +52192,9 @@ components:
52131
52192
  * `USER_NOTIF_LEARNER_PROGRESS` - User Notif Learner Progress
52132
52193
  * `USER_NOTIF_USER_INACTIVITY` - User Notif User Inactivity
52133
52194
  * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
52195
+ * `COURSES_PROGRESS_SUMMARY` - User Progress Summary
52134
52196
  oneOf:
52135
- - $ref: '#/components/schemas/TypeAf9Enum'
52197
+ - $ref: '#/components/schemas/TypeF30Enum'
52136
52198
  - $ref: '#/components/schemas/NullEnum'
52137
52199
  name:
52138
52200
  type: string
@@ -52167,6 +52229,17 @@ components:
52167
52229
  type: string
52168
52230
  nullable: true
52169
52231
  description: HTML email body (supports Django template syntax)
52232
+ watcher_email_html_template:
52233
+ type: string
52234
+ nullable: true
52235
+ description: Watcher-variant email HTML template (e.g., 'Your child completed...').
52236
+ Falls back to email_html_template if null.
52237
+ watcher_email_subject:
52238
+ type: string
52239
+ nullable: true
52240
+ description: Watcher-variant email subject. Falls back to email_subject
52241
+ if null.
52242
+ maxLength: 255
52170
52243
  tags:
52171
52244
  description: Free-form tags for categorization (e.g. ['activity', 'learning'])
52172
52245
  spas_detail:
@@ -52215,6 +52288,11 @@ components:
52215
52288
  type: string
52216
52289
  readOnly: true
52217
52290
  description: Context variables available for template rendering
52291
+ watcher_available_context:
52292
+ type: string
52293
+ readOnly: true
52294
+ description: Context variables available in the watcher email variant (null
52295
+ for notification types without a watcher variant)
52218
52296
  proactive_prompt_message:
52219
52297
  type: string
52220
52298
  nullable: true
@@ -52247,7 +52325,7 @@ components:
52247
52325
  description: 'Deprecated: use periodic_lookback_days instead'
52248
52326
  periodic_frequency:
52249
52327
  allOf:
52250
- - $ref: '#/components/schemas/PeriodicFrequencyEnum'
52328
+ - $ref: '#/components/schemas/CoursesProgressFrequencyEnum'
52251
52329
  writeOnly: true
52252
52330
  description: |-
52253
52331
  How often to send: DAILY, WEEKLY, MONTHLY, or CUSTOM
@@ -52395,29 +52473,73 @@ components:
52395
52473
  writeOnly: true
52396
52474
  description: 'Signal types to trigger notifications: ["course_overview.start_date_changed",
52397
52475
  "course_overview.pacing_changed", "course_overview.cert_date_changed"]'
52476
+ user_progress_config:
52477
+ type: object
52478
+ additionalProperties: {}
52479
+ nullable: true
52480
+ readOnly: true
52481
+ description: User progress summary config (COURSES_PROGRESS_SUMMARY only)
52482
+ user_progress_lookback_days:
52483
+ type: integer
52484
+ writeOnly: true
52485
+ description: Lookback window in days for the user progress summary
52486
+ user_progress_enabled_data_points:
52487
+ type: array
52488
+ items:
52489
+ type: string
52490
+ writeOnly: true
52491
+ description: 'Data points to include: courses_progressed, courses_completed,
52492
+ credentials_earned, time_spent, active_days, mentors_accessed (AI agent
52493
+ activity)'
52494
+ user_progress_frequency:
52495
+ allOf:
52496
+ - $ref: '#/components/schemas/CoursesProgressFrequencyEnum'
52497
+ writeOnly: true
52498
+ description: |-
52499
+ How often to send the user progress summary
52500
+
52501
+ * `DAILY` - DAILY
52502
+ * `WEEKLY` - WEEKLY
52503
+ * `MONTHLY` - MONTHLY
52504
+ * `CUSTOM` - CUSTOM
52505
+ user_progress_custom_interval_days:
52506
+ type: integer
52507
+ maximum: 365
52508
+ minimum: 1
52509
+ writeOnly: true
52510
+ description: Custom interval in days (when frequency is CUSTOM)
52511
+ user_progress_execution_time:
52512
+ type: string
52513
+ writeOnly: true
52514
+ description: Time of day to send (HH:MM format)
52515
+ pattern: ^\d{2}:\d{2}$
52516
+ user_progress_timezone:
52517
+ type: string
52518
+ writeOnly: true
52519
+ description: Timezone for execution (e.g. America/New_York)
52398
52520
  courses_progress_config:
52399
52521
  type: object
52400
52522
  additionalProperties: {}
52401
52523
  nullable: true
52402
52524
  readOnly: true
52403
- description: Courses progress config (COURSES_PROGRESS_SUMMARY only)
52525
+ description: Deprecated alias of user_progress_config (COURSES_PROGRESS_SUMMARY
52526
+ only)
52404
52527
  courses_progress_lookback_days:
52405
52528
  type: integer
52406
52529
  writeOnly: true
52407
- description: Lookback period in days for courses progress summary
52530
+ description: Deprecated alias of user_progress_lookback_days
52408
52531
  courses_progress_enabled_data_points:
52409
52532
  type: array
52410
52533
  items:
52411
52534
  type: string
52412
52535
  writeOnly: true
52413
- description: 'Data points to include: courses_progressed, courses_completed,
52414
- credentials_earned, time_spent, active_days, mentors_accessed'
52536
+ description: Deprecated alias of user_progress_enabled_data_points
52415
52537
  courses_progress_frequency:
52416
52538
  allOf:
52417
52539
  - $ref: '#/components/schemas/CoursesProgressFrequencyEnum'
52418
52540
  writeOnly: true
52419
52541
  description: |-
52420
- How often to send courses progress summary
52542
+ Deprecated alias of user_progress_frequency
52421
52543
 
52422
52544
  * `DAILY` - DAILY
52423
52545
  * `WEEKLY` - WEEKLY
@@ -52428,16 +52550,16 @@ components:
52428
52550
  maximum: 365
52429
52551
  minimum: 1
52430
52552
  writeOnly: true
52431
- description: Custom interval in days (when frequency is CUSTOM)
52553
+ description: Deprecated alias of user_progress_custom_interval_days
52432
52554
  courses_progress_execution_time:
52433
52555
  type: string
52434
52556
  writeOnly: true
52435
- description: Time of day to send (HH:MM format)
52557
+ description: Deprecated alias of user_progress_execution_time
52436
52558
  pattern: ^\d{2}:\d{2}$
52437
52559
  courses_progress_timezone:
52438
52560
  type: string
52439
52561
  writeOnly: true
52440
- description: Timezone for execution (e.g. America/New_York)
52562
+ description: Deprecated alias of user_progress_timezone
52441
52563
  grade_posted_config:
52442
52564
  type: object
52443
52565
  additionalProperties: {}
@@ -53905,18 +54027,6 @@ components:
53905
54027
  * `weekly` - weekly
53906
54028
  * `monthly` - monthly
53907
54029
  * `yearly` - yearly
53908
- PeriodicFrequencyEnum:
53909
- enum:
53910
- - DAILY
53911
- - WEEKLY
53912
- - MONTHLY
53913
- - CUSTOM
53914
- type: string
53915
- description: |-
53916
- * `DAILY` - DAILY
53917
- * `WEEKLY` - WEEKLY
53918
- * `MONTHLY` - MONTHLY
53919
- * `CUSTOM` - CUSTOM
53920
54030
  PeriodicLearnerScopeEnum:
53921
54031
  enum:
53922
54032
  - ACTIVE_LEARNERS
@@ -61724,7 +61834,7 @@ components:
61724
61834
  * `release` - Release Reserved Credits
61725
61835
  * `rollover` - Rollover Credits
61726
61836
  * `refund` - Refund Credits
61727
- TypeAf9Enum:
61837
+ TypeF30Enum:
61728
61838
  enum:
61729
61839
  - ACTIVITY_COURSE_MILESTONE
61730
61840
  - ACTIVITY_NEW_CONTENT
@@ -61734,7 +61844,6 @@ components:
61734
61844
  - COURSE_LICENSE_ASSIGNMENT
61735
61845
  - COURSE_LICENSE_GROUP_ASSIGNMENT
61736
61846
  - COURSE_SCHEDULE_CHANGE
61737
- - COURSES_PROGRESS_SUMMARY
61738
61847
  - CRM_DEAL_STAGE_CHANGED
61739
61848
  - CRM_PERSON_CREATED
61740
61849
  - CRM_PERSON_LINKED_TO_USER
@@ -61764,6 +61873,7 @@ components:
61764
61873
  - USER_NOTIF_LEARNER_PROGRESS
61765
61874
  - USER_NOTIF_USER_INACTIVITY
61766
61875
  - USER_NOTIF_USER_REGISTRATION
61876
+ - COURSES_PROGRESS_SUMMARY
61767
61877
  type: string
61768
61878
  description: |-
61769
61879
  * `ACTIVITY_COURSE_MILESTONE` - Activity Course Milestone
@@ -61774,7 +61884,6 @@ components:
61774
61884
  * `COURSE_LICENSE_ASSIGNMENT` - Course License Assignment
61775
61885
  * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
61776
61886
  * `COURSE_SCHEDULE_CHANGE` - Course Schedule Change
61777
- * `COURSES_PROGRESS_SUMMARY` - Courses Progress Summary
61778
61887
  * `CRM_DEAL_STAGE_CHANGED` - Crm Deal Stage Changed
61779
61888
  * `CRM_PERSON_CREATED` - Crm Person Created
61780
61889
  * `CRM_PERSON_LINKED_TO_USER` - Crm Person Linked To User
@@ -61804,6 +61913,7 @@ components:
61804
61913
  * `USER_NOTIF_LEARNER_PROGRESS` - User Notif Learner Progress
61805
61914
  * `USER_NOTIF_USER_INACTIVITY` - User Notif User Inactivity
61806
61915
  * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
61916
+ * `COURSES_PROGRESS_SUMMARY` - User Progress Summary
61807
61917
  UploadedImage:
61808
61918
  type: object
61809
61919
  properties:
@@ -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.338.1-core',
24
+ VERSION: '4.340.0-core',
25
25
  WITH_CREDENTIALS: false,
26
26
  CREDENTIALS: 'include',
27
27
  TOKEN: undefined,
package/src/index.ts CHANGED
@@ -355,7 +355,6 @@ export type { PathwaySuggestionDetail } from './models/PathwaySuggestionDetail';
355
355
  export type { PerformanceGradesPerCourse } from './models/PerformanceGradesPerCourse';
356
356
  export type { PerformanceGradesPerCourseData } from './models/PerformanceGradesPerCourseData';
357
357
  export { PeriodEnum } from './models/PeriodEnum';
358
- export { PeriodicFrequencyEnum } from './models/PeriodicFrequencyEnum';
359
358
  export { PeriodicLearnerScopeEnum } from './models/PeriodicLearnerScopeEnum';
360
359
  export type { PerLearnerCourseLastAccessData } from './models/PerLearnerCourseLastAccessData';
361
360
  export type { PerlearnerCourseProgress } from './models/PerlearnerCourseProgress';
@@ -588,7 +587,7 @@ export type { TokenProxyOutputSerializerData } from './models/TokenProxyOutputSe
588
587
  export type { TokenProxyUser } from './models/TokenProxyUser';
589
588
  export type { TopContent } from './models/TopContent';
590
589
  export { TransactionTypeEnum } from './models/TransactionTypeEnum';
591
- export { TypeAf9Enum } from './models/TypeAf9Enum';
590
+ export { TypeF30Enum } from './models/TypeF30Enum';
592
591
  export type { UploadedImage } from './models/UploadedImage';
593
592
  export type { UserApp } from './models/UserApp';
594
593
  export type { UserDefaultPlatformGetResponse } from './models/UserDefaultPlatformGetResponse';
@@ -16,7 +16,7 @@
16
16
  * * `PROGRAM_ENROLLMENT_CONFIRMATION` - Program Enrollment Confirmed
17
17
  * * `PATHWAY_ENROLLMENT_CONFIRMATION` - Pathway Enrollment Confirmed
18
18
  * * `COURSE_SCHEDULE_CHANGE` - Course Schedule Change
19
- * * `COURSES_PROGRESS_SUMMARY` - Courses Progress Summary
19
+ * * `COURSES_PROGRESS_SUMMARY` - User Progress Summary
20
20
  * * `SUBSECTION_GRADE_UPDATE` - Subsection Grade Update
21
21
  */
22
22
  export enum EventsEnum {
@@ -7,11 +7,10 @@ import type { CoursesProgressFrequencyEnum } from './CoursesProgressFrequencyEnu
7
7
  import type { GradePostedNotifyModeEnum } from './GradePostedNotifyModeEnum';
8
8
  import type { HumanSupportRecipientModeEnum } from './HumanSupportRecipientModeEnum';
9
9
  import type { NullEnum } from './NullEnum';
10
- import type { PeriodicFrequencyEnum } from './PeriodicFrequencyEnum';
11
10
  import type { PeriodicLearnerScopeEnum } from './PeriodicLearnerScopeEnum';
12
11
  import type { RecipientsRecipientModeEnum } from './RecipientsRecipientModeEnum';
13
12
  import type { Spa } from './Spa';
14
- import type { TypeAf9Enum } from './TypeAf9Enum';
13
+ import type { TypeF30Enum } from './TypeF30Enum';
15
14
  /**
16
15
  * Serializer for detailed template view and editing
17
16
  */
@@ -31,7 +30,6 @@ export type NotificationTemplateDetail = {
31
30
  * * `COURSE_LICENSE_ASSIGNMENT` - Course License Assignment
32
31
  * * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
33
32
  * * `COURSE_SCHEDULE_CHANGE` - Course Schedule Change
34
- * * `COURSES_PROGRESS_SUMMARY` - Courses Progress Summary
35
33
  * * `CRM_DEAL_STAGE_CHANGED` - Crm Deal Stage Changed
36
34
  * * `CRM_PERSON_CREATED` - Crm Person Created
37
35
  * * `CRM_PERSON_LINKED_TO_USER` - Crm Person Linked To User
@@ -61,8 +59,9 @@ export type NotificationTemplateDetail = {
61
59
  * * `USER_NOTIF_LEARNER_PROGRESS` - User Notif Learner Progress
62
60
  * * `USER_NOTIF_USER_INACTIVITY` - User Notif User Inactivity
63
61
  * * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
62
+ * * `COURSES_PROGRESS_SUMMARY` - User Progress Summary
64
63
  */
65
- readonly type: (TypeAf9Enum | NullEnum) | null;
64
+ readonly type: (TypeF30Enum | NullEnum) | null;
66
65
  /**
67
66
  * Template display name
68
67
  */
@@ -95,6 +94,14 @@ export type NotificationTemplateDetail = {
95
94
  * HTML email body (supports Django template syntax)
96
95
  */
97
96
  email_html_template?: string | null;
97
+ /**
98
+ * Watcher-variant email HTML template (e.g., 'Your child completed...'). Falls back to email_html_template if null.
99
+ */
100
+ watcher_email_html_template?: string | null;
101
+ /**
102
+ * Watcher-variant email subject. Falls back to email_subject if null.
103
+ */
104
+ watcher_email_subject?: string | null;
98
105
  /**
99
106
  * Free-form tags for categorization (e.g. ['activity', 'learning'])
100
107
  */
@@ -133,6 +140,10 @@ export type NotificationTemplateDetail = {
133
140
  * Context variables available for template rendering
134
141
  */
135
142
  readonly available_context: string;
143
+ /**
144
+ * Context variables available in the watcher email variant (null for notification types without a watcher variant)
145
+ */
146
+ readonly watcher_available_context: string;
136
147
  /**
137
148
  * Default prompt message for AI agent notifications
138
149
  */
@@ -164,7 +175,7 @@ export type NotificationTemplateDetail = {
164
175
  * * `MONTHLY` - MONTHLY
165
176
  * * `CUSTOM` - CUSTOM
166
177
  */
167
- periodic_frequency?: PeriodicFrequencyEnum;
178
+ periodic_frequency?: CoursesProgressFrequencyEnum;
168
179
  /**
169
180
  * Custom interval in days (when frequency is CUSTOM)
170
181
  */
@@ -265,19 +276,52 @@ export type NotificationTemplateDetail = {
265
276
  */
266
277
  schedule_change_enabled_signals?: Array<string>;
267
278
  /**
268
- * Courses progress config (COURSES_PROGRESS_SUMMARY only)
279
+ * User progress summary config (COURSES_PROGRESS_SUMMARY only)
280
+ */
281
+ readonly user_progress_config: Record<string, any> | null;
282
+ /**
283
+ * Lookback window in days for the user progress summary
284
+ */
285
+ user_progress_lookback_days?: number;
286
+ /**
287
+ * Data points to include: courses_progressed, courses_completed, credentials_earned, time_spent, active_days, mentors_accessed (AI agent activity)
288
+ */
289
+ user_progress_enabled_data_points?: Array<string>;
290
+ /**
291
+ * How often to send the user progress summary
292
+ *
293
+ * * `DAILY` - DAILY
294
+ * * `WEEKLY` - WEEKLY
295
+ * * `MONTHLY` - MONTHLY
296
+ * * `CUSTOM` - CUSTOM
297
+ */
298
+ user_progress_frequency?: CoursesProgressFrequencyEnum;
299
+ /**
300
+ * Custom interval in days (when frequency is CUSTOM)
301
+ */
302
+ user_progress_custom_interval_days?: number;
303
+ /**
304
+ * Time of day to send (HH:MM format)
305
+ */
306
+ user_progress_execution_time?: string;
307
+ /**
308
+ * Timezone for execution (e.g. America/New_York)
309
+ */
310
+ user_progress_timezone?: string;
311
+ /**
312
+ * Deprecated alias of user_progress_config (COURSES_PROGRESS_SUMMARY only)
269
313
  */
270
314
  readonly courses_progress_config: Record<string, any> | null;
271
315
  /**
272
- * Lookback period in days for courses progress summary
316
+ * Deprecated alias of user_progress_lookback_days
273
317
  */
274
318
  courses_progress_lookback_days?: number;
275
319
  /**
276
- * Data points to include: courses_progressed, courses_completed, credentials_earned, time_spent, active_days, mentors_accessed
320
+ * Deprecated alias of user_progress_enabled_data_points
277
321
  */
278
322
  courses_progress_enabled_data_points?: Array<string>;
279
323
  /**
280
- * How often to send courses progress summary
324
+ * Deprecated alias of user_progress_frequency
281
325
  *
282
326
  * * `DAILY` - DAILY
283
327
  * * `WEEKLY` - WEEKLY
@@ -286,15 +330,15 @@ export type NotificationTemplateDetail = {
286
330
  */
287
331
  courses_progress_frequency?: CoursesProgressFrequencyEnum;
288
332
  /**
289
- * Custom interval in days (when frequency is CUSTOM)
333
+ * Deprecated alias of user_progress_custom_interval_days
290
334
  */
291
335
  courses_progress_custom_interval_days?: number;
292
336
  /**
293
- * Time of day to send (HH:MM format)
337
+ * Deprecated alias of user_progress_execution_time
294
338
  */
295
339
  courses_progress_execution_time?: string;
296
340
  /**
297
- * Timezone for execution (e.g. America/New_York)
341
+ * Deprecated alias of user_progress_timezone
298
342
  */
299
343
  courses_progress_timezone?: string;
300
344
  /**
@@ -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 { TypeAf9Enum } from './TypeAf9Enum';
7
+ import type { TypeF30Enum } from './TypeF30Enum';
8
8
  /**
9
9
  * Serializer for listing notification templates with inheritance info
10
10
  */
@@ -24,7 +24,6 @@ export type NotificationTemplateList = {
24
24
  * * `COURSE_LICENSE_ASSIGNMENT` - Course License Assignment
25
25
  * * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
26
26
  * * `COURSE_SCHEDULE_CHANGE` - Course Schedule Change
27
- * * `COURSES_PROGRESS_SUMMARY` - Courses Progress Summary
28
27
  * * `CRM_DEAL_STAGE_CHANGED` - Crm Deal Stage Changed
29
28
  * * `CRM_PERSON_CREATED` - Crm Person Created
30
29
  * * `CRM_PERSON_LINKED_TO_USER` - Crm Person Linked To User
@@ -54,8 +53,9 @@ export type NotificationTemplateList = {
54
53
  * * `USER_NOTIF_LEARNER_PROGRESS` - User Notif Learner Progress
55
54
  * * `USER_NOTIF_USER_INACTIVITY` - User Notif User Inactivity
56
55
  * * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
56
+ * * `COURSES_PROGRESS_SUMMARY` - User Progress Summary
57
57
  */
58
- type?: (TypeAf9Enum | BlankEnum | NullEnum) | null;
58
+ type?: (TypeF30Enum | BlankEnum | NullEnum) | null;
59
59
  /**
60
60
  * A friendly name for the notification template.
61
61
  */