@eduware/oneroster 1.2.4 → 1.2.6

package/src/models/operations/getteachersforschool.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 GetTeachersForSchoolOrderBy = {
-    Asc: 'asc',
-    Desc: 'desc',
-} as const;
-/**
- * The order to sort the response by
- */
-export type GetTeachersForSchoolOrderBy = ClosedEnum<typeof GetTeachersForSchoolOrderBy>;
+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 GetTeachersForSchoolRequest = {
     /**
@@ -43,7 +47,7 @@ export type GetTeachersForSchoolRequest = {
     /**
      * The order to sort the response by
      */
-    orderBy?: GetTeachersForSchoolOrderBy | undefined;
+    orderBy?: OrderBy | undefined;
     /**
      * The filter to apply to the response
      */
@@ -54,35 +58,11 @@ export type GetTeachersForSchoolRequest = {
     search?: string | undefined;
 };
 
-export const GetTeachersForSchoolStatus = {
-    Active: 'active',
-    Tobedeleted: 'tobedeleted',
-} as const;
-export type GetTeachersForSchoolStatus = ClosedEnum<typeof GetTeachersForSchoolStatus>;
-
 export type GetTeachersForSchoolUserId = {
     type: string;
     identifier: string;
 };
 
-export const GetTeachersForSchoolRoleType = {
-    Primary: 'primary',
-    Secondary: 'secondary',
-} as const;
-export type GetTeachersForSchoolRoleType = ClosedEnum<typeof GetTeachersForSchoolRoleType>;
-
-export const GetTeachersForSchoolRoleEnum = {
-    Administrator: 'administrator',
-    Aide: 'aide',
-    Guardian: 'guardian',
-    Parent: 'parent',
-    Proctor: 'proctor',
-    Relative: 'relative',
-    Student: 'student',
-    Teacher: 'teacher',
-} as const;
-export type GetTeachersForSchoolRoleEnum = ClosedEnum<typeof GetTeachersForSchoolRoleEnum>;
-
 export type GetTeachersForSchoolOrg = {
     href: string;
     sourcedId: string;
@@ -90,41 +70,18 @@ export type GetTeachersForSchoolOrg = {
 };
 
 export type GetTeachersForSchoolRole = {
-    roleType: GetTeachersForSchoolRoleType;
-    role: GetTeachersForSchoolRoleEnum;
+    roleType: RoleType;
+    role: UserRole;
     org: GetTeachersForSchoolOrg;
     userProfile?: string | undefined;
     beginDate: string | null;
     endDate: string | null;
 };
 
-export const GetTeachersForSchoolType = {
-    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 GetTeachersForSchoolType = ClosedEnum<typeof GetTeachersForSchoolType>;
-
 export type GetTeachersForSchoolAgent = {
     href: string;
     sourcedId: string;
-    type: GetTeachersForSchoolType;
+    type: EntityType;
 };
 
 export type GetTeachersForSchoolPrimaryOrg = {
@@ -135,7 +92,7 @@ export type GetTeachersForSchoolPrimaryOrg = {
 
 export type GetTeachersForSchoolUser = {
     sourcedId: string;
-    status: GetTeachersForSchoolStatus;
+    status: Status;
     dateLastModified?: Date | undefined;
     metadata?: { [k: string]: any } | null | undefined;
     userMasterIdentifier?: string | null | undefined;
@@ -171,27 +128,6 @@ export type GetTeachersForSchoolResponse = {
     result: GetTeachersForSchoolResponseBody;
 };
 
-/** @internal */
-export const GetTeachersForSchoolOrderBy$inboundSchema: z.ZodNativeEnum<
-    typeof GetTeachersForSchoolOrderBy
-> = z.nativeEnum(GetTeachersForSchoolOrderBy);
-
-/** @internal */
-export const GetTeachersForSchoolOrderBy$outboundSchema: z.ZodNativeEnum<
-    typeof GetTeachersForSchoolOrderBy
-> = GetTeachersForSchoolOrderBy$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetTeachersForSchoolOrderBy$ {
-    /** @deprecated use `GetTeachersForSchoolOrderBy$inboundSchema` instead. */
-    export const inboundSchema = GetTeachersForSchoolOrderBy$inboundSchema;
-    /** @deprecated use `GetTeachersForSchoolOrderBy$outboundSchema` instead. */
-    export const outboundSchema = GetTeachersForSchoolOrderBy$outboundSchema;
-}
-
 /** @internal */
 export const GetTeachersForSchoolRequest$inboundSchema: z.ZodType<
     GetTeachersForSchoolRequest,
@@ -203,7 +139,7 @@ export const GetTeachersForSchoolRequest$inboundSchema: z.ZodType<
     limit: z.number().int().default(100),
     offset: z.number().int().default(0),
     sort: z.string().optional(),
-    orderBy: GetTeachersForSchoolOrderBy$inboundSchema.optional(),
+    orderBy: OrderBy$inboundSchema.optional(),
     filter: z.string().optional(),
     search: z.string().optional(),
 });
@@ -231,7 +167,7 @@ export const GetTeachersForSchoolRequest$outboundSchema: z.ZodType<
     limit: z.number().int().default(100),
     offset: z.number().int().default(0),
     sort: z.string().optional(),
-    orderBy: GetTeachersForSchoolOrderBy$outboundSchema.optional(),
+    orderBy: OrderBy$outboundSchema.optional(),
     filter: z.string().optional(),
     search: z.string().optional(),
 });
@@ -267,27 +203,6 @@ export function getTeachersForSchoolRequestFromJSON(
     );
 }
 
-/** @internal */
-export const GetTeachersForSchoolStatus$inboundSchema: z.ZodNativeEnum<
-    typeof GetTeachersForSchoolStatus
-> = z.nativeEnum(GetTeachersForSchoolStatus);
-
-/** @internal */
-export const GetTeachersForSchoolStatus$outboundSchema: z.ZodNativeEnum<
-    typeof GetTeachersForSchoolStatus
-> = GetTeachersForSchoolStatus$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetTeachersForSchoolStatus$ {
-    /** @deprecated use `GetTeachersForSchoolStatus$inboundSchema` instead. */
-    export const inboundSchema = GetTeachersForSchoolStatus$inboundSchema;
-    /** @deprecated use `GetTeachersForSchoolStatus$outboundSchema` instead. */
-    export const outboundSchema = GetTeachersForSchoolStatus$outboundSchema;
-}
-
 /** @internal */
 export const GetTeachersForSchoolUserId$inboundSchema: z.ZodType<
     GetTeachersForSchoolUserId,
@@ -345,48 +260,6 @@ export function getTeachersForSchoolUserIdFromJSON(
     );
 }
 
-/** @internal */
-export const GetTeachersForSchoolRoleType$inboundSchema: z.ZodNativeEnum<
-    typeof GetTeachersForSchoolRoleType
-> = z.nativeEnum(GetTeachersForSchoolRoleType);
-
-/** @internal */
-export const GetTeachersForSchoolRoleType$outboundSchema: z.ZodNativeEnum<
-    typeof GetTeachersForSchoolRoleType
-> = GetTeachersForSchoolRoleType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetTeachersForSchoolRoleType$ {
-    /** @deprecated use `GetTeachersForSchoolRoleType$inboundSchema` instead. */
-    export const inboundSchema = GetTeachersForSchoolRoleType$inboundSchema;
-    /** @deprecated use `GetTeachersForSchoolRoleType$outboundSchema` instead. */
-    export const outboundSchema = GetTeachersForSchoolRoleType$outboundSchema;
-}
-
-/** @internal */
-export const GetTeachersForSchoolRoleEnum$inboundSchema: z.ZodNativeEnum<
-    typeof GetTeachersForSchoolRoleEnum
-> = z.nativeEnum(GetTeachersForSchoolRoleEnum);
-
-/** @internal */
-export const GetTeachersForSchoolRoleEnum$outboundSchema: z.ZodNativeEnum<
-    typeof GetTeachersForSchoolRoleEnum
-> = GetTeachersForSchoolRoleEnum$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetTeachersForSchoolRoleEnum$ {
-    /** @deprecated use `GetTeachersForSchoolRoleEnum$inboundSchema` instead. */
-    export const inboundSchema = GetTeachersForSchoolRoleEnum$inboundSchema;
-    /** @deprecated use `GetTeachersForSchoolRoleEnum$outboundSchema` instead. */
-    export const outboundSchema = GetTeachersForSchoolRoleEnum$outboundSchema;
-}
-
 /** @internal */
 export const GetTeachersForSchoolOrg$inboundSchema: z.ZodType<
     GetTeachersForSchoolOrg,
@@ -451,8 +324,8 @@ export const GetTeachersForSchoolRole$inboundSchema: z.ZodType<
     z.ZodTypeDef,
     unknown
 > = z.object({
-    roleType: GetTeachersForSchoolRoleType$inboundSchema,
-    role: GetTeachersForSchoolRoleEnum$inboundSchema,
+    roleType: RoleType$inboundSchema,
+    role: UserRole$inboundSchema,
     org: z.lazy(() => GetTeachersForSchoolOrg$inboundSchema),
     userProfile: z.string().optional(),
     beginDate: z.nullable(z.string()),
@@ -475,8 +348,8 @@ export const GetTeachersForSchoolRole$outboundSchema: z.ZodType<
     z.ZodTypeDef,
     GetTeachersForSchoolRole
 > = z.object({
-    roleType: GetTeachersForSchoolRoleType$outboundSchema,
-    role: GetTeachersForSchoolRoleEnum$outboundSchema,
+    roleType: RoleType$outboundSchema,
+    role: UserRole$outboundSchema,
     org: z.lazy(() => GetTeachersForSchoolOrg$outboundSchema),
     userProfile: z.string().optional(),
     beginDate: z.nullable(z.string()),
@@ -512,27 +385,6 @@ export function getTeachersForSchoolRoleFromJSON(
     );
 }
 
-/** @internal */
-export const GetTeachersForSchoolType$inboundSchema: z.ZodNativeEnum<
-    typeof GetTeachersForSchoolType
-> = z.nativeEnum(GetTeachersForSchoolType);
-
-/** @internal */
-export const GetTeachersForSchoolType$outboundSchema: z.ZodNativeEnum<
-    typeof GetTeachersForSchoolType
-> = GetTeachersForSchoolType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetTeachersForSchoolType$ {
-    /** @deprecated use `GetTeachersForSchoolType$inboundSchema` instead. */
-    export const inboundSchema = GetTeachersForSchoolType$inboundSchema;
-    /** @deprecated use `GetTeachersForSchoolType$outboundSchema` instead. */
-    export const outboundSchema = GetTeachersForSchoolType$outboundSchema;
-}
-
 /** @internal */
 export const GetTeachersForSchoolAgent$inboundSchema: z.ZodType<
     GetTeachersForSchoolAgent,
@@ -541,7 +393,7 @@ export const GetTeachersForSchoolAgent$inboundSchema: z.ZodType<
 > = z.object({
     href: z.string(),
     sourcedId: z.string(),
-    type: GetTeachersForSchoolType$inboundSchema,
+    type: EntityType$inboundSchema,
 });
 
 /** @internal */
@@ -559,7 +411,7 @@ export const GetTeachersForSchoolAgent$outboundSchema: z.ZodType<
 > = z.object({
     href: z.string(),
     sourcedId: z.string(),
-    type: GetTeachersForSchoolType$outboundSchema,
+    type: EntityType$outboundSchema,
 });
 
 /**
@@ -660,7 +512,7 @@ export const GetTeachersForSchoolUser$inboundSchema: z.ZodType<
     unknown
 > = z.object({
     sourcedId: z.string(),
-    status: GetTeachersForSchoolStatus$inboundSchema,
+        status: Status$inboundSchema,
     dateLastModified: z
         .string()
         .datetime({ offset: true })
@@ -724,7 +576,7 @@ export const GetTeachersForSchoolUser$outboundSchema: z.ZodType<
     GetTeachersForSchoolUser
 > = z.object({
     sourcedId: z.string(),
-    status: GetTeachersForSchoolStatus$outboundSchema,
+    status: Status$outboundSchema,
     dateLastModified: z
         .date()
         .transform((v) => v.toISOString())

package/src/models/operations/getuser.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 GetUserRequest = {
     /**
@@ -13,35 +26,11 @@ export type GetUserRequest = {
     sourcedId: string;
 };
 
-export const GetUserStatus = {
-    Active: 'active',
-    Tobedeleted: 'tobedeleted',
-} as const;
-export type GetUserStatus = ClosedEnum<typeof GetUserStatus>;
-
 export type GetUserUserId = {
     type: string;
     identifier: string;
 };
 
-export const GetUserRoleType = {
-    Primary: 'primary',
-    Secondary: 'secondary',
-} as const;
-export type GetUserRoleType = ClosedEnum<typeof GetUserRoleType>;
-
-export const GetUserRoleEnum = {
-    Administrator: 'administrator',
-    Aide: 'aide',
-    Guardian: 'guardian',
-    Parent: 'parent',
-    Proctor: 'proctor',
-    Relative: 'relative',
-    Student: 'student',
-    Teacher: 'teacher',
-} as const;
-export type GetUserRoleEnum = ClosedEnum<typeof GetUserRoleEnum>;
-
 export type GetUserOrg = {
     href: string;
     sourcedId: string;
@@ -49,41 +38,18 @@ export type GetUserOrg = {
 };
 
 export type GetUserRole = {
-    roleType: GetUserRoleType;
-    role: GetUserRoleEnum;
+    roleType: RoleType;
+    role: UserRole;
     org: GetUserOrg;
     userProfile?: string | undefined;
     beginDate: string | null;
     endDate: string | null;
 };
 
-export const GetUserType = {
-    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 GetUserType = ClosedEnum<typeof GetUserType>;
-
 export type GetUserAgent = {
     href: string;
     sourcedId: string;
-    type: GetUserType;
+    type: EntityType;
 };
 
 export type GetUserPrimaryOrg = {
@@ -94,7 +60,7 @@ export type GetUserPrimaryOrg = {
 
 export type GetUserUser = {
     sourcedId: string;
-    status: GetUserStatus;
+    status: Status;
     dateLastModified?: Date | undefined;
     metadata?: { [k: string]: any } | null | undefined;
     userMasterIdentifier?: string | null | undefined;
@@ -173,25 +139,6 @@ export function getUserRequestFromJSON(
     );
 }
 
-/** @internal */
-export const GetUserStatus$inboundSchema: z.ZodNativeEnum<typeof GetUserStatus> =
-    z.nativeEnum(GetUserStatus);
-
-/** @internal */
-export const GetUserStatus$outboundSchema: z.ZodNativeEnum<typeof GetUserStatus> =
-    GetUserStatus$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetUserStatus$ {
-    /** @deprecated use `GetUserStatus$inboundSchema` instead. */
-    export const inboundSchema = GetUserStatus$inboundSchema;
-    /** @deprecated use `GetUserStatus$outboundSchema` instead. */
-    export const outboundSchema = GetUserStatus$outboundSchema;
-}
-
 /** @internal */
 export const GetUserUserId$inboundSchema: z.ZodType<GetUserUserId, z.ZodTypeDef, unknown> =
     z.object({
@@ -242,44 +189,6 @@ export function getUserUserIdFromJSON(
     );
 }
 
-/** @internal */
-export const GetUserRoleType$inboundSchema: z.ZodNativeEnum<typeof GetUserRoleType> =
-    z.nativeEnum(GetUserRoleType);
-
-/** @internal */
-export const GetUserRoleType$outboundSchema: z.ZodNativeEnum<typeof GetUserRoleType> =
-    GetUserRoleType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetUserRoleType$ {
-    /** @deprecated use `GetUserRoleType$inboundSchema` instead. */
-    export const inboundSchema = GetUserRoleType$inboundSchema;
-    /** @deprecated use `GetUserRoleType$outboundSchema` instead. */
-    export const outboundSchema = GetUserRoleType$outboundSchema;
-}
-
-/** @internal */
-export const GetUserRoleEnum$inboundSchema: z.ZodNativeEnum<typeof GetUserRoleEnum> =
-    z.nativeEnum(GetUserRoleEnum);
-
-/** @internal */
-export const GetUserRoleEnum$outboundSchema: z.ZodNativeEnum<typeof GetUserRoleEnum> =
-    GetUserRoleEnum$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetUserRoleEnum$ {
-    /** @deprecated use `GetUserRoleEnum$inboundSchema` instead. */
-    export const inboundSchema = GetUserRoleEnum$inboundSchema;
-    /** @deprecated use `GetUserRoleEnum$outboundSchema` instead. */
-    export const outboundSchema = GetUserRoleEnum$outboundSchema;
-}
-
 /** @internal */
 export const GetUserOrg$inboundSchema: z.ZodType<GetUserOrg, z.ZodTypeDef, unknown> = z.object({
     href: z.string(),
@@ -331,8 +240,8 @@ export function getUserOrgFromJSON(
 
 /** @internal */
 export const GetUserRole$inboundSchema: z.ZodType<GetUserRole, z.ZodTypeDef, unknown> = z.object({
-    roleType: GetUserRoleType$inboundSchema,
-    role: GetUserRoleEnum$inboundSchema,
+    roleType: RoleType$inboundSchema,
+    role: UserRole$inboundSchema,
     org: z.lazy(() => GetUserOrg$inboundSchema),
     userProfile: z.string().optional(),
     beginDate: z.nullable(z.string()),
@@ -355,8 +264,8 @@ export const GetUserRole$outboundSchema: z.ZodType<
     z.ZodTypeDef,
     GetUserRole
 > = z.object({
-    roleType: GetUserRoleType$outboundSchema,
-    role: GetUserRoleEnum$outboundSchema,
+    roleType: RoleType$outboundSchema,
+    role: UserRole$outboundSchema,
     org: z.lazy(() => GetUserOrg$outboundSchema),
     userProfile: z.string().optional(),
     beginDate: z.nullable(z.string()),
@@ -390,30 +299,11 @@ export function getUserRoleFromJSON(
     );
 }
 
-/** @internal */
-export const GetUserType$inboundSchema: z.ZodNativeEnum<typeof GetUserType> =
-    z.nativeEnum(GetUserType);
-
-/** @internal */
-export const GetUserType$outboundSchema: z.ZodNativeEnum<typeof GetUserType> =
-    GetUserType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetUserType$ {
-    /** @deprecated use `GetUserType$inboundSchema` instead. */
-    export const inboundSchema = GetUserType$inboundSchema;
-    /** @deprecated use `GetUserType$outboundSchema` instead. */
-    export const outboundSchema = GetUserType$outboundSchema;
-}
-
 /** @internal */
 export const GetUserAgent$inboundSchema: z.ZodType<GetUserAgent, z.ZodTypeDef, unknown> = z.object({
     href: z.string(),
     sourcedId: z.string(),
-    type: GetUserType$inboundSchema,
+    type: EntityType$inboundSchema,
 });
 
 /** @internal */
@@ -431,7 +321,7 @@ export const GetUserAgent$outboundSchema: z.ZodType<
 > = z.object({
     href: z.string(),
     sourcedId: z.string(),
-    type: GetUserType$outboundSchema,
+    type: EntityType$outboundSchema,
 });
 
 /**
@@ -517,7 +407,7 @@ export function getUserPrimaryOrgFromJSON(
 /** @internal */
 export const GetUserUser$inboundSchema: z.ZodType<GetUserUser, z.ZodTypeDef, unknown> = z.object({
     sourcedId: z.string(),
-    status: GetUserStatus$inboundSchema,
+    status: Status$inboundSchema,
     dateLastModified: z
         .string()
         .datetime({ offset: true })
@@ -581,7 +471,7 @@ export const GetUserUser$outboundSchema: z.ZodType<
     GetUserUser
 > = z.object({
     sourcedId: z.string(),
-    status: GetUserStatus$outboundSchema,
+    status: Status$outboundSchema,
     dateLastModified: z
         .date()
         .transform((v) => v.toISOString())