@eduware/oneroster 1.2.4 → 1.2.6

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 (224) hide show
  1. package/FUNCTIONS.md +232 -0
  2. package/README.md +493 -334
  3. package/bin/mcp-server.js +338 -1328
  4. package/bin/mcp-server.js.map +22 -21
  5. package/dist/commonjs/enums/index.d.ts +2 -0
  6. package/dist/commonjs/enums/index.d.ts.map +1 -0
  7. package/dist/commonjs/enums/index.js +18 -0
  8. package/dist/commonjs/enums/index.js.map +1 -0
  9. package/dist/commonjs/index.d.ts +4 -0
  10. package/dist/commonjs/index.d.ts.map +1 -1
  11. package/dist/commonjs/index.js +41 -1
  12. package/dist/commonjs/index.js.map +1 -1
  13. package/dist/commonjs/models/errors/index.d.ts +1 -0
  14. package/dist/commonjs/models/errors/index.d.ts.map +1 -1
  15. package/dist/commonjs/models/errors/index.js +1 -0
  16. package/dist/commonjs/models/errors/index.js.map +1 -1
  17. package/dist/commonjs/models/index.d.ts +2 -0
  18. package/dist/commonjs/models/index.d.ts.map +1 -0
  19. package/dist/commonjs/models/index.js +18 -0
  20. package/dist/commonjs/models/index.js.map +1 -0
  21. package/dist/commonjs/models/operations/createuser.d.ts +8 -270
  22. package/dist/commonjs/models/operations/createuser.d.ts.map +1 -1
  23. package/dist/commonjs/models/operations/createuser.js +17 -178
  24. package/dist/commonjs/models/operations/createuser.js.map +1 -1
  25. package/dist/commonjs/models/operations/getallstudents.d.ts +6 -206
  26. package/dist/commonjs/models/operations/getallstudents.d.ts.map +1 -1
  27. package/dist/commonjs/models/operations/getallstudents.js +12 -132
  28. package/dist/commonjs/models/operations/getallstudents.js.map +1 -1
  29. package/dist/commonjs/models/operations/getallteachers.d.ts +6 -206
  30. package/dist/commonjs/models/operations/getallteachers.d.ts.map +1 -1
  31. package/dist/commonjs/models/operations/getallteachers.js +12 -132
  32. package/dist/commonjs/models/operations/getallteachers.js.map +1 -1
  33. package/dist/commonjs/models/operations/getallusers.d.ts +6 -206
  34. package/dist/commonjs/models/operations/getallusers.d.ts.map +1 -1
  35. package/dist/commonjs/models/operations/getallusers.js +12 -132
  36. package/dist/commonjs/models/operations/getallusers.js.map +1 -1
  37. package/dist/commonjs/models/operations/getclassesforuser.d.ts +4 -85
  38. package/dist/commonjs/models/operations/getclassesforuser.d.ts.map +1 -1
  39. package/dist/commonjs/models/operations/getclassesforuser.js +8 -67
  40. package/dist/commonjs/models/operations/getclassesforuser.js.map +1 -1
  41. package/dist/commonjs/models/operations/getresourcesforuser.d.ts +5 -111
  42. package/dist/commonjs/models/operations/getresourcesforuser.d.ts.map +1 -1
  43. package/dist/commonjs/models/operations/getresourcesforuser.js +10 -88
  44. package/dist/commonjs/models/operations/getresourcesforuser.js.map +1 -1
  45. package/dist/commonjs/models/operations/getstudent.d.ts +5 -174
  46. package/dist/commonjs/models/operations/getstudent.d.ts.map +1 -1
  47. package/dist/commonjs/models/operations/getstudent.js +10 -108
  48. package/dist/commonjs/models/operations/getstudent.js.map +1 -1
  49. package/dist/commonjs/models/operations/getstudentsforclass.d.ts +6 -206
  50. package/dist/commonjs/models/operations/getstudentsforclass.d.ts.map +1 -1
  51. package/dist/commonjs/models/operations/getstudentsforclass.js +12 -132
  52. package/dist/commonjs/models/operations/getstudentsforclass.js.map +1 -1
  53. package/dist/commonjs/models/operations/getstudentsforclassinschool.d.ts +6 -206
  54. package/dist/commonjs/models/operations/getstudentsforclassinschool.d.ts.map +1 -1
  55. package/dist/commonjs/models/operations/getstudentsforclassinschool.js +12 -132
  56. package/dist/commonjs/models/operations/getstudentsforclassinschool.js.map +1 -1
  57. package/dist/commonjs/models/operations/getstudentsforschool.d.ts +6 -206
  58. package/dist/commonjs/models/operations/getstudentsforschool.d.ts.map +1 -1
  59. package/dist/commonjs/models/operations/getstudentsforschool.js +12 -132
  60. package/dist/commonjs/models/operations/getstudentsforschool.js.map +1 -1
  61. package/dist/commonjs/models/operations/getteacher.d.ts +5 -174
  62. package/dist/commonjs/models/operations/getteacher.d.ts.map +1 -1
  63. package/dist/commonjs/models/operations/getteacher.js +10 -108
  64. package/dist/commonjs/models/operations/getteacher.js.map +1 -1
  65. package/dist/commonjs/models/operations/getteachersforclass.d.ts +6 -206
  66. package/dist/commonjs/models/operations/getteachersforclass.d.ts.map +1 -1
  67. package/dist/commonjs/models/operations/getteachersforclass.js +12 -132
  68. package/dist/commonjs/models/operations/getteachersforclass.js.map +1 -1
  69. package/dist/commonjs/models/operations/getteachersforclassinschool.d.ts +6 -206
  70. package/dist/commonjs/models/operations/getteachersforclassinschool.d.ts.map +1 -1
  71. package/dist/commonjs/models/operations/getteachersforclassinschool.js +12 -132
  72. package/dist/commonjs/models/operations/getteachersforclassinschool.js.map +1 -1
  73. package/dist/commonjs/models/operations/getteachersforschool.d.ts +6 -206
  74. package/dist/commonjs/models/operations/getteachersforschool.d.ts.map +1 -1
  75. package/dist/commonjs/models/operations/getteachersforschool.js +12 -132
  76. package/dist/commonjs/models/operations/getteachersforschool.js.map +1 -1
  77. package/dist/commonjs/models/operations/getuser.d.ts +5 -174
  78. package/dist/commonjs/models/operations/getuser.d.ts.map +1 -1
  79. package/dist/commonjs/models/operations/getuser.js +10 -108
  80. package/dist/commonjs/models/operations/getuser.js.map +1 -1
  81. package/dist/commonjs/models/operations/getuserwithdemographics.d.ts +5 -174
  82. package/dist/commonjs/models/operations/getuserwithdemographics.d.ts.map +1 -1
  83. package/dist/commonjs/models/operations/getuserwithdemographics.js +10 -108
  84. package/dist/commonjs/models/operations/getuserwithdemographics.js.map +1 -1
  85. package/dist/commonjs/models/operations/updateuser.d.ts +8 -270
  86. package/dist/commonjs/models/operations/updateuser.d.ts.map +1 -1
  87. package/dist/commonjs/models/operations/updateuser.js +17 -178
  88. package/dist/commonjs/models/operations/updateuser.js.map +1 -1
  89. package/dist/commonjs/models/shared/enums.d.ts +440 -0
  90. package/dist/commonjs/models/shared/enums.d.ts.map +1 -0
  91. package/dist/commonjs/models/shared/enums.js +499 -0
  92. package/dist/commonjs/models/shared/enums.js.map +1 -0
  93. package/dist/commonjs/models/shared/index.d.ts +8 -0
  94. package/dist/commonjs/models/shared/index.d.ts.map +1 -0
  95. package/dist/commonjs/models/shared/index.js +24 -0
  96. package/dist/commonjs/models/shared/index.js.map +1 -0
  97. package/dist/commonjs/types/index.d.ts +1 -0
  98. package/dist/commonjs/types/index.d.ts.map +1 -1
  99. package/dist/commonjs/types/index.js +16 -0
  100. package/dist/commonjs/types/index.js.map +1 -1
  101. package/dist/esm/enums/index.d.ts +2 -0
  102. package/dist/esm/enums/index.d.ts.map +1 -0
  103. package/dist/esm/enums/index.js +2 -0
  104. package/dist/esm/enums/index.js.map +1 -0
  105. package/dist/esm/index.d.ts +4 -0
  106. package/dist/esm/index.d.ts.map +1 -1
  107. package/dist/esm/index.js +14 -0
  108. package/dist/esm/index.js.map +1 -1
  109. package/dist/esm/models/errors/index.d.ts +1 -0
  110. package/dist/esm/models/errors/index.d.ts.map +1 -1
  111. package/dist/esm/models/errors/index.js +1 -0
  112. package/dist/esm/models/errors/index.js.map +1 -1
  113. package/dist/esm/models/index.d.ts +2 -0
  114. package/dist/esm/models/index.d.ts.map +1 -0
  115. package/dist/esm/models/index.js +2 -0
  116. package/dist/esm/models/index.js.map +1 -0
  117. package/dist/esm/models/operations/createuser.d.ts +8 -270
  118. package/dist/esm/models/operations/createuser.d.ts.map +1 -1
  119. package/dist/esm/models/operations/createuser.js +15 -176
  120. package/dist/esm/models/operations/createuser.js.map +1 -1
  121. package/dist/esm/models/operations/getallstudents.d.ts +6 -206
  122. package/dist/esm/models/operations/getallstudents.d.ts.map +1 -1
  123. package/dist/esm/models/operations/getallstudents.js +11 -131
  124. package/dist/esm/models/operations/getallstudents.js.map +1 -1
  125. package/dist/esm/models/operations/getallteachers.d.ts +6 -206
  126. package/dist/esm/models/operations/getallteachers.d.ts.map +1 -1
  127. package/dist/esm/models/operations/getallteachers.js +11 -131
  128. package/dist/esm/models/operations/getallteachers.js.map +1 -1
  129. package/dist/esm/models/operations/getallusers.d.ts +6 -206
  130. package/dist/esm/models/operations/getallusers.d.ts.map +1 -1
  131. package/dist/esm/models/operations/getallusers.js +11 -131
  132. package/dist/esm/models/operations/getallusers.js.map +1 -1
  133. package/dist/esm/models/operations/getclassesforuser.d.ts +4 -85
  134. package/dist/esm/models/operations/getclassesforuser.d.ts.map +1 -1
  135. package/dist/esm/models/operations/getclassesforuser.js +7 -66
  136. package/dist/esm/models/operations/getclassesforuser.js.map +1 -1
  137. package/dist/esm/models/operations/getresourcesforuser.d.ts +5 -111
  138. package/dist/esm/models/operations/getresourcesforuser.d.ts.map +1 -1
  139. package/dist/esm/models/operations/getresourcesforuser.js +9 -87
  140. package/dist/esm/models/operations/getresourcesforuser.js.map +1 -1
  141. package/dist/esm/models/operations/getstudent.d.ts +5 -174
  142. package/dist/esm/models/operations/getstudent.d.ts.map +1 -1
  143. package/dist/esm/models/operations/getstudent.js +9 -107
  144. package/dist/esm/models/operations/getstudent.js.map +1 -1
  145. package/dist/esm/models/operations/getstudentsforclass.d.ts +6 -206
  146. package/dist/esm/models/operations/getstudentsforclass.d.ts.map +1 -1
  147. package/dist/esm/models/operations/getstudentsforclass.js +11 -131
  148. package/dist/esm/models/operations/getstudentsforclass.js.map +1 -1
  149. package/dist/esm/models/operations/getstudentsforclassinschool.d.ts +6 -206
  150. package/dist/esm/models/operations/getstudentsforclassinschool.d.ts.map +1 -1
  151. package/dist/esm/models/operations/getstudentsforclassinschool.js +11 -131
  152. package/dist/esm/models/operations/getstudentsforclassinschool.js.map +1 -1
  153. package/dist/esm/models/operations/getstudentsforschool.d.ts +6 -206
  154. package/dist/esm/models/operations/getstudentsforschool.d.ts.map +1 -1
  155. package/dist/esm/models/operations/getstudentsforschool.js +11 -131
  156. package/dist/esm/models/operations/getstudentsforschool.js.map +1 -1
  157. package/dist/esm/models/operations/getteacher.d.ts +5 -174
  158. package/dist/esm/models/operations/getteacher.d.ts.map +1 -1
  159. package/dist/esm/models/operations/getteacher.js +9 -107
  160. package/dist/esm/models/operations/getteacher.js.map +1 -1
  161. package/dist/esm/models/operations/getteachersforclass.d.ts +6 -206
  162. package/dist/esm/models/operations/getteachersforclass.d.ts.map +1 -1
  163. package/dist/esm/models/operations/getteachersforclass.js +11 -131
  164. package/dist/esm/models/operations/getteachersforclass.js.map +1 -1
  165. package/dist/esm/models/operations/getteachersforclassinschool.d.ts +6 -206
  166. package/dist/esm/models/operations/getteachersforclassinschool.d.ts.map +1 -1
  167. package/dist/esm/models/operations/getteachersforclassinschool.js +11 -131
  168. package/dist/esm/models/operations/getteachersforclassinschool.js.map +1 -1
  169. package/dist/esm/models/operations/getteachersforschool.d.ts +6 -206
  170. package/dist/esm/models/operations/getteachersforschool.d.ts.map +1 -1
  171. package/dist/esm/models/operations/getteachersforschool.js +11 -131
  172. package/dist/esm/models/operations/getteachersforschool.js.map +1 -1
  173. package/dist/esm/models/operations/getuser.d.ts +5 -174
  174. package/dist/esm/models/operations/getuser.d.ts.map +1 -1
  175. package/dist/esm/models/operations/getuser.js +9 -107
  176. package/dist/esm/models/operations/getuser.js.map +1 -1
  177. package/dist/esm/models/operations/getuserwithdemographics.d.ts +5 -174
  178. package/dist/esm/models/operations/getuserwithdemographics.d.ts.map +1 -1
  179. package/dist/esm/models/operations/getuserwithdemographics.js +9 -107
  180. package/dist/esm/models/operations/getuserwithdemographics.js.map +1 -1
  181. package/dist/esm/models/operations/updateuser.d.ts +8 -270
  182. package/dist/esm/models/operations/updateuser.d.ts.map +1 -1
  183. package/dist/esm/models/operations/updateuser.js +15 -176
  184. package/dist/esm/models/operations/updateuser.js.map +1 -1
  185. package/dist/esm/models/shared/enums.d.ts +440 -0
  186. package/dist/esm/models/shared/enums.d.ts.map +1 -0
  187. package/dist/esm/models/shared/enums.js +462 -0
  188. package/dist/esm/models/shared/enums.js.map +1 -0
  189. package/dist/esm/models/shared/index.d.ts +8 -0
  190. package/dist/esm/models/shared/index.d.ts.map +1 -0
  191. package/dist/esm/models/shared/index.js +8 -0
  192. package/dist/esm/models/shared/index.js.map +1 -0
  193. package/dist/esm/types/index.d.ts +1 -0
  194. package/dist/esm/types/index.d.ts.map +1 -1
  195. package/dist/esm/types/index.js +2 -0
  196. package/dist/esm/types/index.js.map +1 -1
  197. package/package.json +37 -64
  198. package/src/enums/index.ts +1 -0
  199. package/src/index.ts +44 -0
  200. package/src/models/errors/index.ts +1 -0
  201. package/src/models/index.ts +1 -0
  202. package/src/models/operations/createuser.ts +35 -238
  203. package/src/models/operations/getallstudents.ts +32 -170
  204. package/src/models/operations/getallteachers.ts +32 -170
  205. package/src/models/operations/getallusers.ts +32 -170
  206. package/src/models/operations/getclassesforuser.ts +20 -97
  207. package/src/models/operations/getresourcesforuser.ts +26 -127
  208. package/src/models/operations/getstudent.ts +26 -136
  209. package/src/models/operations/getstudentsforclass.ts +32 -180
  210. package/src/models/operations/getstudentsforclassinschool.ts +32 -188
  211. package/src/models/operations/getstudentsforschool.ts +32 -180
  212. package/src/models/operations/getteacher.ts +26 -136
  213. package/src/models/operations/getteachersforclass.ts +32 -180
  214. package/src/models/operations/getteachersforclassinschool.ts +32 -188
  215. package/src/models/operations/getteachersforschool.ts +32 -180
  216. package/src/models/operations/getuser.ts +26 -136
  217. package/src/models/operations/getuserwithdemographics.ts +26 -144
  218. package/src/models/operations/updateuser.ts +35 -238
  219. package/src/models/shared/enums.ts +567 -0
  220. package/src/models/shared/index.ts +8 -0
  221. package/src/types/index.ts +3 -0
  222. package/test/classlink.test.ts +26 -26
  223. package/vitest.config.ts +2 -2
  224. package/test/summary-reporter.ts +0 -114
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@eduware/oneroster",
3
- "version": "1.2.4",
3
+ "version": "1.2.6",
4
4
  "description": "A TypeScript/JavaScript SDK for the OneRoster API standard - manage students, teachers, classes, enrollments, and academic data for K-12 education systems",
5
5
  "author": "Eduware",
6
6
  "license": "MIT",
@@ -51,12 +51,10 @@
51
51
  "./package.json": "./package.json",
52
52
  "./types": "./src/types/index.ts",
53
53
  "./clients": "./src/clients/index.ts",
54
- "./sdk": "./src/sdk/index.ts",
55
- "./models/errors": "./src/models/errors/index.ts",
56
- "./models/components": "./src/models/components/index.ts",
57
- "./models/operations": "./src/models/operations/index.ts",
58
- "./*.js": "./src/*.ts",
59
- "./*": "./src/*.ts"
54
+ "./enums": "./src/enums/index.ts",
55
+ "./models": "./src/models/index.ts",
56
+ "./core.js": "./src/core.ts",
57
+ "./funcs/*": "./src/funcs/*.ts"
60
58
  }
61
59
  },
62
60
  "sideEffects": false,
@@ -143,70 +141,48 @@
143
141
  "default": "./dist/commonjs/clients/index.js"
144
142
  }
145
143
  },
146
- "./sdk": {
144
+ "./enums": {
147
145
  "import": {
148
- "@eduware/oneroster/source": "./src/sdk/index.ts",
149
- "types": "./dist/esm/sdk/index.d.ts",
150
- "default": "./dist/esm/sdk/index.js"
146
+ "@eduware/oneroster/source": "./src/enums/index.ts",
147
+ "types": "./dist/esm/enums/index.d.ts",
148
+ "default": "./dist/esm/enums/index.js"
151
149
  },
152
150
  "require": {
153
- "types": "./dist/commonjs/sdk/index.d.ts",
154
- "default": "./dist/commonjs/sdk/index.js"
151
+ "types": "./dist/commonjs/enums/index.d.ts",
152
+ "default": "./dist/commonjs/enums/index.js"
155
153
  }
156
154
  },
157
- "./models/errors": {
155
+ "./models": {
158
156
  "import": {
159
- "@eduware/oneroster/source": "./src/models/errors/index.ts",
160
- "types": "./dist/esm/models/errors/index.d.ts",
161
- "default": "./dist/esm/models/errors/index.js"
157
+ "@eduware/oneroster/source": "./src/models/index.ts",
158
+ "types": "./dist/esm/models/index.d.ts",
159
+ "default": "./dist/esm/models/index.js"
162
160
  },
163
161
  "require": {
164
- "types": "./dist/commonjs/models/errors/index.d.ts",
165
- "default": "./dist/commonjs/models/errors/index.js"
162
+ "types": "./dist/commonjs/models/index.d.ts",
163
+ "default": "./dist/commonjs/models/index.js"
166
164
  }
167
165
  },
168
- "./models/components": {
166
+ "./core.js": {
169
167
  "import": {
170
- "@eduware/oneroster/source": "./src/models/components/index.ts",
171
- "types": "./dist/esm/models/components/index.d.ts",
172
- "default": "./dist/esm/models/components/index.js"
168
+ "@eduware/oneroster/source": "./src/core.ts",
169
+ "types": "./dist/esm/core.d.ts",
170
+ "default": "./dist/esm/core.js"
173
171
  },
174
172
  "require": {
175
- "types": "./dist/commonjs/models/components/index.d.ts",
176
- "default": "./dist/commonjs/models/components/index.js"
173
+ "types": "./dist/commonjs/core.d.ts",
174
+ "default": "./dist/commonjs/core.js"
177
175
  }
178
176
  },
179
- "./models/operations": {
177
+ "./funcs/*": {
180
178
  "import": {
181
- "@eduware/oneroster/source": "./src/models/operations/index.ts",
182
- "types": "./dist/esm/models/operations/index.d.ts",
183
- "default": "./dist/esm/models/operations/index.js"
179
+ "@eduware/oneroster/source": "./src/funcs/*.ts",
180
+ "types": "./dist/esm/funcs/*.d.ts",
181
+ "default": "./dist/esm/funcs/*.js"
184
182
  },
185
183
  "require": {
186
- "types": "./dist/commonjs/models/operations/index.d.ts",
187
- "default": "./dist/commonjs/models/operations/index.js"
188
- }
189
- },
190
- "./*.js": {
191
- "import": {
192
- "@eduware/oneroster/source": "./src/*.ts",
193
- "types": "./dist/esm/*.d.ts",
194
- "default": "./dist/esm/*.js"
195
- },
196
- "require": {
197
- "types": "./dist/commonjs/*.d.ts",
198
- "default": "./dist/commonjs/*.js"
199
- }
200
- },
201
- "./*": {
202
- "import": {
203
- "@eduware/oneroster/source": "./src/*.ts",
204
- "types": "./dist/esm/*.d.ts",
205
- "default": "./dist/esm/*.js"
206
- },
207
- "require": {
208
- "types": "./dist/commonjs/*.d.ts",
209
- "default": "./dist/commonjs/*.js"
184
+ "types": "./dist/commonjs/funcs/*.d.ts",
185
+ "default": "./dist/commonjs/funcs/*.js"
210
186
  }
211
187
  }
212
188
  },
@@ -218,23 +194,20 @@
218
194
  "clients": [
219
195
  "./dist/esm/clients/index.d.ts"
220
196
  ],
221
- "sdk": [
222
- "./dist/esm/sdk/index.d.ts"
223
- ],
224
197
  "types": [
225
198
  "./dist/esm/types/index.d.ts"
226
199
  ],
227
- "models/errors": [
228
- "./dist/esm/models/errors/index.d.ts"
200
+ "enums": [
201
+ "./dist/esm/enums/index.d.ts"
229
202
  ],
230
- "models/components": [
231
- "./dist/esm/models/components/index.d.ts"
203
+ "models": [
204
+ "./dist/esm/models/index.d.ts"
232
205
  ],
233
- "models/operations": [
234
- "./dist/esm/models/operations/index.d.ts"
206
+ "core.js": [
207
+ "./dist/esm/core.d.ts"
235
208
  ],
236
- "*": [
237
- "./dist/esm/*.d.ts"
209
+ "funcs/*": [
210
+ "./dist/esm/funcs/*.d.ts"
238
211
  ]
239
212
  }
240
213
  },
@@ -0,0 +1 @@
1
+ export * from '../models/shared/index.js';
package/src/index.ts CHANGED
@@ -6,3 +6,47 @@ export * from './sdk/sdk.js';
6
6
 
7
7
  // Clients - LMS-specific profile interfaces and typed client aliases
8
8
  export * as clients from './clients/index.js';
9
+
10
+ // Shared Enums - OneRoster specification enums (also available via @eduware/oneroster/models/shared)
11
+ export * as enums from './models/shared/index.js';
12
+ export {
13
+ // GUID reference types
14
+ AcademicSessionRefType,
15
+ ClassRefType,
16
+ ClassType,
17
+ // Error response enums
18
+ CodeMajor,
19
+ CodeMinor,
20
+ CourseRefType,
21
+ EnrollmentRole,
22
+ EntityType,
23
+ Gender,
24
+ Importance,
25
+ OrderBy,
26
+ OrgRefType,
27
+ OrgType,
28
+ ResourceRefType,
29
+ RoleType,
30
+ // Result/Score enums
31
+ ScoreStatus,
32
+ SessionType,
33
+ Severity,
34
+ // Core enums
35
+ Status,
36
+ TrueFalse,
37
+ UserRefType,
38
+ UserRole,
39
+ } from './models/shared/index.js';
40
+
41
+ // Errors - Re-export for convenience (also available via @eduware/oneroster/models/errors)
42
+ export * as errors from './models/errors/index.js';
43
+ export {
44
+ BadRequestResponseError,
45
+ ForbiddenResponseError,
46
+ InternalServerErrorResponse,
47
+ NotFoundResponseError,
48
+ OneRosterError,
49
+ TooManyRequestsResponseError,
50
+ UnauthorizedRequestResponseError,
51
+ UnprocessableEntityResponseError,
52
+ } from './models/errors/index.js';
@@ -4,6 +4,7 @@ export * from './forbiddenresponseerror.js';
4
4
  export * from './httpclienterrors.js';
5
5
  export * from './internalservererrorresponse.js';
6
6
  export * from './notfoundresponseerror.js';
7
+ export * from './onerostererror.js';
7
8
  export * from './responsevalidationerror.js';
8
9
  export * from './sdkvalidationerror.js';
9
10
  export * from './toomanyrequestsresponseerror.js';
@@ -0,0 +1 @@
1
+ export * from './components/index.js';
@@ -2,10 +2,23 @@ import * as z from 'zod';
2
2
 
3
3
  import { remap as remap$ } from '../../lib/primitives.js';
4
4
  import { collectExtraKeys as collectExtraKeys$, safeParse } from '../../lib/schemas.js';
5
- import { ClosedEnum } from '../../types/enums.js';
6
5
  import { Result as SafeParseResult } from '../../types/fp.js';
7
6
  import * as components from '../components/index.js';
8
7
  import { SDKValidationError } from '../errors/sdkvalidationerror.js';
8
+ import {
9
+ EntityType,
10
+ EntityType$inboundSchema,
11
+ EntityType$outboundSchema,
12
+ RoleType,
13
+ RoleType$inboundSchema,
14
+ RoleType$outboundSchema,
15
+ Status,
16
+ Status$inboundSchema,
17
+ Status$outboundSchema,
18
+ UserRole,
19
+ UserRole$inboundSchema,
20
+ UserRole$outboundSchema,
21
+ } from '../shared/enums.js';
9
22
 
10
23
  export type CreateUserOnboardingCompleted = {
11
24
  state?: 'completed' | undefined;
@@ -38,42 +51,18 @@ export type CreateUserMetadata = {
38
51
  additionalProperties?: { [k: string]: any };
39
52
  };
40
53
 
41
- export const CreateUserStatusRequest = {
42
- Active: 'active',
43
- Tobedeleted: 'tobedeleted',
44
- } as const;
45
- export type CreateUserStatusRequest = ClosedEnum<typeof CreateUserStatusRequest>;
46
-
47
54
  export type CreateUserUserIdRequest = {
48
55
  type: string;
49
56
  identifier: string;
50
57
  };
51
58
 
52
- export const CreateUserRoleTypeRequest = {
53
- Primary: 'primary',
54
- Secondary: 'secondary',
55
- } as const;
56
- export type CreateUserRoleTypeRequest = ClosedEnum<typeof CreateUserRoleTypeRequest>;
57
-
58
- export const CreateUserRoleRequestEnum = {
59
- Administrator: 'administrator',
60
- Aide: 'aide',
61
- Guardian: 'guardian',
62
- Parent: 'parent',
63
- Proctor: 'proctor',
64
- Relative: 'relative',
65
- Student: 'student',
66
- Teacher: 'teacher',
67
- } as const;
68
- export type CreateUserRoleRequestEnum = ClosedEnum<typeof CreateUserRoleRequestEnum>;
69
-
70
59
  export type CreateUserOrgRequest = {
71
60
  sourcedId: string;
72
61
  };
73
62
 
74
63
  export type CreateUserRoleRequest = {
75
- roleType: CreateUserRoleTypeRequest;
76
- role: CreateUserRoleRequestEnum;
64
+ roleType: RoleType;
65
+ role: UserRole;
77
66
  org: CreateUserOrgRequest;
78
67
  userProfile?: string | undefined;
79
68
  beginDate?: string | undefined;
@@ -91,7 +80,7 @@ export type CreateUserAgentRequest = {
91
80
  export type CreateUserUserRequest = {
92
81
  sourcedId?: string | undefined;
93
82
  metadata?: CreateUserMetadata | undefined;
94
- status?: CreateUserStatusRequest | undefined;
83
+ status?: Status | undefined;
95
84
  userMasterIdentifier?: string | null | undefined;
96
85
  username?: string | null | undefined;
97
86
  userIds?: Array<CreateUserUserIdRequest> | undefined;
@@ -117,35 +106,11 @@ export type CreateUserRequest = {
117
106
  user: CreateUserUserRequest;
118
107
  };
119
108
 
120
- export const CreateUserStatusResponse = {
121
- Active: 'active',
122
- Tobedeleted: 'tobedeleted',
123
- } as const;
124
- export type CreateUserStatusResponse = ClosedEnum<typeof CreateUserStatusResponse>;
125
-
126
109
  export type CreateUserUserIdResponse = {
127
110
  type: string;
128
111
  identifier: string;
129
112
  };
130
113
 
131
- export const CreateUserRoleTypeResponse = {
132
- Primary: 'primary',
133
- Secondary: 'secondary',
134
- } as const;
135
- export type CreateUserRoleTypeResponse = ClosedEnum<typeof CreateUserRoleTypeResponse>;
136
-
137
- export const CreateUserRoleResponseEnum = {
138
- Administrator: 'administrator',
139
- Aide: 'aide',
140
- Guardian: 'guardian',
141
- Parent: 'parent',
142
- Proctor: 'proctor',
143
- Relative: 'relative',
144
- Student: 'student',
145
- Teacher: 'teacher',
146
- } as const;
147
- export type CreateUserRoleResponseEnum = ClosedEnum<typeof CreateUserRoleResponseEnum>;
148
-
149
114
  export type CreateUserOrgResponse = {
150
115
  href: string;
151
116
  sourcedId: string;
@@ -153,41 +118,18 @@ export type CreateUserOrgResponse = {
153
118
  };
154
119
 
155
120
  export type CreateUserRoleResponse = {
156
- roleType: CreateUserRoleTypeResponse;
157
- role: CreateUserRoleResponseEnum;
121
+ roleType: RoleType;
122
+ role: UserRole;
158
123
  org: CreateUserOrgResponse;
159
124
  userProfile?: string | undefined;
160
125
  beginDate: string | null;
161
126
  endDate: string | null;
162
127
  };
163
128
 
164
- export const CreateUserType = {
165
- AcademicSession: 'academicSession',
166
- AssessmentLineItem: 'assessmentLineItem',
167
- Category: 'category',
168
- Class: 'class',
169
- Course: 'course',
170
- Demographics: 'demographics',
171
- Enrollment: 'enrollment',
172
- GradingPeriod: 'gradingPeriod',
173
- LineItem: 'lineItem',
174
- Org: 'org',
175
- Resource: 'resource',
176
- Result: 'result',
177
- ScoreScale: 'scoreScale',
178
- Student: 'student',
179
- Teacher: 'teacher',
180
- Term: 'term',
181
- User: 'user',
182
- ComponentResource: 'componentResource',
183
- CourseComponent: 'courseComponent',
184
- } as const;
185
- export type CreateUserType = ClosedEnum<typeof CreateUserType>;
186
-
187
129
  export type CreateUserAgentResponse = {
188
130
  href: string;
189
131
  sourcedId: string;
190
- type: CreateUserType;
132
+ type: EntityType;
191
133
  };
192
134
 
193
135
  export type CreateUserPrimaryOrgResponse = {
@@ -198,7 +140,7 @@ export type CreateUserPrimaryOrgResponse = {
198
140
 
199
141
  export type CreateUserUserResponse = {
200
142
  sourcedId: string;
201
- status: CreateUserStatusResponse;
143
+ status: Status;
202
144
  dateLastModified?: Date | undefined;
203
145
  metadata?: { [k: string]: any } | null | undefined;
204
146
  userMasterIdentifier?: string | null | undefined;
@@ -547,27 +489,6 @@ export function createUserMetadataFromJSON(
547
489
  );
548
490
  }
549
491
 
550
- /** @internal */
551
- export const CreateUserStatusRequest$inboundSchema: z.ZodNativeEnum<
552
- typeof CreateUserStatusRequest
553
- > = z.nativeEnum(CreateUserStatusRequest);
554
-
555
- /** @internal */
556
- export const CreateUserStatusRequest$outboundSchema: z.ZodNativeEnum<
557
- typeof CreateUserStatusRequest
558
- > = CreateUserStatusRequest$inboundSchema;
559
-
560
- /**
561
- * @internal
562
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
563
- */
564
- export namespace CreateUserStatusRequest$ {
565
- /** @deprecated use `CreateUserStatusRequest$inboundSchema` instead. */
566
- export const inboundSchema = CreateUserStatusRequest$inboundSchema;
567
- /** @deprecated use `CreateUserStatusRequest$outboundSchema` instead. */
568
- export const outboundSchema = CreateUserStatusRequest$outboundSchema;
569
- }
570
-
571
492
  /** @internal */
572
493
  export const CreateUserUserIdRequest$inboundSchema: z.ZodType<
573
494
  CreateUserUserIdRequest,
@@ -623,48 +544,6 @@ export function createUserUserIdRequestFromJSON(
623
544
  );
624
545
  }
625
546
 
626
- /** @internal */
627
- export const CreateUserRoleTypeRequest$inboundSchema: z.ZodNativeEnum<
628
- typeof CreateUserRoleTypeRequest
629
- > = z.nativeEnum(CreateUserRoleTypeRequest);
630
-
631
- /** @internal */
632
- export const CreateUserRoleTypeRequest$outboundSchema: z.ZodNativeEnum<
633
- typeof CreateUserRoleTypeRequest
634
- > = CreateUserRoleTypeRequest$inboundSchema;
635
-
636
- /**
637
- * @internal
638
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
639
- */
640
- export namespace CreateUserRoleTypeRequest$ {
641
- /** @deprecated use `CreateUserRoleTypeRequest$inboundSchema` instead. */
642
- export const inboundSchema = CreateUserRoleTypeRequest$inboundSchema;
643
- /** @deprecated use `CreateUserRoleTypeRequest$outboundSchema` instead. */
644
- export const outboundSchema = CreateUserRoleTypeRequest$outboundSchema;
645
- }
646
-
647
- /** @internal */
648
- export const CreateUserRoleRequestEnum$inboundSchema: z.ZodNativeEnum<
649
- typeof CreateUserRoleRequestEnum
650
- > = z.nativeEnum(CreateUserRoleRequestEnum);
651
-
652
- /** @internal */
653
- export const CreateUserRoleRequestEnum$outboundSchema: z.ZodNativeEnum<
654
- typeof CreateUserRoleRequestEnum
655
- > = CreateUserRoleRequestEnum$inboundSchema;
656
-
657
- /**
658
- * @internal
659
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
660
- */
661
- export namespace CreateUserRoleRequestEnum$ {
662
- /** @deprecated use `CreateUserRoleRequestEnum$inboundSchema` instead. */
663
- export const inboundSchema = CreateUserRoleRequestEnum$inboundSchema;
664
- /** @deprecated use `CreateUserRoleRequestEnum$outboundSchema` instead. */
665
- export const outboundSchema = CreateUserRoleRequestEnum$outboundSchema;
666
- }
667
-
668
547
  /** @internal */
669
548
  export const CreateUserOrgRequest$inboundSchema: z.ZodType<
670
549
  CreateUserOrgRequest,
@@ -721,8 +600,8 @@ export const CreateUserRoleRequest$inboundSchema: z.ZodType<
721
600
  z.ZodTypeDef,
722
601
  unknown
723
602
  > = z.object({
724
- roleType: CreateUserRoleTypeRequest$inboundSchema,
725
- role: CreateUserRoleRequestEnum$inboundSchema,
603
+ roleType: RoleType$inboundSchema,
604
+ role: UserRole$inboundSchema,
726
605
  org: z.lazy(() => CreateUserOrgRequest$inboundSchema),
727
606
  userProfile: z.string().optional(),
728
607
  beginDate: z.string().optional(),
@@ -745,8 +624,8 @@ export const CreateUserRoleRequest$outboundSchema: z.ZodType<
745
624
  z.ZodTypeDef,
746
625
  CreateUserRoleRequest
747
626
  > = z.object({
748
- roleType: CreateUserRoleTypeRequest$outboundSchema,
749
- role: CreateUserRoleRequestEnum$outboundSchema,
627
+ roleType: RoleType$outboundSchema,
628
+ role: UserRole$outboundSchema,
750
629
  org: z.lazy(() => CreateUserOrgRequest$outboundSchema),
751
630
  userProfile: z.string().optional(),
752
631
  beginDate: z.string().optional(),
@@ -894,7 +773,7 @@ export const CreateUserUserRequest$inboundSchema: z.ZodType<
894
773
  > = z.object({
895
774
  sourcedId: z.string().optional(),
896
775
  metadata: z.lazy(() => CreateUserMetadata$inboundSchema).optional(),
897
- status: CreateUserStatusRequest$inboundSchema.default('active'),
776
+ status: Status$inboundSchema.default('active'),
898
777
  userMasterIdentifier: z.nullable(z.string()).optional(),
899
778
  username: z.nullable(z.string()).optional(),
900
779
  userIds: z.array(z.lazy(() => CreateUserUserIdRequest$inboundSchema)).optional(),
@@ -950,7 +829,7 @@ export const CreateUserUserRequest$outboundSchema: z.ZodType<
950
829
  > = z.object({
951
830
  sourcedId: z.string().optional(),
952
831
  metadata: z.lazy(() => CreateUserMetadata$outboundSchema).optional(),
953
- status: CreateUserStatusRequest$outboundSchema.default('active'),
832
+ status: Status$outboundSchema.default('active'),
954
833
  userMasterIdentifier: z.nullable(z.string()).optional(),
955
834
  username: z.nullable(z.string()).optional(),
956
835
  userIds: z.array(z.lazy(() => CreateUserUserIdRequest$outboundSchema)).optional(),
@@ -1046,27 +925,6 @@ export function createUserRequestFromJSON(
1046
925
  );
1047
926
  }
1048
927
 
1049
- /** @internal */
1050
- export const CreateUserStatusResponse$inboundSchema: z.ZodNativeEnum<
1051
- typeof CreateUserStatusResponse
1052
- > = z.nativeEnum(CreateUserStatusResponse);
1053
-
1054
- /** @internal */
1055
- export const CreateUserStatusResponse$outboundSchema: z.ZodNativeEnum<
1056
- typeof CreateUserStatusResponse
1057
- > = CreateUserStatusResponse$inboundSchema;
1058
-
1059
- /**
1060
- * @internal
1061
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1062
- */
1063
- export namespace CreateUserStatusResponse$ {
1064
- /** @deprecated use `CreateUserStatusResponse$inboundSchema` instead. */
1065
- export const inboundSchema = CreateUserStatusResponse$inboundSchema;
1066
- /** @deprecated use `CreateUserStatusResponse$outboundSchema` instead. */
1067
- export const outboundSchema = CreateUserStatusResponse$outboundSchema;
1068
- }
1069
-
1070
928
  /** @internal */
1071
929
  export const CreateUserUserIdResponse$inboundSchema: z.ZodType<
1072
930
  CreateUserUserIdResponse,
@@ -1122,48 +980,6 @@ export function createUserUserIdResponseFromJSON(
1122
980
  );
1123
981
  }
1124
982
 
1125
- /** @internal */
1126
- export const CreateUserRoleTypeResponse$inboundSchema: z.ZodNativeEnum<
1127
- typeof CreateUserRoleTypeResponse
1128
- > = z.nativeEnum(CreateUserRoleTypeResponse);
1129
-
1130
- /** @internal */
1131
- export const CreateUserRoleTypeResponse$outboundSchema: z.ZodNativeEnum<
1132
- typeof CreateUserRoleTypeResponse
1133
- > = CreateUserRoleTypeResponse$inboundSchema;
1134
-
1135
- /**
1136
- * @internal
1137
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1138
- */
1139
- export namespace CreateUserRoleTypeResponse$ {
1140
- /** @deprecated use `CreateUserRoleTypeResponse$inboundSchema` instead. */
1141
- export const inboundSchema = CreateUserRoleTypeResponse$inboundSchema;
1142
- /** @deprecated use `CreateUserRoleTypeResponse$outboundSchema` instead. */
1143
- export const outboundSchema = CreateUserRoleTypeResponse$outboundSchema;
1144
- }
1145
-
1146
- /** @internal */
1147
- export const CreateUserRoleResponseEnum$inboundSchema: z.ZodNativeEnum<
1148
- typeof CreateUserRoleResponseEnum
1149
- > = z.nativeEnum(CreateUserRoleResponseEnum);
1150
-
1151
- /** @internal */
1152
- export const CreateUserRoleResponseEnum$outboundSchema: z.ZodNativeEnum<
1153
- typeof CreateUserRoleResponseEnum
1154
- > = CreateUserRoleResponseEnum$inboundSchema;
1155
-
1156
- /**
1157
- * @internal
1158
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1159
- */
1160
- export namespace CreateUserRoleResponseEnum$ {
1161
- /** @deprecated use `CreateUserRoleResponseEnum$inboundSchema` instead. */
1162
- export const inboundSchema = CreateUserRoleResponseEnum$inboundSchema;
1163
- /** @deprecated use `CreateUserRoleResponseEnum$outboundSchema` instead. */
1164
- export const outboundSchema = CreateUserRoleResponseEnum$outboundSchema;
1165
- }
1166
-
1167
983
  /** @internal */
1168
984
  export const CreateUserOrgResponse$inboundSchema: z.ZodType<
1169
985
  CreateUserOrgResponse,
@@ -1226,8 +1042,8 @@ export const CreateUserRoleResponse$inboundSchema: z.ZodType<
1226
1042
  z.ZodTypeDef,
1227
1043
  unknown
1228
1044
  > = z.object({
1229
- roleType: CreateUserRoleTypeResponse$inboundSchema,
1230
- role: CreateUserRoleResponseEnum$inboundSchema,
1045
+ roleType: RoleType$inboundSchema,
1046
+ role: UserRole$inboundSchema,
1231
1047
  org: z.lazy(() => CreateUserOrgResponse$inboundSchema),
1232
1048
  userProfile: z.string().optional(),
1233
1049
  beginDate: z.nullable(z.string()),
@@ -1250,8 +1066,8 @@ export const CreateUserRoleResponse$outboundSchema: z.ZodType<
1250
1066
  z.ZodTypeDef,
1251
1067
  CreateUserRoleResponse
1252
1068
  > = z.object({
1253
- roleType: CreateUserRoleTypeResponse$outboundSchema,
1254
- role: CreateUserRoleResponseEnum$outboundSchema,
1069
+ roleType: RoleType$outboundSchema,
1070
+ role: UserRole$outboundSchema,
1255
1071
  org: z.lazy(() => CreateUserOrgResponse$outboundSchema),
1256
1072
  userProfile: z.string().optional(),
1257
1073
  beginDate: z.nullable(z.string()),
@@ -1287,25 +1103,6 @@ export function createUserRoleResponseFromJSON(
1287
1103
  );
1288
1104
  }
1289
1105
 
1290
- /** @internal */
1291
- export const CreateUserType$inboundSchema: z.ZodNativeEnum<typeof CreateUserType> =
1292
- z.nativeEnum(CreateUserType);
1293
-
1294
- /** @internal */
1295
- export const CreateUserType$outboundSchema: z.ZodNativeEnum<typeof CreateUserType> =
1296
- CreateUserType$inboundSchema;
1297
-
1298
- /**
1299
- * @internal
1300
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1301
- */
1302
- export namespace CreateUserType$ {
1303
- /** @deprecated use `CreateUserType$inboundSchema` instead. */
1304
- export const inboundSchema = CreateUserType$inboundSchema;
1305
- /** @deprecated use `CreateUserType$outboundSchema` instead. */
1306
- export const outboundSchema = CreateUserType$outboundSchema;
1307
- }
1308
-
1309
1106
  /** @internal */
1310
1107
  export const CreateUserAgentResponse$inboundSchema: z.ZodType<
1311
1108
  CreateUserAgentResponse,
@@ -1314,7 +1111,7 @@ export const CreateUserAgentResponse$inboundSchema: z.ZodType<
1314
1111
  > = z.object({
1315
1112
  href: z.string(),
1316
1113
  sourcedId: z.string(),
1317
- type: CreateUserType$inboundSchema,
1114
+ type: EntityType$inboundSchema,
1318
1115
  });
1319
1116
 
1320
1117
  /** @internal */
@@ -1332,7 +1129,7 @@ export const CreateUserAgentResponse$outboundSchema: z.ZodType<
1332
1129
  > = z.object({
1333
1130
  href: z.string(),
1334
1131
  sourcedId: z.string(),
1335
- type: CreateUserType$outboundSchema,
1132
+ type: EntityType$outboundSchema,
1336
1133
  });
1337
1134
 
1338
1135
  /**
@@ -1431,7 +1228,7 @@ export const CreateUserUserResponse$inboundSchema: z.ZodType<
1431
1228
  unknown
1432
1229
  > = z.object({
1433
1230
  sourcedId: z.string(),
1434
- status: CreateUserStatusResponse$inboundSchema,
1231
+ status: Status$inboundSchema,
1435
1232
  dateLastModified: z
1436
1233
  .string()
1437
1234
  .datetime({ offset: true })
@@ -1495,7 +1292,7 @@ export const CreateUserUserResponse$outboundSchema: z.ZodType<
1495
1292
  CreateUserUserResponse
1496
1293
  > = z.object({
1497
1294
  sourcedId: z.string(),
1498
- status: CreateUserStatusResponse$outboundSchema,
1295
+ status: Status$outboundSchema,
1499
1296
  dateLastModified: z
1500
1297
  .date()
1501
1298
  .transform((v) => v.toISOString())