@eduware/oneroster 1.2.4 → 1.2.6

package/src/models/operations/getstudentsforschool.ts

@@ -2,22 +2,26 @@ import * as z from 'zod';
 
 import { remap as remap$ } from '../../lib/primitives.js';
 import { safeParse } from '../../lib/schemas.js';
-import { ClosedEnum } from '../../types/enums.js';
 import { Result as SafeParseResult } from '../../types/fp.js';
 import * as components from '../components/index.js';
 import { SDKValidationError } from '../errors/sdkvalidationerror.js';
-
-/**
- * The order to sort the response by
- */
-export const GetStudentsForSchoolOrderBy = {
-    Asc: 'asc',
-    Desc: 'desc',
-} as const;
-/**
- * The order to sort the response by
- */
-export type GetStudentsForSchoolOrderBy = ClosedEnum<typeof GetStudentsForSchoolOrderBy>;
+import {
+    EntityType,
+    EntityType$inboundSchema,
+    EntityType$outboundSchema,
+    OrderBy,
+    OrderBy$inboundSchema,
+    OrderBy$outboundSchema,
+    RoleType,
+    RoleType$inboundSchema,
+    RoleType$outboundSchema,
+    Status,
+    Status$inboundSchema,
+    Status$outboundSchema,
+    UserRole,
+    UserRole$inboundSchema,
+    UserRole$outboundSchema,
+} from '../shared/enums.js';
 
 export type GetStudentsForSchoolRequest = {
     /**
@@ -43,7 +47,7 @@ export type GetStudentsForSchoolRequest = {
     /**
      * The order to sort the response by
      */
-    orderBy?: GetStudentsForSchoolOrderBy | undefined;
+    orderBy?: OrderBy | undefined;
     /**
      * The filter to apply to the response
      */
@@ -54,35 +58,11 @@ export type GetStudentsForSchoolRequest = {
     search?: string | undefined;
 };
 
-export const GetStudentsForSchoolStatus = {
-    Active: 'active',
-    Tobedeleted: 'tobedeleted',
-} as const;
-export type GetStudentsForSchoolStatus = ClosedEnum<typeof GetStudentsForSchoolStatus>;
-
 export type GetStudentsForSchoolUserId = {
     type: string;
     identifier: string;
 };
 
-export const GetStudentsForSchoolRoleType = {
-    Primary: 'primary',
-    Secondary: 'secondary',
-} as const;
-export type GetStudentsForSchoolRoleType = ClosedEnum<typeof GetStudentsForSchoolRoleType>;
-
-export const GetStudentsForSchoolRoleEnum = {
-    Administrator: 'administrator',
-    Aide: 'aide',
-    Guardian: 'guardian',
-    Parent: 'parent',
-    Proctor: 'proctor',
-    Relative: 'relative',
-    Student: 'student',
-    Teacher: 'teacher',
-} as const;
-export type GetStudentsForSchoolRoleEnum = ClosedEnum<typeof GetStudentsForSchoolRoleEnum>;
-
 export type GetStudentsForSchoolOrg = {
     href: string;
     sourcedId: string;
@@ -90,41 +70,18 @@ export type GetStudentsForSchoolOrg = {
 };
 
 export type GetStudentsForSchoolRole = {
-    roleType: GetStudentsForSchoolRoleType;
-    role: GetStudentsForSchoolRoleEnum;
+    roleType: RoleType;
+    role: UserRole;
     org: GetStudentsForSchoolOrg;
     userProfile?: string | undefined;
     beginDate: string | null;
     endDate: string | null;
 };
 
-export const GetStudentsForSchoolType = {
-    AcademicSession: 'academicSession',
-    AssessmentLineItem: 'assessmentLineItem',
-    Category: 'category',
-    Class: 'class',
-    Course: 'course',
-    Demographics: 'demographics',
-    Enrollment: 'enrollment',
-    GradingPeriod: 'gradingPeriod',
-    LineItem: 'lineItem',
-    Org: 'org',
-    Resource: 'resource',
-    Result: 'result',
-    ScoreScale: 'scoreScale',
-    Student: 'student',
-    Teacher: 'teacher',
-    Term: 'term',
-    User: 'user',
-    ComponentResource: 'componentResource',
-    CourseComponent: 'courseComponent',
-} as const;
-export type GetStudentsForSchoolType = ClosedEnum<typeof GetStudentsForSchoolType>;
-
 export type GetStudentsForSchoolAgent = {
     href: string;
     sourcedId: string;
-    type: GetStudentsForSchoolType;
+    type: EntityType;
 };
 
 export type GetStudentsForSchoolPrimaryOrg = {
@@ -135,7 +92,7 @@ export type GetStudentsForSchoolPrimaryOrg = {
 
 export type GetStudentsForSchoolUser = {
     sourcedId: string;
-    status: GetStudentsForSchoolStatus;
+    status: Status;
     dateLastModified?: Date | undefined;
     metadata?: { [k: string]: any } | null | undefined;
     userMasterIdentifier?: string | null | undefined;
@@ -171,27 +128,6 @@ export type GetStudentsForSchoolResponse = {
     result: GetStudentsForSchoolResponseBody;
 };
 
-/** @internal */
-export const GetStudentsForSchoolOrderBy$inboundSchema: z.ZodNativeEnum<
-    typeof GetStudentsForSchoolOrderBy
-> = z.nativeEnum(GetStudentsForSchoolOrderBy);
-
-/** @internal */
-export const GetStudentsForSchoolOrderBy$outboundSchema: z.ZodNativeEnum<
-    typeof GetStudentsForSchoolOrderBy
-> = GetStudentsForSchoolOrderBy$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetStudentsForSchoolOrderBy$ {
-    /** @deprecated use `GetStudentsForSchoolOrderBy$inboundSchema` instead. */
-    export const inboundSchema = GetStudentsForSchoolOrderBy$inboundSchema;
-    /** @deprecated use `GetStudentsForSchoolOrderBy$outboundSchema` instead. */
-    export const outboundSchema = GetStudentsForSchoolOrderBy$outboundSchema;
-}
-
 /** @internal */
 export const GetStudentsForSchoolRequest$inboundSchema: z.ZodType<
     GetStudentsForSchoolRequest,
@@ -203,7 +139,7 @@ export const GetStudentsForSchoolRequest$inboundSchema: z.ZodType<
     limit: z.number().int().default(100),
     offset: z.number().int().default(0),
     sort: z.string().optional(),
-    orderBy: GetStudentsForSchoolOrderBy$inboundSchema.optional(),
+    orderBy: OrderBy$inboundSchema.optional(),
     filter: z.string().optional(),
     search: z.string().optional(),
 });
@@ -231,7 +167,7 @@ export const GetStudentsForSchoolRequest$outboundSchema: z.ZodType<
     limit: z.number().int().default(100),
     offset: z.number().int().default(0),
     sort: z.string().optional(),
-    orderBy: GetStudentsForSchoolOrderBy$outboundSchema.optional(),
+    orderBy: OrderBy$outboundSchema.optional(),
     filter: z.string().optional(),
     search: z.string().optional(),
 });
@@ -267,27 +203,6 @@ export function getStudentsForSchoolRequestFromJSON(
     );
 }
 
-/** @internal */
-export const GetStudentsForSchoolStatus$inboundSchema: z.ZodNativeEnum<
-    typeof GetStudentsForSchoolStatus
-> = z.nativeEnum(GetStudentsForSchoolStatus);
-
-/** @internal */
-export const GetStudentsForSchoolStatus$outboundSchema: z.ZodNativeEnum<
-    typeof GetStudentsForSchoolStatus
-> = GetStudentsForSchoolStatus$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetStudentsForSchoolStatus$ {
-    /** @deprecated use `GetStudentsForSchoolStatus$inboundSchema` instead. */
-    export const inboundSchema = GetStudentsForSchoolStatus$inboundSchema;
-    /** @deprecated use `GetStudentsForSchoolStatus$outboundSchema` instead. */
-    export const outboundSchema = GetStudentsForSchoolStatus$outboundSchema;
-}
-
 /** @internal */
 export const GetStudentsForSchoolUserId$inboundSchema: z.ZodType<
     GetStudentsForSchoolUserId,
@@ -345,48 +260,6 @@ export function getStudentsForSchoolUserIdFromJSON(
     );
 }
 
-/** @internal */
-export const GetStudentsForSchoolRoleType$inboundSchema: z.ZodNativeEnum<
-    typeof GetStudentsForSchoolRoleType
-> = z.nativeEnum(GetStudentsForSchoolRoleType);
-
-/** @internal */
-export const GetStudentsForSchoolRoleType$outboundSchema: z.ZodNativeEnum<
-    typeof GetStudentsForSchoolRoleType
-> = GetStudentsForSchoolRoleType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetStudentsForSchoolRoleType$ {
-    /** @deprecated use `GetStudentsForSchoolRoleType$inboundSchema` instead. */
-    export const inboundSchema = GetStudentsForSchoolRoleType$inboundSchema;
-    /** @deprecated use `GetStudentsForSchoolRoleType$outboundSchema` instead. */
-    export const outboundSchema = GetStudentsForSchoolRoleType$outboundSchema;
-}
-
-/** @internal */
-export const GetStudentsForSchoolRoleEnum$inboundSchema: z.ZodNativeEnum<
-    typeof GetStudentsForSchoolRoleEnum
-> = z.nativeEnum(GetStudentsForSchoolRoleEnum);
-
-/** @internal */
-export const GetStudentsForSchoolRoleEnum$outboundSchema: z.ZodNativeEnum<
-    typeof GetStudentsForSchoolRoleEnum
-> = GetStudentsForSchoolRoleEnum$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetStudentsForSchoolRoleEnum$ {
-    /** @deprecated use `GetStudentsForSchoolRoleEnum$inboundSchema` instead. */
-    export const inboundSchema = GetStudentsForSchoolRoleEnum$inboundSchema;
-    /** @deprecated use `GetStudentsForSchoolRoleEnum$outboundSchema` instead. */
-    export const outboundSchema = GetStudentsForSchoolRoleEnum$outboundSchema;
-}
-
 /** @internal */
 export const GetStudentsForSchoolOrg$inboundSchema: z.ZodType<
     GetStudentsForSchoolOrg,
@@ -451,8 +324,8 @@ export const GetStudentsForSchoolRole$inboundSchema: z.ZodType<
     z.ZodTypeDef,
     unknown
 > = z.object({
-    roleType: GetStudentsForSchoolRoleType$inboundSchema,
-    role: GetStudentsForSchoolRoleEnum$inboundSchema,
+        roleType: RoleType$inboundSchema,
+        role: UserRole$inboundSchema,
     org: z.lazy(() => GetStudentsForSchoolOrg$inboundSchema),
     userProfile: z.string().optional(),
     beginDate: z.nullable(z.string()),
@@ -475,8 +348,8 @@ export const GetStudentsForSchoolRole$outboundSchema: z.ZodType<
     z.ZodTypeDef,
     GetStudentsForSchoolRole
 > = z.object({
-    roleType: GetStudentsForSchoolRoleType$outboundSchema,
-    role: GetStudentsForSchoolRoleEnum$outboundSchema,
+    roleType: RoleType$outboundSchema,
+    role: UserRole$outboundSchema,
     org: z.lazy(() => GetStudentsForSchoolOrg$outboundSchema),
     userProfile: z.string().optional(),
     beginDate: z.nullable(z.string()),
@@ -512,27 +385,6 @@ export function getStudentsForSchoolRoleFromJSON(
     );
 }
 
-/** @internal */
-export const GetStudentsForSchoolType$inboundSchema: z.ZodNativeEnum<
-    typeof GetStudentsForSchoolType
-> = z.nativeEnum(GetStudentsForSchoolType);
-
-/** @internal */
-export const GetStudentsForSchoolType$outboundSchema: z.ZodNativeEnum<
-    typeof GetStudentsForSchoolType
-> = GetStudentsForSchoolType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetStudentsForSchoolType$ {
-    /** @deprecated use `GetStudentsForSchoolType$inboundSchema` instead. */
-    export const inboundSchema = GetStudentsForSchoolType$inboundSchema;
-    /** @deprecated use `GetStudentsForSchoolType$outboundSchema` instead. */
-    export const outboundSchema = GetStudentsForSchoolType$outboundSchema;
-}
-
 /** @internal */
 export const GetStudentsForSchoolAgent$inboundSchema: z.ZodType<
     GetStudentsForSchoolAgent,
@@ -541,7 +393,7 @@ export const GetStudentsForSchoolAgent$inboundSchema: z.ZodType<
 > = z.object({
     href: z.string(),
     sourcedId: z.string(),
-    type: GetStudentsForSchoolType$inboundSchema,
+    type: EntityType$inboundSchema,
 });
 
 /** @internal */
@@ -559,7 +411,7 @@ export const GetStudentsForSchoolAgent$outboundSchema: z.ZodType<
 > = z.object({
     href: z.string(),
     sourcedId: z.string(),
-    type: GetStudentsForSchoolType$outboundSchema,
+    type: EntityType$outboundSchema,
 });
 
 /**
@@ -660,7 +512,7 @@ export const GetStudentsForSchoolUser$inboundSchema: z.ZodType<
     unknown
 > = z.object({
     sourcedId: z.string(),
-    status: GetStudentsForSchoolStatus$inboundSchema,
+        status: Status$inboundSchema,
     dateLastModified: z
         .string()
         .datetime({ offset: true })
@@ -724,7 +576,7 @@ export const GetStudentsForSchoolUser$outboundSchema: z.ZodType<
     GetStudentsForSchoolUser
 > = z.object({
     sourcedId: z.string(),
-    status: GetStudentsForSchoolStatus$outboundSchema,
+    status: Status$outboundSchema,
     dateLastModified: z
         .date()
         .transform((v) => v.toISOString())

package/src/models/operations/getteacher.ts

@@ -1,10 +1,23 @@
 import * as z from 'zod';
 
 import { safeParse } from '../../lib/schemas.js';
-import { ClosedEnum } from '../../types/enums.js';
 import { Result as SafeParseResult } from '../../types/fp.js';
 import * as components from '../components/index.js';
 import { SDKValidationError } from '../errors/sdkvalidationerror.js';
+import {
+    EntityType,
+    EntityType$inboundSchema,
+    EntityType$outboundSchema,
+    RoleType,
+    RoleType$inboundSchema,
+    RoleType$outboundSchema,
+    Status,
+    Status$inboundSchema,
+    Status$outboundSchema,
+    UserRole,
+    UserRole$inboundSchema,
+    UserRole$outboundSchema,
+} from '../shared/enums.js';
 
 export type GetTeacherRequest = {
     /**
@@ -13,35 +26,11 @@ export type GetTeacherRequest = {
     sourcedId: string;
 };
 
-export const GetTeacherStatus = {
-    Active: 'active',
-    Tobedeleted: 'tobedeleted',
-} as const;
-export type GetTeacherStatus = ClosedEnum<typeof GetTeacherStatus>;
-
 export type GetTeacherUserId = {
     type: string;
     identifier: string;
 };
 
-export const GetTeacherRoleType = {
-    Primary: 'primary',
-    Secondary: 'secondary',
-} as const;
-export type GetTeacherRoleType = ClosedEnum<typeof GetTeacherRoleType>;
-
-export const GetTeacherRoleEnum = {
-    Administrator: 'administrator',
-    Aide: 'aide',
-    Guardian: 'guardian',
-    Parent: 'parent',
-    Proctor: 'proctor',
-    Relative: 'relative',
-    Student: 'student',
-    Teacher: 'teacher',
-} as const;
-export type GetTeacherRoleEnum = ClosedEnum<typeof GetTeacherRoleEnum>;
-
 export type GetTeacherOrg = {
     href: string;
     sourcedId: string;
@@ -49,41 +38,18 @@ export type GetTeacherOrg = {
 };
 
 export type GetTeacherRole = {
-    roleType: GetTeacherRoleType;
-    role: GetTeacherRoleEnum;
+    roleType: RoleType;
+    role: UserRole;
     org: GetTeacherOrg;
     userProfile?: string | undefined;
     beginDate: string | null;
     endDate: string | null;
 };
 
-export const GetTeacherType = {
-    AcademicSession: 'academicSession',
-    AssessmentLineItem: 'assessmentLineItem',
-    Category: 'category',
-    Class: 'class',
-    Course: 'course',
-    Demographics: 'demographics',
-    Enrollment: 'enrollment',
-    GradingPeriod: 'gradingPeriod',
-    LineItem: 'lineItem',
-    Org: 'org',
-    Resource: 'resource',
-    Result: 'result',
-    ScoreScale: 'scoreScale',
-    Student: 'student',
-    Teacher: 'teacher',
-    Term: 'term',
-    User: 'user',
-    ComponentResource: 'componentResource',
-    CourseComponent: 'courseComponent',
-} as const;
-export type GetTeacherType = ClosedEnum<typeof GetTeacherType>;
-
 export type GetTeacherAgent = {
     href: string;
     sourcedId: string;
-    type: GetTeacherType;
+    type: EntityType;
 };
 
 export type GetTeacherPrimaryOrg = {
@@ -94,7 +60,7 @@ export type GetTeacherPrimaryOrg = {
 
 export type GetTeacherUser = {
     sourcedId: string;
-    status: GetTeacherStatus;
+    status: Status;
     dateLastModified?: Date | undefined;
     metadata?: { [k: string]: any } | null | undefined;
     userMasterIdentifier?: string | null | undefined;
@@ -173,25 +139,6 @@ export function getTeacherRequestFromJSON(
     );
 }
 
-/** @internal */
-export const GetTeacherStatus$inboundSchema: z.ZodNativeEnum<typeof GetTeacherStatus> =
-    z.nativeEnum(GetTeacherStatus);
-
-/** @internal */
-export const GetTeacherStatus$outboundSchema: z.ZodNativeEnum<typeof GetTeacherStatus> =
-    GetTeacherStatus$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetTeacherStatus$ {
-    /** @deprecated use `GetTeacherStatus$inboundSchema` instead. */
-    export const inboundSchema = GetTeacherStatus$inboundSchema;
-    /** @deprecated use `GetTeacherStatus$outboundSchema` instead. */
-    export const outboundSchema = GetTeacherStatus$outboundSchema;
-}
-
 /** @internal */
 export const GetTeacherUserId$inboundSchema: z.ZodType<GetTeacherUserId, z.ZodTypeDef, unknown> =
     z.object({
@@ -242,44 +189,6 @@ export function getTeacherUserIdFromJSON(
     );
 }
 
-/** @internal */
-export const GetTeacherRoleType$inboundSchema: z.ZodNativeEnum<typeof GetTeacherRoleType> =
-    z.nativeEnum(GetTeacherRoleType);
-
-/** @internal */
-export const GetTeacherRoleType$outboundSchema: z.ZodNativeEnum<typeof GetTeacherRoleType> =
-    GetTeacherRoleType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetTeacherRoleType$ {
-    /** @deprecated use `GetTeacherRoleType$inboundSchema` instead. */
-    export const inboundSchema = GetTeacherRoleType$inboundSchema;
-    /** @deprecated use `GetTeacherRoleType$outboundSchema` instead. */
-    export const outboundSchema = GetTeacherRoleType$outboundSchema;
-}
-
-/** @internal */
-export const GetTeacherRoleEnum$inboundSchema: z.ZodNativeEnum<typeof GetTeacherRoleEnum> =
-    z.nativeEnum(GetTeacherRoleEnum);
-
-/** @internal */
-export const GetTeacherRoleEnum$outboundSchema: z.ZodNativeEnum<typeof GetTeacherRoleEnum> =
-    GetTeacherRoleEnum$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetTeacherRoleEnum$ {
-    /** @deprecated use `GetTeacherRoleEnum$inboundSchema` instead. */
-    export const inboundSchema = GetTeacherRoleEnum$inboundSchema;
-    /** @deprecated use `GetTeacherRoleEnum$outboundSchema` instead. */
-    export const outboundSchema = GetTeacherRoleEnum$outboundSchema;
-}
-
 /** @internal */
 export const GetTeacherOrg$inboundSchema: z.ZodType<GetTeacherOrg, z.ZodTypeDef, unknown> =
     z.object({
@@ -336,8 +245,8 @@ export function getTeacherOrgFromJSON(
 /** @internal */
 export const GetTeacherRole$inboundSchema: z.ZodType<GetTeacherRole, z.ZodTypeDef, unknown> =
     z.object({
-        roleType: GetTeacherRoleType$inboundSchema,
-        role: GetTeacherRoleEnum$inboundSchema,
+        roleType: RoleType$inboundSchema,
+        role: UserRole$inboundSchema,
         org: z.lazy(() => GetTeacherOrg$inboundSchema),
         userProfile: z.string().optional(),
         beginDate: z.nullable(z.string()),
@@ -360,8 +269,8 @@ export const GetTeacherRole$outboundSchema: z.ZodType<
     z.ZodTypeDef,
     GetTeacherRole
 > = z.object({
-    roleType: GetTeacherRoleType$outboundSchema,
-    role: GetTeacherRoleEnum$outboundSchema,
+    roleType: RoleType$outboundSchema,
+    role: UserRole$outboundSchema,
     org: z.lazy(() => GetTeacherOrg$outboundSchema),
     userProfile: z.string().optional(),
     beginDate: z.nullable(z.string()),
@@ -395,31 +304,12 @@ export function getTeacherRoleFromJSON(
     );
 }
 
-/** @internal */
-export const GetTeacherType$inboundSchema: z.ZodNativeEnum<typeof GetTeacherType> =
-    z.nativeEnum(GetTeacherType);
-
-/** @internal */
-export const GetTeacherType$outboundSchema: z.ZodNativeEnum<typeof GetTeacherType> =
-    GetTeacherType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetTeacherType$ {
-    /** @deprecated use `GetTeacherType$inboundSchema` instead. */
-    export const inboundSchema = GetTeacherType$inboundSchema;
-    /** @deprecated use `GetTeacherType$outboundSchema` instead. */
-    export const outboundSchema = GetTeacherType$outboundSchema;
-}
-
 /** @internal */
 export const GetTeacherAgent$inboundSchema: z.ZodType<GetTeacherAgent, z.ZodTypeDef, unknown> =
     z.object({
         href: z.string(),
         sourcedId: z.string(),
-        type: GetTeacherType$inboundSchema,
+        type: EntityType$inboundSchema,
     });
 
 /** @internal */
@@ -437,7 +327,7 @@ export const GetTeacherAgent$outboundSchema: z.ZodType<
 > = z.object({
     href: z.string(),
     sourcedId: z.string(),
-    type: GetTeacherType$outboundSchema,
+    type: EntityType$outboundSchema,
 });
 
 /**
@@ -527,7 +417,7 @@ export function getTeacherPrimaryOrgFromJSON(
 export const GetTeacherUser$inboundSchema: z.ZodType<GetTeacherUser, z.ZodTypeDef, unknown> =
     z.object({
         sourcedId: z.string(),
-        status: GetTeacherStatus$inboundSchema,
+        status: Status$inboundSchema,
         dateLastModified: z
             .string()
             .datetime({ offset: true })
@@ -591,7 +481,7 @@ export const GetTeacherUser$outboundSchema: z.ZodType<
     GetTeacherUser
 > = z.object({
     sourcedId: z.string(),
-    status: GetTeacherStatus$outboundSchema,
+    status: Status$outboundSchema,
     dateLastModified: z
         .date()
         .transform((v) => v.toISOString())