@eduware/oneroster 1.2.3 → 1.2.5

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 (194) hide show
  1. package/README.md +28 -17
  2. package/bin/mcp-server.js +338 -1328
  3. package/bin/mcp-server.js.map +22 -21
  4. package/dist/commonjs/index.d.ts +4 -0
  5. package/dist/commonjs/index.d.ts.map +1 -1
  6. package/dist/commonjs/index.js +41 -1
  7. package/dist/commonjs/index.js.map +1 -1
  8. package/dist/commonjs/models/errors/index.d.ts +1 -0
  9. package/dist/commonjs/models/errors/index.d.ts.map +1 -1
  10. package/dist/commonjs/models/errors/index.js +1 -0
  11. package/dist/commonjs/models/errors/index.js.map +1 -1
  12. package/dist/commonjs/models/operations/createuser.d.ts +8 -270
  13. package/dist/commonjs/models/operations/createuser.d.ts.map +1 -1
  14. package/dist/commonjs/models/operations/createuser.js +17 -178
  15. package/dist/commonjs/models/operations/createuser.js.map +1 -1
  16. package/dist/commonjs/models/operations/getallstudents.d.ts +6 -206
  17. package/dist/commonjs/models/operations/getallstudents.d.ts.map +1 -1
  18. package/dist/commonjs/models/operations/getallstudents.js +12 -132
  19. package/dist/commonjs/models/operations/getallstudents.js.map +1 -1
  20. package/dist/commonjs/models/operations/getallteachers.d.ts +6 -206
  21. package/dist/commonjs/models/operations/getallteachers.d.ts.map +1 -1
  22. package/dist/commonjs/models/operations/getallteachers.js +12 -132
  23. package/dist/commonjs/models/operations/getallteachers.js.map +1 -1
  24. package/dist/commonjs/models/operations/getallusers.d.ts +6 -206
  25. package/dist/commonjs/models/operations/getallusers.d.ts.map +1 -1
  26. package/dist/commonjs/models/operations/getallusers.js +12 -132
  27. package/dist/commonjs/models/operations/getallusers.js.map +1 -1
  28. package/dist/commonjs/models/operations/getclassesforuser.d.ts +4 -85
  29. package/dist/commonjs/models/operations/getclassesforuser.d.ts.map +1 -1
  30. package/dist/commonjs/models/operations/getclassesforuser.js +8 -67
  31. package/dist/commonjs/models/operations/getclassesforuser.js.map +1 -1
  32. package/dist/commonjs/models/operations/getresourcesforuser.d.ts +5 -111
  33. package/dist/commonjs/models/operations/getresourcesforuser.d.ts.map +1 -1
  34. package/dist/commonjs/models/operations/getresourcesforuser.js +10 -88
  35. package/dist/commonjs/models/operations/getresourcesforuser.js.map +1 -1
  36. package/dist/commonjs/models/operations/getstudent.d.ts +5 -174
  37. package/dist/commonjs/models/operations/getstudent.d.ts.map +1 -1
  38. package/dist/commonjs/models/operations/getstudent.js +10 -108
  39. package/dist/commonjs/models/operations/getstudent.js.map +1 -1
  40. package/dist/commonjs/models/operations/getstudentsforclass.d.ts +6 -206
  41. package/dist/commonjs/models/operations/getstudentsforclass.d.ts.map +1 -1
  42. package/dist/commonjs/models/operations/getstudentsforclass.js +12 -132
  43. package/dist/commonjs/models/operations/getstudentsforclass.js.map +1 -1
  44. package/dist/commonjs/models/operations/getstudentsforclassinschool.d.ts +6 -206
  45. package/dist/commonjs/models/operations/getstudentsforclassinschool.d.ts.map +1 -1
  46. package/dist/commonjs/models/operations/getstudentsforclassinschool.js +12 -132
  47. package/dist/commonjs/models/operations/getstudentsforclassinschool.js.map +1 -1
  48. package/dist/commonjs/models/operations/getstudentsforschool.d.ts +6 -206
  49. package/dist/commonjs/models/operations/getstudentsforschool.d.ts.map +1 -1
  50. package/dist/commonjs/models/operations/getstudentsforschool.js +12 -132
  51. package/dist/commonjs/models/operations/getstudentsforschool.js.map +1 -1
  52. package/dist/commonjs/models/operations/getteacher.d.ts +5 -174
  53. package/dist/commonjs/models/operations/getteacher.d.ts.map +1 -1
  54. package/dist/commonjs/models/operations/getteacher.js +10 -108
  55. package/dist/commonjs/models/operations/getteacher.js.map +1 -1
  56. package/dist/commonjs/models/operations/getteachersforclass.d.ts +6 -206
  57. package/dist/commonjs/models/operations/getteachersforclass.d.ts.map +1 -1
  58. package/dist/commonjs/models/operations/getteachersforclass.js +12 -132
  59. package/dist/commonjs/models/operations/getteachersforclass.js.map +1 -1
  60. package/dist/commonjs/models/operations/getteachersforclassinschool.d.ts +6 -206
  61. package/dist/commonjs/models/operations/getteachersforclassinschool.d.ts.map +1 -1
  62. package/dist/commonjs/models/operations/getteachersforclassinschool.js +12 -132
  63. package/dist/commonjs/models/operations/getteachersforclassinschool.js.map +1 -1
  64. package/dist/commonjs/models/operations/getteachersforschool.d.ts +6 -206
  65. package/dist/commonjs/models/operations/getteachersforschool.d.ts.map +1 -1
  66. package/dist/commonjs/models/operations/getteachersforschool.js +12 -132
  67. package/dist/commonjs/models/operations/getteachersforschool.js.map +1 -1
  68. package/dist/commonjs/models/operations/getuser.d.ts +5 -174
  69. package/dist/commonjs/models/operations/getuser.d.ts.map +1 -1
  70. package/dist/commonjs/models/operations/getuser.js +10 -108
  71. package/dist/commonjs/models/operations/getuser.js.map +1 -1
  72. package/dist/commonjs/models/operations/getuserwithdemographics.d.ts +5 -174
  73. package/dist/commonjs/models/operations/getuserwithdemographics.d.ts.map +1 -1
  74. package/dist/commonjs/models/operations/getuserwithdemographics.js +10 -108
  75. package/dist/commonjs/models/operations/getuserwithdemographics.js.map +1 -1
  76. package/dist/commonjs/models/operations/updateuser.d.ts +8 -270
  77. package/dist/commonjs/models/operations/updateuser.d.ts.map +1 -1
  78. package/dist/commonjs/models/operations/updateuser.js +17 -178
  79. package/dist/commonjs/models/operations/updateuser.js.map +1 -1
  80. package/dist/commonjs/models/shared/enums.d.ts +440 -0
  81. package/dist/commonjs/models/shared/enums.d.ts.map +1 -0
  82. package/dist/commonjs/models/shared/enums.js +499 -0
  83. package/dist/commonjs/models/shared/enums.js.map +1 -0
  84. package/dist/commonjs/models/shared/index.d.ts +8 -0
  85. package/dist/commonjs/models/shared/index.d.ts.map +1 -0
  86. package/dist/commonjs/models/shared/index.js +24 -0
  87. package/dist/commonjs/models/shared/index.js.map +1 -0
  88. package/dist/esm/index.d.ts +4 -0
  89. package/dist/esm/index.d.ts.map +1 -1
  90. package/dist/esm/index.js +14 -0
  91. package/dist/esm/index.js.map +1 -1
  92. package/dist/esm/models/errors/index.d.ts +1 -0
  93. package/dist/esm/models/errors/index.d.ts.map +1 -1
  94. package/dist/esm/models/errors/index.js +1 -0
  95. package/dist/esm/models/errors/index.js.map +1 -1
  96. package/dist/esm/models/operations/createuser.d.ts +8 -270
  97. package/dist/esm/models/operations/createuser.d.ts.map +1 -1
  98. package/dist/esm/models/operations/createuser.js +15 -176
  99. package/dist/esm/models/operations/createuser.js.map +1 -1
  100. package/dist/esm/models/operations/getallstudents.d.ts +6 -206
  101. package/dist/esm/models/operations/getallstudents.d.ts.map +1 -1
  102. package/dist/esm/models/operations/getallstudents.js +11 -131
  103. package/dist/esm/models/operations/getallstudents.js.map +1 -1
  104. package/dist/esm/models/operations/getallteachers.d.ts +6 -206
  105. package/dist/esm/models/operations/getallteachers.d.ts.map +1 -1
  106. package/dist/esm/models/operations/getallteachers.js +11 -131
  107. package/dist/esm/models/operations/getallteachers.js.map +1 -1
  108. package/dist/esm/models/operations/getallusers.d.ts +6 -206
  109. package/dist/esm/models/operations/getallusers.d.ts.map +1 -1
  110. package/dist/esm/models/operations/getallusers.js +11 -131
  111. package/dist/esm/models/operations/getallusers.js.map +1 -1
  112. package/dist/esm/models/operations/getclassesforuser.d.ts +4 -85
  113. package/dist/esm/models/operations/getclassesforuser.d.ts.map +1 -1
  114. package/dist/esm/models/operations/getclassesforuser.js +7 -66
  115. package/dist/esm/models/operations/getclassesforuser.js.map +1 -1
  116. package/dist/esm/models/operations/getresourcesforuser.d.ts +5 -111
  117. package/dist/esm/models/operations/getresourcesforuser.d.ts.map +1 -1
  118. package/dist/esm/models/operations/getresourcesforuser.js +9 -87
  119. package/dist/esm/models/operations/getresourcesforuser.js.map +1 -1
  120. package/dist/esm/models/operations/getstudent.d.ts +5 -174
  121. package/dist/esm/models/operations/getstudent.d.ts.map +1 -1
  122. package/dist/esm/models/operations/getstudent.js +9 -107
  123. package/dist/esm/models/operations/getstudent.js.map +1 -1
  124. package/dist/esm/models/operations/getstudentsforclass.d.ts +6 -206
  125. package/dist/esm/models/operations/getstudentsforclass.d.ts.map +1 -1
  126. package/dist/esm/models/operations/getstudentsforclass.js +11 -131
  127. package/dist/esm/models/operations/getstudentsforclass.js.map +1 -1
  128. package/dist/esm/models/operations/getstudentsforclassinschool.d.ts +6 -206
  129. package/dist/esm/models/operations/getstudentsforclassinschool.d.ts.map +1 -1
  130. package/dist/esm/models/operations/getstudentsforclassinschool.js +11 -131
  131. package/dist/esm/models/operations/getstudentsforclassinschool.js.map +1 -1
  132. package/dist/esm/models/operations/getstudentsforschool.d.ts +6 -206
  133. package/dist/esm/models/operations/getstudentsforschool.d.ts.map +1 -1
  134. package/dist/esm/models/operations/getstudentsforschool.js +11 -131
  135. package/dist/esm/models/operations/getstudentsforschool.js.map +1 -1
  136. package/dist/esm/models/operations/getteacher.d.ts +5 -174
  137. package/dist/esm/models/operations/getteacher.d.ts.map +1 -1
  138. package/dist/esm/models/operations/getteacher.js +9 -107
  139. package/dist/esm/models/operations/getteacher.js.map +1 -1
  140. package/dist/esm/models/operations/getteachersforclass.d.ts +6 -206
  141. package/dist/esm/models/operations/getteachersforclass.d.ts.map +1 -1
  142. package/dist/esm/models/operations/getteachersforclass.js +11 -131
  143. package/dist/esm/models/operations/getteachersforclass.js.map +1 -1
  144. package/dist/esm/models/operations/getteachersforclassinschool.d.ts +6 -206
  145. package/dist/esm/models/operations/getteachersforclassinschool.d.ts.map +1 -1
  146. package/dist/esm/models/operations/getteachersforclassinschool.js +11 -131
  147. package/dist/esm/models/operations/getteachersforclassinschool.js.map +1 -1
  148. package/dist/esm/models/operations/getteachersforschool.d.ts +6 -206
  149. package/dist/esm/models/operations/getteachersforschool.d.ts.map +1 -1
  150. package/dist/esm/models/operations/getteachersforschool.js +11 -131
  151. package/dist/esm/models/operations/getteachersforschool.js.map +1 -1
  152. package/dist/esm/models/operations/getuser.d.ts +5 -174
  153. package/dist/esm/models/operations/getuser.d.ts.map +1 -1
  154. package/dist/esm/models/operations/getuser.js +9 -107
  155. package/dist/esm/models/operations/getuser.js.map +1 -1
  156. package/dist/esm/models/operations/getuserwithdemographics.d.ts +5 -174
  157. package/dist/esm/models/operations/getuserwithdemographics.d.ts.map +1 -1
  158. package/dist/esm/models/operations/getuserwithdemographics.js +9 -107
  159. package/dist/esm/models/operations/getuserwithdemographics.js.map +1 -1
  160. package/dist/esm/models/operations/updateuser.d.ts +8 -270
  161. package/dist/esm/models/operations/updateuser.d.ts.map +1 -1
  162. package/dist/esm/models/operations/updateuser.js +15 -176
  163. package/dist/esm/models/operations/updateuser.js.map +1 -1
  164. package/dist/esm/models/shared/enums.d.ts +440 -0
  165. package/dist/esm/models/shared/enums.d.ts.map +1 -0
  166. package/dist/esm/models/shared/enums.js +462 -0
  167. package/dist/esm/models/shared/enums.js.map +1 -0
  168. package/dist/esm/models/shared/index.d.ts +8 -0
  169. package/dist/esm/models/shared/index.d.ts.map +1 -0
  170. package/dist/esm/models/shared/index.js +8 -0
  171. package/dist/esm/models/shared/index.js.map +1 -0
  172. package/package.json +55 -1
  173. package/src/index.ts +44 -0
  174. package/src/models/errors/index.ts +1 -0
  175. package/src/models/operations/createuser.ts +35 -238
  176. package/src/models/operations/getallstudents.ts +32 -170
  177. package/src/models/operations/getallteachers.ts +32 -170
  178. package/src/models/operations/getallusers.ts +32 -170
  179. package/src/models/operations/getclassesforuser.ts +20 -97
  180. package/src/models/operations/getresourcesforuser.ts +26 -127
  181. package/src/models/operations/getstudent.ts +26 -136
  182. package/src/models/operations/getstudentsforclass.ts +32 -180
  183. package/src/models/operations/getstudentsforclassinschool.ts +32 -188
  184. package/src/models/operations/getstudentsforschool.ts +32 -180
  185. package/src/models/operations/getteacher.ts +26 -136
  186. package/src/models/operations/getteachersforclass.ts +32 -180
  187. package/src/models/operations/getteachersforclassinschool.ts +32 -188
  188. package/src/models/operations/getteachersforschool.ts +32 -180
  189. package/src/models/operations/getuser.ts +26 -136
  190. package/src/models/operations/getuserwithdemographics.ts +26 -144
  191. package/src/models/operations/updateuser.ts +35 -238
  192. package/src/models/shared/enums.ts +567 -0
  193. package/src/models/shared/index.ts +8 -0
  194. package/test/classlink.test.ts +26 -26
@@ -2,22 +2,26 @@ import * as z from 'zod';
2
2
 
3
3
  import { remap as remap$ } from '../../lib/primitives.js';
4
4
  import { 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';
9
-
10
- /**
11
- * The order to sort the response by
12
- */
13
- export const GetStudentsForClassOrderBy = {
14
- Asc: 'asc',
15
- Desc: 'desc',
16
- } as const;
17
- /**
18
- * The order to sort the response by
19
- */
20
- export type GetStudentsForClassOrderBy = ClosedEnum<typeof GetStudentsForClassOrderBy>;
8
+ import {
9
+ EntityType,
10
+ EntityType$inboundSchema,
11
+ EntityType$outboundSchema,
12
+ OrderBy,
13
+ OrderBy$inboundSchema,
14
+ OrderBy$outboundSchema,
15
+ RoleType,
16
+ RoleType$inboundSchema,
17
+ RoleType$outboundSchema,
18
+ Status,
19
+ Status$inboundSchema,
20
+ Status$outboundSchema,
21
+ UserRole,
22
+ UserRole$inboundSchema,
23
+ UserRole$outboundSchema,
24
+ } from '../shared/enums.js';
21
25
 
22
26
  export type GetStudentsForClassRequest = {
23
27
  /**
@@ -43,7 +47,7 @@ export type GetStudentsForClassRequest = {
43
47
  /**
44
48
  * The order to sort the response by
45
49
  */
46
- orderBy?: GetStudentsForClassOrderBy | undefined;
50
+ orderBy?: OrderBy | undefined;
47
51
  /**
48
52
  * The filter to apply to the response
49
53
  */
@@ -54,35 +58,11 @@ export type GetStudentsForClassRequest = {
54
58
  search?: string | undefined;
55
59
  };
56
60
 
57
- export const GetStudentsForClassStatus = {
58
- Active: 'active',
59
- Tobedeleted: 'tobedeleted',
60
- } as const;
61
- export type GetStudentsForClassStatus = ClosedEnum<typeof GetStudentsForClassStatus>;
62
-
63
61
  export type GetStudentsForClassUserId = {
64
62
  type: string;
65
63
  identifier: string;
66
64
  };
67
65
 
68
- export const GetStudentsForClassRoleType = {
69
- Primary: 'primary',
70
- Secondary: 'secondary',
71
- } as const;
72
- export type GetStudentsForClassRoleType = ClosedEnum<typeof GetStudentsForClassRoleType>;
73
-
74
- export const GetStudentsForClassRoleEnum = {
75
- Administrator: 'administrator',
76
- Aide: 'aide',
77
- Guardian: 'guardian',
78
- Parent: 'parent',
79
- Proctor: 'proctor',
80
- Relative: 'relative',
81
- Student: 'student',
82
- Teacher: 'teacher',
83
- } as const;
84
- export type GetStudentsForClassRoleEnum = ClosedEnum<typeof GetStudentsForClassRoleEnum>;
85
-
86
66
  export type GetStudentsForClassOrg = {
87
67
  href: string;
88
68
  sourcedId: string;
@@ -90,41 +70,18 @@ export type GetStudentsForClassOrg = {
90
70
  };
91
71
 
92
72
  export type GetStudentsForClassRole = {
93
- roleType: GetStudentsForClassRoleType;
94
- role: GetStudentsForClassRoleEnum;
73
+ roleType: RoleType;
74
+ role: UserRole;
95
75
  org: GetStudentsForClassOrg;
96
76
  userProfile?: string | undefined;
97
77
  beginDate: string | null;
98
78
  endDate: string | null;
99
79
  };
100
80
 
101
- export const GetStudentsForClassType = {
102
- AcademicSession: 'academicSession',
103
- AssessmentLineItem: 'assessmentLineItem',
104
- Category: 'category',
105
- Class: 'class',
106
- Course: 'course',
107
- Demographics: 'demographics',
108
- Enrollment: 'enrollment',
109
- GradingPeriod: 'gradingPeriod',
110
- LineItem: 'lineItem',
111
- Org: 'org',
112
- Resource: 'resource',
113
- Result: 'result',
114
- ScoreScale: 'scoreScale',
115
- Student: 'student',
116
- Teacher: 'teacher',
117
- Term: 'term',
118
- User: 'user',
119
- ComponentResource: 'componentResource',
120
- CourseComponent: 'courseComponent',
121
- } as const;
122
- export type GetStudentsForClassType = ClosedEnum<typeof GetStudentsForClassType>;
123
-
124
81
  export type GetStudentsForClassAgent = {
125
82
  href: string;
126
83
  sourcedId: string;
127
- type: GetStudentsForClassType;
84
+ type: EntityType;
128
85
  };
129
86
 
130
87
  export type GetStudentsForClassPrimaryOrg = {
@@ -135,7 +92,7 @@ export type GetStudentsForClassPrimaryOrg = {
135
92
 
136
93
  export type GetStudentsForClassStudent = {
137
94
  sourcedId: string;
138
- status: GetStudentsForClassStatus;
95
+ status: Status;
139
96
  dateLastModified?: Date | undefined;
140
97
  metadata?: { [k: string]: any } | null | undefined;
141
98
  userMasterIdentifier?: string | null | undefined;
@@ -171,27 +128,6 @@ export type GetStudentsForClassResponse = {
171
128
  result: GetStudentsForClassResponseBody;
172
129
  };
173
130
 
174
- /** @internal */
175
- export const GetStudentsForClassOrderBy$inboundSchema: z.ZodNativeEnum<
176
- typeof GetStudentsForClassOrderBy
177
- > = z.nativeEnum(GetStudentsForClassOrderBy);
178
-
179
- /** @internal */
180
- export const GetStudentsForClassOrderBy$outboundSchema: z.ZodNativeEnum<
181
- typeof GetStudentsForClassOrderBy
182
- > = GetStudentsForClassOrderBy$inboundSchema;
183
-
184
- /**
185
- * @internal
186
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
187
- */
188
- export namespace GetStudentsForClassOrderBy$ {
189
- /** @deprecated use `GetStudentsForClassOrderBy$inboundSchema` instead. */
190
- export const inboundSchema = GetStudentsForClassOrderBy$inboundSchema;
191
- /** @deprecated use `GetStudentsForClassOrderBy$outboundSchema` instead. */
192
- export const outboundSchema = GetStudentsForClassOrderBy$outboundSchema;
193
- }
194
-
195
131
  /** @internal */
196
132
  export const GetStudentsForClassRequest$inboundSchema: z.ZodType<
197
133
  GetStudentsForClassRequest,
@@ -203,7 +139,7 @@ export const GetStudentsForClassRequest$inboundSchema: z.ZodType<
203
139
  limit: z.number().int().default(100),
204
140
  offset: z.number().int().default(0),
205
141
  sort: z.string().optional(),
206
- orderBy: GetStudentsForClassOrderBy$inboundSchema.optional(),
142
+ orderBy: OrderBy$inboundSchema.optional(),
207
143
  filter: z.string().optional(),
208
144
  search: z.string().optional(),
209
145
  });
@@ -231,7 +167,7 @@ export const GetStudentsForClassRequest$outboundSchema: z.ZodType<
231
167
  limit: z.number().int().default(100),
232
168
  offset: z.number().int().default(0),
233
169
  sort: z.string().optional(),
234
- orderBy: GetStudentsForClassOrderBy$outboundSchema.optional(),
170
+ orderBy: OrderBy$outboundSchema.optional(),
235
171
  filter: z.string().optional(),
236
172
  search: z.string().optional(),
237
173
  });
@@ -267,27 +203,6 @@ export function getStudentsForClassRequestFromJSON(
267
203
  );
268
204
  }
269
205
 
270
- /** @internal */
271
- export const GetStudentsForClassStatus$inboundSchema: z.ZodNativeEnum<
272
- typeof GetStudentsForClassStatus
273
- > = z.nativeEnum(GetStudentsForClassStatus);
274
-
275
- /** @internal */
276
- export const GetStudentsForClassStatus$outboundSchema: z.ZodNativeEnum<
277
- typeof GetStudentsForClassStatus
278
- > = GetStudentsForClassStatus$inboundSchema;
279
-
280
- /**
281
- * @internal
282
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
283
- */
284
- export namespace GetStudentsForClassStatus$ {
285
- /** @deprecated use `GetStudentsForClassStatus$inboundSchema` instead. */
286
- export const inboundSchema = GetStudentsForClassStatus$inboundSchema;
287
- /** @deprecated use `GetStudentsForClassStatus$outboundSchema` instead. */
288
- export const outboundSchema = GetStudentsForClassStatus$outboundSchema;
289
- }
290
-
291
206
  /** @internal */
292
207
  export const GetStudentsForClassUserId$inboundSchema: z.ZodType<
293
208
  GetStudentsForClassUserId,
@@ -345,48 +260,6 @@ export function getStudentsForClassUserIdFromJSON(
345
260
  );
346
261
  }
347
262
 
348
- /** @internal */
349
- export const GetStudentsForClassRoleType$inboundSchema: z.ZodNativeEnum<
350
- typeof GetStudentsForClassRoleType
351
- > = z.nativeEnum(GetStudentsForClassRoleType);
352
-
353
- /** @internal */
354
- export const GetStudentsForClassRoleType$outboundSchema: z.ZodNativeEnum<
355
- typeof GetStudentsForClassRoleType
356
- > = GetStudentsForClassRoleType$inboundSchema;
357
-
358
- /**
359
- * @internal
360
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
361
- */
362
- export namespace GetStudentsForClassRoleType$ {
363
- /** @deprecated use `GetStudentsForClassRoleType$inboundSchema` instead. */
364
- export const inboundSchema = GetStudentsForClassRoleType$inboundSchema;
365
- /** @deprecated use `GetStudentsForClassRoleType$outboundSchema` instead. */
366
- export const outboundSchema = GetStudentsForClassRoleType$outboundSchema;
367
- }
368
-
369
- /** @internal */
370
- export const GetStudentsForClassRoleEnum$inboundSchema: z.ZodNativeEnum<
371
- typeof GetStudentsForClassRoleEnum
372
- > = z.nativeEnum(GetStudentsForClassRoleEnum);
373
-
374
- /** @internal */
375
- export const GetStudentsForClassRoleEnum$outboundSchema: z.ZodNativeEnum<
376
- typeof GetStudentsForClassRoleEnum
377
- > = GetStudentsForClassRoleEnum$inboundSchema;
378
-
379
- /**
380
- * @internal
381
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
382
- */
383
- export namespace GetStudentsForClassRoleEnum$ {
384
- /** @deprecated use `GetStudentsForClassRoleEnum$inboundSchema` instead. */
385
- export const inboundSchema = GetStudentsForClassRoleEnum$inboundSchema;
386
- /** @deprecated use `GetStudentsForClassRoleEnum$outboundSchema` instead. */
387
- export const outboundSchema = GetStudentsForClassRoleEnum$outboundSchema;
388
- }
389
-
390
263
  /** @internal */
391
264
  export const GetStudentsForClassOrg$inboundSchema: z.ZodType<
392
265
  GetStudentsForClassOrg,
@@ -451,8 +324,8 @@ export const GetStudentsForClassRole$inboundSchema: z.ZodType<
451
324
  z.ZodTypeDef,
452
325
  unknown
453
326
  > = z.object({
454
- roleType: GetStudentsForClassRoleType$inboundSchema,
455
- role: GetStudentsForClassRoleEnum$inboundSchema,
327
+ roleType: RoleType$inboundSchema,
328
+ role: UserRole$inboundSchema,
456
329
  org: z.lazy(() => GetStudentsForClassOrg$inboundSchema),
457
330
  userProfile: z.string().optional(),
458
331
  beginDate: z.nullable(z.string()),
@@ -475,8 +348,8 @@ export const GetStudentsForClassRole$outboundSchema: z.ZodType<
475
348
  z.ZodTypeDef,
476
349
  GetStudentsForClassRole
477
350
  > = z.object({
478
- roleType: GetStudentsForClassRoleType$outboundSchema,
479
- role: GetStudentsForClassRoleEnum$outboundSchema,
351
+ roleType: RoleType$outboundSchema,
352
+ role: UserRole$outboundSchema,
480
353
  org: z.lazy(() => GetStudentsForClassOrg$outboundSchema),
481
354
  userProfile: z.string().optional(),
482
355
  beginDate: z.nullable(z.string()),
@@ -512,27 +385,6 @@ export function getStudentsForClassRoleFromJSON(
512
385
  );
513
386
  }
514
387
 
515
- /** @internal */
516
- export const GetStudentsForClassType$inboundSchema: z.ZodNativeEnum<
517
- typeof GetStudentsForClassType
518
- > = z.nativeEnum(GetStudentsForClassType);
519
-
520
- /** @internal */
521
- export const GetStudentsForClassType$outboundSchema: z.ZodNativeEnum<
522
- typeof GetStudentsForClassType
523
- > = GetStudentsForClassType$inboundSchema;
524
-
525
- /**
526
- * @internal
527
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
528
- */
529
- export namespace GetStudentsForClassType$ {
530
- /** @deprecated use `GetStudentsForClassType$inboundSchema` instead. */
531
- export const inboundSchema = GetStudentsForClassType$inboundSchema;
532
- /** @deprecated use `GetStudentsForClassType$outboundSchema` instead. */
533
- export const outboundSchema = GetStudentsForClassType$outboundSchema;
534
- }
535
-
536
388
  /** @internal */
537
389
  export const GetStudentsForClassAgent$inboundSchema: z.ZodType<
538
390
  GetStudentsForClassAgent,
@@ -541,7 +393,7 @@ export const GetStudentsForClassAgent$inboundSchema: z.ZodType<
541
393
  > = z.object({
542
394
  href: z.string(),
543
395
  sourcedId: z.string(),
544
- type: GetStudentsForClassType$inboundSchema,
396
+ type: EntityType$inboundSchema,
545
397
  });
546
398
 
547
399
  /** @internal */
@@ -559,7 +411,7 @@ export const GetStudentsForClassAgent$outboundSchema: z.ZodType<
559
411
  > = z.object({
560
412
  href: z.string(),
561
413
  sourcedId: z.string(),
562
- type: GetStudentsForClassType$outboundSchema,
414
+ type: EntityType$outboundSchema,
563
415
  });
564
416
 
565
417
  /**
@@ -658,7 +510,7 @@ export const GetStudentsForClassStudent$inboundSchema: z.ZodType<
658
510
  unknown
659
511
  > = z.object({
660
512
  sourcedId: z.string(),
661
- status: GetStudentsForClassStatus$inboundSchema,
513
+ status: Status$inboundSchema,
662
514
  dateLastModified: z
663
515
  .string()
664
516
  .datetime({ offset: true })
@@ -722,7 +574,7 @@ export const GetStudentsForClassStudent$outboundSchema: z.ZodType<
722
574
  GetStudentsForClassStudent
723
575
  > = z.object({
724
576
  sourcedId: z.string(),
725
- status: GetStudentsForClassStatus$outboundSchema,
577
+ status: Status$outboundSchema,
726
578
  dateLastModified: z
727
579
  .date()
728
580
  .transform((v) => v.toISOString())
@@ -2,24 +2,26 @@ import * as z from 'zod';
2
2
 
3
3
  import { remap as remap$ } from '../../lib/primitives.js';
4
4
  import { 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';
9
-
10
- /**
11
- * The order to sort the response by
12
- */
13
- export const GetStudentsForClassInSchoolOrderBy = {
14
- Asc: 'asc',
15
- Desc: 'desc',
16
- } as const;
17
- /**
18
- * The order to sort the response by
19
- */
20
- export type GetStudentsForClassInSchoolOrderBy = ClosedEnum<
21
- typeof GetStudentsForClassInSchoolOrderBy
22
- >;
8
+ import {
9
+ EntityType,
10
+ EntityType$inboundSchema,
11
+ EntityType$outboundSchema,
12
+ OrderBy,
13
+ OrderBy$inboundSchema,
14
+ OrderBy$outboundSchema,
15
+ RoleType,
16
+ RoleType$inboundSchema,
17
+ RoleType$outboundSchema,
18
+ Status,
19
+ Status$inboundSchema,
20
+ Status$outboundSchema,
21
+ UserRole,
22
+ UserRole$inboundSchema,
23
+ UserRole$outboundSchema,
24
+ } from '../shared/enums.js';
23
25
 
24
26
  export type GetStudentsForClassInSchoolRequest = {
25
27
  /**
@@ -49,7 +51,7 @@ export type GetStudentsForClassInSchoolRequest = {
49
51
  /**
50
52
  * The order to sort the response by
51
53
  */
52
- orderBy?: GetStudentsForClassInSchoolOrderBy | undefined;
54
+ orderBy?: OrderBy | undefined;
53
55
  /**
54
56
  * The filter to apply to the response
55
57
  */
@@ -60,41 +62,11 @@ export type GetStudentsForClassInSchoolRequest = {
60
62
  search?: string | undefined;
61
63
  };
62
64
 
63
- export const GetStudentsForClassInSchoolStatus = {
64
- Active: 'active',
65
- Tobedeleted: 'tobedeleted',
66
- } as const;
67
- export type GetStudentsForClassInSchoolStatus = ClosedEnum<
68
- typeof GetStudentsForClassInSchoolStatus
69
- >;
70
-
71
65
  export type GetStudentsForClassInSchoolUserId = {
72
66
  type: string;
73
67
  identifier: string;
74
68
  };
75
69
 
76
- export const GetStudentsForClassInSchoolRoleType = {
77
- Primary: 'primary',
78
- Secondary: 'secondary',
79
- } as const;
80
- export type GetStudentsForClassInSchoolRoleType = ClosedEnum<
81
- typeof GetStudentsForClassInSchoolRoleType
82
- >;
83
-
84
- export const GetStudentsForClassInSchoolRoleEnum = {
85
- Administrator: 'administrator',
86
- Aide: 'aide',
87
- Guardian: 'guardian',
88
- Parent: 'parent',
89
- Proctor: 'proctor',
90
- Relative: 'relative',
91
- Student: 'student',
92
- Teacher: 'teacher',
93
- } as const;
94
- export type GetStudentsForClassInSchoolRoleEnum = ClosedEnum<
95
- typeof GetStudentsForClassInSchoolRoleEnum
96
- >;
97
-
98
70
  export type GetStudentsForClassInSchoolOrg = {
99
71
  href: string;
100
72
  sourcedId: string;
@@ -102,41 +74,18 @@ export type GetStudentsForClassInSchoolOrg = {
102
74
  };
103
75
 
104
76
  export type GetStudentsForClassInSchoolRole = {
105
- roleType: GetStudentsForClassInSchoolRoleType;
106
- role: GetStudentsForClassInSchoolRoleEnum;
77
+ roleType: RoleType;
78
+ role: UserRole;
107
79
  org: GetStudentsForClassInSchoolOrg;
108
80
  userProfile?: string | undefined;
109
81
  beginDate: string | null;
110
82
  endDate: string | null;
111
83
  };
112
84
 
113
- export const GetStudentsForClassInSchoolType = {
114
- AcademicSession: 'academicSession',
115
- AssessmentLineItem: 'assessmentLineItem',
116
- Category: 'category',
117
- Class: 'class',
118
- Course: 'course',
119
- Demographics: 'demographics',
120
- Enrollment: 'enrollment',
121
- GradingPeriod: 'gradingPeriod',
122
- LineItem: 'lineItem',
123
- Org: 'org',
124
- Resource: 'resource',
125
- Result: 'result',
126
- ScoreScale: 'scoreScale',
127
- Student: 'student',
128
- Teacher: 'teacher',
129
- Term: 'term',
130
- User: 'user',
131
- ComponentResource: 'componentResource',
132
- CourseComponent: 'courseComponent',
133
- } as const;
134
- export type GetStudentsForClassInSchoolType = ClosedEnum<typeof GetStudentsForClassInSchoolType>;
135
-
136
85
  export type GetStudentsForClassInSchoolAgent = {
137
86
  href: string;
138
87
  sourcedId: string;
139
- type: GetStudentsForClassInSchoolType;
88
+ type: EntityType;
140
89
  };
141
90
 
142
91
  export type GetStudentsForClassInSchoolPrimaryOrg = {
@@ -147,7 +96,7 @@ export type GetStudentsForClassInSchoolPrimaryOrg = {
147
96
 
148
97
  export type GetStudentsForClassInSchoolUser = {
149
98
  sourcedId: string;
150
- status: GetStudentsForClassInSchoolStatus;
99
+ status: Status;
151
100
  dateLastModified?: Date | undefined;
152
101
  metadata?: { [k: string]: any } | null | undefined;
153
102
  userMasterIdentifier?: string | null | undefined;
@@ -183,27 +132,6 @@ export type GetStudentsForClassInSchoolResponse = {
183
132
  result: GetStudentsForClassInSchoolResponseBody;
184
133
  };
185
134
 
186
- /** @internal */
187
- export const GetStudentsForClassInSchoolOrderBy$inboundSchema: z.ZodNativeEnum<
188
- typeof GetStudentsForClassInSchoolOrderBy
189
- > = z.nativeEnum(GetStudentsForClassInSchoolOrderBy);
190
-
191
- /** @internal */
192
- export const GetStudentsForClassInSchoolOrderBy$outboundSchema: z.ZodNativeEnum<
193
- typeof GetStudentsForClassInSchoolOrderBy
194
- > = GetStudentsForClassInSchoolOrderBy$inboundSchema;
195
-
196
- /**
197
- * @internal
198
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
199
- */
200
- export namespace GetStudentsForClassInSchoolOrderBy$ {
201
- /** @deprecated use `GetStudentsForClassInSchoolOrderBy$inboundSchema` instead. */
202
- export const inboundSchema = GetStudentsForClassInSchoolOrderBy$inboundSchema;
203
- /** @deprecated use `GetStudentsForClassInSchoolOrderBy$outboundSchema` instead. */
204
- export const outboundSchema = GetStudentsForClassInSchoolOrderBy$outboundSchema;
205
- }
206
-
207
135
  /** @internal */
208
136
  export const GetStudentsForClassInSchoolRequest$inboundSchema: z.ZodType<
209
137
  GetStudentsForClassInSchoolRequest,
@@ -216,7 +144,7 @@ export const GetStudentsForClassInSchoolRequest$inboundSchema: z.ZodType<
216
144
  limit: z.number().int().default(100),
217
145
  offset: z.number().int().default(0),
218
146
  sort: z.string().optional(),
219
- orderBy: GetStudentsForClassInSchoolOrderBy$inboundSchema.optional(),
147
+ orderBy: OrderBy$inboundSchema.optional(),
220
148
  filter: z.string().optional(),
221
149
  search: z.string().optional(),
222
150
  });
@@ -246,7 +174,7 @@ export const GetStudentsForClassInSchoolRequest$outboundSchema: z.ZodType<
246
174
  limit: z.number().int().default(100),
247
175
  offset: z.number().int().default(0),
248
176
  sort: z.string().optional(),
249
- orderBy: GetStudentsForClassInSchoolOrderBy$outboundSchema.optional(),
177
+ orderBy: OrderBy$outboundSchema.optional(),
250
178
  filter: z.string().optional(),
251
179
  search: z.string().optional(),
252
180
  });
@@ -282,27 +210,6 @@ export function getStudentsForClassInSchoolRequestFromJSON(
282
210
  );
283
211
  }
284
212
 
285
- /** @internal */
286
- export const GetStudentsForClassInSchoolStatus$inboundSchema: z.ZodNativeEnum<
287
- typeof GetStudentsForClassInSchoolStatus
288
- > = z.nativeEnum(GetStudentsForClassInSchoolStatus);
289
-
290
- /** @internal */
291
- export const GetStudentsForClassInSchoolStatus$outboundSchema: z.ZodNativeEnum<
292
- typeof GetStudentsForClassInSchoolStatus
293
- > = GetStudentsForClassInSchoolStatus$inboundSchema;
294
-
295
- /**
296
- * @internal
297
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
298
- */
299
- export namespace GetStudentsForClassInSchoolStatus$ {
300
- /** @deprecated use `GetStudentsForClassInSchoolStatus$inboundSchema` instead. */
301
- export const inboundSchema = GetStudentsForClassInSchoolStatus$inboundSchema;
302
- /** @deprecated use `GetStudentsForClassInSchoolStatus$outboundSchema` instead. */
303
- export const outboundSchema = GetStudentsForClassInSchoolStatus$outboundSchema;
304
- }
305
-
306
213
  /** @internal */
307
214
  export const GetStudentsForClassInSchoolUserId$inboundSchema: z.ZodType<
308
215
  GetStudentsForClassInSchoolUserId,
@@ -360,48 +267,6 @@ export function getStudentsForClassInSchoolUserIdFromJSON(
360
267
  );
361
268
  }
362
269
 
363
- /** @internal */
364
- export const GetStudentsForClassInSchoolRoleType$inboundSchema: z.ZodNativeEnum<
365
- typeof GetStudentsForClassInSchoolRoleType
366
- > = z.nativeEnum(GetStudentsForClassInSchoolRoleType);
367
-
368
- /** @internal */
369
- export const GetStudentsForClassInSchoolRoleType$outboundSchema: z.ZodNativeEnum<
370
- typeof GetStudentsForClassInSchoolRoleType
371
- > = GetStudentsForClassInSchoolRoleType$inboundSchema;
372
-
373
- /**
374
- * @internal
375
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
376
- */
377
- export namespace GetStudentsForClassInSchoolRoleType$ {
378
- /** @deprecated use `GetStudentsForClassInSchoolRoleType$inboundSchema` instead. */
379
- export const inboundSchema = GetStudentsForClassInSchoolRoleType$inboundSchema;
380
- /** @deprecated use `GetStudentsForClassInSchoolRoleType$outboundSchema` instead. */
381
- export const outboundSchema = GetStudentsForClassInSchoolRoleType$outboundSchema;
382
- }
383
-
384
- /** @internal */
385
- export const GetStudentsForClassInSchoolRoleEnum$inboundSchema: z.ZodNativeEnum<
386
- typeof GetStudentsForClassInSchoolRoleEnum
387
- > = z.nativeEnum(GetStudentsForClassInSchoolRoleEnum);
388
-
389
- /** @internal */
390
- export const GetStudentsForClassInSchoolRoleEnum$outboundSchema: z.ZodNativeEnum<
391
- typeof GetStudentsForClassInSchoolRoleEnum
392
- > = GetStudentsForClassInSchoolRoleEnum$inboundSchema;
393
-
394
- /**
395
- * @internal
396
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
397
- */
398
- export namespace GetStudentsForClassInSchoolRoleEnum$ {
399
- /** @deprecated use `GetStudentsForClassInSchoolRoleEnum$inboundSchema` instead. */
400
- export const inboundSchema = GetStudentsForClassInSchoolRoleEnum$inboundSchema;
401
- /** @deprecated use `GetStudentsForClassInSchoolRoleEnum$outboundSchema` instead. */
402
- export const outboundSchema = GetStudentsForClassInSchoolRoleEnum$outboundSchema;
403
- }
404
-
405
270
  /** @internal */
406
271
  export const GetStudentsForClassInSchoolOrg$inboundSchema: z.ZodType<
407
272
  GetStudentsForClassInSchoolOrg,
@@ -468,8 +333,8 @@ export const GetStudentsForClassInSchoolRole$inboundSchema: z.ZodType<
468
333
  z.ZodTypeDef,
469
334
  unknown
470
335
  > = z.object({
471
- roleType: GetStudentsForClassInSchoolRoleType$inboundSchema,
472
- role: GetStudentsForClassInSchoolRoleEnum$inboundSchema,
336
+ roleType: RoleType$inboundSchema,
337
+ role: UserRole$inboundSchema,
473
338
  org: z.lazy(() => GetStudentsForClassInSchoolOrg$inboundSchema),
474
339
  userProfile: z.string().optional(),
475
340
  beginDate: z.nullable(z.string()),
@@ -492,8 +357,8 @@ export const GetStudentsForClassInSchoolRole$outboundSchema: z.ZodType<
492
357
  z.ZodTypeDef,
493
358
  GetStudentsForClassInSchoolRole
494
359
  > = z.object({
495
- roleType: GetStudentsForClassInSchoolRoleType$outboundSchema,
496
- role: GetStudentsForClassInSchoolRoleEnum$outboundSchema,
360
+ roleType: RoleType$outboundSchema,
361
+ role: UserRole$outboundSchema,
497
362
  org: z.lazy(() => GetStudentsForClassInSchoolOrg$outboundSchema),
498
363
  userProfile: z.string().optional(),
499
364
  beginDate: z.nullable(z.string()),
@@ -531,27 +396,6 @@ export function getStudentsForClassInSchoolRoleFromJSON(
531
396
  );
532
397
  }
533
398
 
534
- /** @internal */
535
- export const GetStudentsForClassInSchoolType$inboundSchema: z.ZodNativeEnum<
536
- typeof GetStudentsForClassInSchoolType
537
- > = z.nativeEnum(GetStudentsForClassInSchoolType);
538
-
539
- /** @internal */
540
- export const GetStudentsForClassInSchoolType$outboundSchema: z.ZodNativeEnum<
541
- typeof GetStudentsForClassInSchoolType
542
- > = GetStudentsForClassInSchoolType$inboundSchema;
543
-
544
- /**
545
- * @internal
546
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
547
- */
548
- export namespace GetStudentsForClassInSchoolType$ {
549
- /** @deprecated use `GetStudentsForClassInSchoolType$inboundSchema` instead. */
550
- export const inboundSchema = GetStudentsForClassInSchoolType$inboundSchema;
551
- /** @deprecated use `GetStudentsForClassInSchoolType$outboundSchema` instead. */
552
- export const outboundSchema = GetStudentsForClassInSchoolType$outboundSchema;
553
- }
554
-
555
399
  /** @internal */
556
400
  export const GetStudentsForClassInSchoolAgent$inboundSchema: z.ZodType<
557
401
  GetStudentsForClassInSchoolAgent,
@@ -560,7 +404,7 @@ export const GetStudentsForClassInSchoolAgent$inboundSchema: z.ZodType<
560
404
  > = z.object({
561
405
  href: z.string(),
562
406
  sourcedId: z.string(),
563
- type: GetStudentsForClassInSchoolType$inboundSchema,
407
+ type: EntityType$inboundSchema,
564
408
  });
565
409
 
566
410
  /** @internal */
@@ -578,7 +422,7 @@ export const GetStudentsForClassInSchoolAgent$outboundSchema: z.ZodType<
578
422
  > = z.object({
579
423
  href: z.string(),
580
424
  sourcedId: z.string(),
581
- type: GetStudentsForClassInSchoolType$outboundSchema,
425
+ type: EntityType$outboundSchema,
582
426
  });
583
427
 
584
428
  /**
@@ -681,7 +525,7 @@ export const GetStudentsForClassInSchoolUser$inboundSchema: z.ZodType<
681
525
  unknown
682
526
  > = z.object({
683
527
  sourcedId: z.string(),
684
- status: GetStudentsForClassInSchoolStatus$inboundSchema,
528
+ status: Status$inboundSchema,
685
529
  dateLastModified: z
686
530
  .string()
687
531
  .datetime({ offset: true })
@@ -745,7 +589,7 @@ export const GetStudentsForClassInSchoolUser$outboundSchema: z.ZodType<
745
589
  GetStudentsForClassInSchoolUser
746
590
  > = z.object({
747
591
  sourcedId: z.string(),
748
- status: GetStudentsForClassInSchoolStatus$outboundSchema,
592
+ status: Status$outboundSchema,
749
593
  dateLastModified: z
750
594
  .date()
751
595
  .transform((v) => v.toISOString())