@eduware/oneroster 1.2.3 → 1.2.5

package/src/models/operations/getallusers.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 GetAllUsersOrderBy = {
-    Asc: 'asc',
-    Desc: 'desc',
-} as const;
-/**
- * The order to sort the response by
- */
-export type GetAllUsersOrderBy = ClosedEnum<typeof GetAllUsersOrderBy>;
+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 GetAllUsersRequest = {
     /**
@@ -39,7 +43,7 @@ export type GetAllUsersRequest = {
     /**
      * The order to sort the response by
      */
-    orderBy?: GetAllUsersOrderBy | undefined;
+    orderBy?: OrderBy | undefined;
     /**
      * The filter to apply to the response
      */
@@ -50,35 +54,11 @@ export type GetAllUsersRequest = {
     search?: string | undefined;
 };
 
-export const GetAllUsersStatus = {
-    Active: 'active',
-    Tobedeleted: 'tobedeleted',
-} as const;
-export type GetAllUsersStatus = ClosedEnum<typeof GetAllUsersStatus>;
-
 export type GetAllUsersUserId = {
     type: string;
     identifier: string;
 };
 
-export const GetAllUsersRoleType = {
-    Primary: 'primary',
-    Secondary: 'secondary',
-} as const;
-export type GetAllUsersRoleType = ClosedEnum<typeof GetAllUsersRoleType>;
-
-export const GetAllUsersRoleEnum = {
-    Administrator: 'administrator',
-    Aide: 'aide',
-    Guardian: 'guardian',
-    Parent: 'parent',
-    Proctor: 'proctor',
-    Relative: 'relative',
-    Student: 'student',
-    Teacher: 'teacher',
-} as const;
-export type GetAllUsersRoleEnum = ClosedEnum<typeof GetAllUsersRoleEnum>;
-
 export type GetAllUsersOrg = {
     href: string;
     sourcedId: string;
@@ -86,41 +66,18 @@ export type GetAllUsersOrg = {
 };
 
 export type GetAllUsersRole = {
-    roleType: GetAllUsersRoleType;
-    role: GetAllUsersRoleEnum;
+    roleType: RoleType;
+    role: UserRole;
     org: GetAllUsersOrg;
     userProfile?: string | undefined;
     beginDate: string | null;
     endDate: string | null;
 };
 
-export const GetAllUsersType = {
-    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 GetAllUsersType = ClosedEnum<typeof GetAllUsersType>;
-
 export type GetAllUsersAgent = {
     href: string;
     sourcedId: string;
-    type: GetAllUsersType;
+    type: EntityType;
 };
 
 export type GetAllUsersPrimaryOrg = {
@@ -131,7 +88,7 @@ export type GetAllUsersPrimaryOrg = {
 
 export type GetAllUsersUser = {
     sourcedId: string;
-    status: GetAllUsersStatus;
+    status: Status;
     dateLastModified?: Date | undefined;
     metadata?: { [k: string]: any } | null | undefined;
     userMasterIdentifier?: string | null | undefined;
@@ -167,25 +124,6 @@ export type GetAllUsersResponse = {
     result: GetAllUsersResponseBody;
 };
 
-/** @internal */
-export const GetAllUsersOrderBy$inboundSchema: z.ZodNativeEnum<typeof GetAllUsersOrderBy> =
-    z.nativeEnum(GetAllUsersOrderBy);
-
-/** @internal */
-export const GetAllUsersOrderBy$outboundSchema: z.ZodNativeEnum<typeof GetAllUsersOrderBy> =
-    GetAllUsersOrderBy$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetAllUsersOrderBy$ {
-    /** @deprecated use `GetAllUsersOrderBy$inboundSchema` instead. */
-    export const inboundSchema = GetAllUsersOrderBy$inboundSchema;
-    /** @deprecated use `GetAllUsersOrderBy$outboundSchema` instead. */
-    export const outboundSchema = GetAllUsersOrderBy$outboundSchema;
-}
-
 /** @internal */
 export const GetAllUsersRequest$inboundSchema: z.ZodType<
     GetAllUsersRequest,
@@ -196,7 +134,7 @@ export const GetAllUsersRequest$inboundSchema: z.ZodType<
     limit: z.number().int().default(100),
     offset: z.number().int().default(0),
     sort: z.string().optional(),
-    orderBy: GetAllUsersOrderBy$inboundSchema.optional(),
+    orderBy: OrderBy$inboundSchema.optional(),
     filter: z.string().optional(),
     search: z.string().optional(),
 });
@@ -222,7 +160,7 @@ export const GetAllUsersRequest$outboundSchema: z.ZodType<
     limit: z.number().int().default(100),
     offset: z.number().int().default(0),
     sort: z.string().optional(),
-    orderBy: GetAllUsersOrderBy$outboundSchema.optional(),
+    orderBy: OrderBy$outboundSchema.optional(),
     filter: z.string().optional(),
     search: z.string().optional(),
 });
@@ -254,25 +192,6 @@ export function getAllUsersRequestFromJSON(
     );
 }
 
-/** @internal */
-export const GetAllUsersStatus$inboundSchema: z.ZodNativeEnum<typeof GetAllUsersStatus> =
-    z.nativeEnum(GetAllUsersStatus);
-
-/** @internal */
-export const GetAllUsersStatus$outboundSchema: z.ZodNativeEnum<typeof GetAllUsersStatus> =
-    GetAllUsersStatus$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetAllUsersStatus$ {
-    /** @deprecated use `GetAllUsersStatus$inboundSchema` instead. */
-    export const inboundSchema = GetAllUsersStatus$inboundSchema;
-    /** @deprecated use `GetAllUsersStatus$outboundSchema` instead. */
-    export const outboundSchema = GetAllUsersStatus$outboundSchema;
-}
-
 /** @internal */
 export const GetAllUsersUserId$inboundSchema: z.ZodType<GetAllUsersUserId, z.ZodTypeDef, unknown> =
     z.object({
@@ -323,44 +242,6 @@ export function getAllUsersUserIdFromJSON(
     );
 }
 
-/** @internal */
-export const GetAllUsersRoleType$inboundSchema: z.ZodNativeEnum<typeof GetAllUsersRoleType> =
-    z.nativeEnum(GetAllUsersRoleType);
-
-/** @internal */
-export const GetAllUsersRoleType$outboundSchema: z.ZodNativeEnum<typeof GetAllUsersRoleType> =
-    GetAllUsersRoleType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetAllUsersRoleType$ {
-    /** @deprecated use `GetAllUsersRoleType$inboundSchema` instead. */
-    export const inboundSchema = GetAllUsersRoleType$inboundSchema;
-    /** @deprecated use `GetAllUsersRoleType$outboundSchema` instead. */
-    export const outboundSchema = GetAllUsersRoleType$outboundSchema;
-}
-
-/** @internal */
-export const GetAllUsersRoleEnum$inboundSchema: z.ZodNativeEnum<typeof GetAllUsersRoleEnum> =
-    z.nativeEnum(GetAllUsersRoleEnum);
-
-/** @internal */
-export const GetAllUsersRoleEnum$outboundSchema: z.ZodNativeEnum<typeof GetAllUsersRoleEnum> =
-    GetAllUsersRoleEnum$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetAllUsersRoleEnum$ {
-    /** @deprecated use `GetAllUsersRoleEnum$inboundSchema` instead. */
-    export const inboundSchema = GetAllUsersRoleEnum$inboundSchema;
-    /** @deprecated use `GetAllUsersRoleEnum$outboundSchema` instead. */
-    export const outboundSchema = GetAllUsersRoleEnum$outboundSchema;
-}
-
 /** @internal */
 export const GetAllUsersOrg$inboundSchema: z.ZodType<GetAllUsersOrg, z.ZodTypeDef, unknown> =
     z.object({
@@ -417,8 +298,8 @@ export function getAllUsersOrgFromJSON(
 /** @internal */
 export const GetAllUsersRole$inboundSchema: z.ZodType<GetAllUsersRole, z.ZodTypeDef, unknown> =
     z.object({
-        roleType: GetAllUsersRoleType$inboundSchema,
-        role: GetAllUsersRoleEnum$inboundSchema,
+        roleType: RoleType$inboundSchema,
+        role: UserRole$inboundSchema,
         org: z.lazy(() => GetAllUsersOrg$inboundSchema),
         userProfile: z.string().optional(),
         beginDate: z.nullable(z.string()),
@@ -441,8 +322,8 @@ export const GetAllUsersRole$outboundSchema: z.ZodType<
     z.ZodTypeDef,
     GetAllUsersRole
 > = z.object({
-    roleType: GetAllUsersRoleType$outboundSchema,
-    role: GetAllUsersRoleEnum$outboundSchema,
+    roleType: RoleType$outboundSchema,
+    role: UserRole$outboundSchema,
     org: z.lazy(() => GetAllUsersOrg$outboundSchema),
     userProfile: z.string().optional(),
     beginDate: z.nullable(z.string()),
@@ -476,31 +357,12 @@ export function getAllUsersRoleFromJSON(
     );
 }
 
-/** @internal */
-export const GetAllUsersType$inboundSchema: z.ZodNativeEnum<typeof GetAllUsersType> =
-    z.nativeEnum(GetAllUsersType);
-
-/** @internal */
-export const GetAllUsersType$outboundSchema: z.ZodNativeEnum<typeof GetAllUsersType> =
-    GetAllUsersType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetAllUsersType$ {
-    /** @deprecated use `GetAllUsersType$inboundSchema` instead. */
-    export const inboundSchema = GetAllUsersType$inboundSchema;
-    /** @deprecated use `GetAllUsersType$outboundSchema` instead. */
-    export const outboundSchema = GetAllUsersType$outboundSchema;
-}
-
 /** @internal */
 export const GetAllUsersAgent$inboundSchema: z.ZodType<GetAllUsersAgent, z.ZodTypeDef, unknown> =
     z.object({
         href: z.string(),
         sourcedId: z.string(),
-        type: GetAllUsersType$inboundSchema,
+        type: EntityType$inboundSchema,
     });
 
 /** @internal */
@@ -518,7 +380,7 @@ export const GetAllUsersAgent$outboundSchema: z.ZodType<
 > = z.object({
     href: z.string(),
     sourcedId: z.string(),
-    type: GetAllUsersType$outboundSchema,
+    type: EntityType$outboundSchema,
 });
 
 /**
@@ -608,7 +470,7 @@ export function getAllUsersPrimaryOrgFromJSON(
 export const GetAllUsersUser$inboundSchema: z.ZodType<GetAllUsersUser, z.ZodTypeDef, unknown> =
     z.object({
         sourcedId: z.string(),
-        status: GetAllUsersStatus$inboundSchema,
+        status: Status$inboundSchema,
         dateLastModified: z
             .string()
             .datetime({ offset: true })
@@ -672,7 +534,7 @@ export const GetAllUsersUser$outboundSchema: z.ZodType<
     GetAllUsersUser
 > = z.object({
     sourcedId: z.string(),
-    status: GetAllUsersStatus$outboundSchema,
+    status: Status$outboundSchema,
     dateLastModified: z
         .date()
         .transform((v) => v.toISOString())

package/src/models/operations/getclassesforuser.ts

@@ -2,21 +2,19 @@ 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 { SDKValidationError } from '../errors/sdkvalidationerror.js';
-
-/**
- * The order to sort the response by
- */
-export const GetClassesForUserOrderBy = {
-    Asc: 'asc',
-    Desc: 'desc',
-} as const;
-/**
- * The order to sort the response by
- */
-export type GetClassesForUserOrderBy = ClosedEnum<typeof GetClassesForUserOrderBy>;
+import {
+    ClassType,
+    ClassType$inboundSchema,
+    ClassType$outboundSchema,
+    OrderBy,
+    OrderBy$inboundSchema,
+    OrderBy$outboundSchema,
+    Status,
+    Status$inboundSchema,
+    Status$outboundSchema,
+} from '../shared/enums.js';
 
 export type GetClassesForUserRequest = {
     /**
@@ -42,7 +40,7 @@ export type GetClassesForUserRequest = {
     /**
      * The order to sort the response by
      */
-    orderBy?: GetClassesForUserOrderBy | undefined;
+    orderBy?: OrderBy | undefined;
     /**
      * The filter to apply to the response
      */
@@ -53,18 +51,6 @@ export type GetClassesForUserRequest = {
     search?: string | undefined;
 };
 
-export const GetClassesForUserStatus = {
-    Active: 'active',
-    Tobedeleted: 'tobedeleted',
-} as const;
-export type GetClassesForUserStatus = ClosedEnum<typeof GetClassesForUserStatus>;
-
-export const GetClassesForUserClassType = {
-    Homeroom: 'homeroom',
-    Scheduled: 'scheduled',
-} as const;
-export type GetClassesForUserClassType = ClosedEnum<typeof GetClassesForUserClassType>;
-
 export type GetClassesForUserCourse = {
     href: string;
     sourcedId: string;
@@ -94,12 +80,12 @@ export type GetClassesForUserResource = {
  */
 export type GetClassesForUserClass = {
     sourcedId: string;
-    status: GetClassesForUserStatus;
+    status: Status;
     dateLastModified?: Date | undefined;
     metadata?: { [k: string]: any } | null | undefined;
     title: string;
     classCode: string | null;
-    classType: GetClassesForUserClassType;
+    classType: ClassType;
     location: string | null;
     grades?: Array<string> | undefined;
     subjects?: Array<string> | undefined;
@@ -122,27 +108,6 @@ export type GetClassesForUserResponse = {
     result: GetClassesForUserResponseBody;
 };
 
-/** @internal */
-export const GetClassesForUserOrderBy$inboundSchema: z.ZodNativeEnum<
-    typeof GetClassesForUserOrderBy
-> = z.nativeEnum(GetClassesForUserOrderBy);
-
-/** @internal */
-export const GetClassesForUserOrderBy$outboundSchema: z.ZodNativeEnum<
-    typeof GetClassesForUserOrderBy
-> = GetClassesForUserOrderBy$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetClassesForUserOrderBy$ {
-    /** @deprecated use `GetClassesForUserOrderBy$inboundSchema` instead. */
-    export const inboundSchema = GetClassesForUserOrderBy$inboundSchema;
-    /** @deprecated use `GetClassesForUserOrderBy$outboundSchema` instead. */
-    export const outboundSchema = GetClassesForUserOrderBy$outboundSchema;
-}
-
 /** @internal */
 export const GetClassesForUserRequest$inboundSchema: z.ZodType<
     GetClassesForUserRequest,
@@ -154,7 +119,7 @@ export const GetClassesForUserRequest$inboundSchema: z.ZodType<
     limit: z.number().int().default(100),
     offset: z.number().int().default(0),
     sort: z.string().optional(),
-    orderBy: GetClassesForUserOrderBy$inboundSchema.optional(),
+    orderBy: OrderBy$inboundSchema.optional(),
     filter: z.string().optional(),
     search: z.string().optional(),
 });
@@ -182,7 +147,7 @@ export const GetClassesForUserRequest$outboundSchema: z.ZodType<
     limit: z.number().int().default(100),
     offset: z.number().int().default(0),
     sort: z.string().optional(),
-    orderBy: GetClassesForUserOrderBy$outboundSchema.optional(),
+    orderBy: OrderBy$outboundSchema.optional(),
     filter: z.string().optional(),
     search: z.string().optional(),
 });
@@ -216,48 +181,6 @@ export function getClassesForUserRequestFromJSON(
     );
 }
 
-/** @internal */
-export const GetClassesForUserStatus$inboundSchema: z.ZodNativeEnum<
-    typeof GetClassesForUserStatus
-> = z.nativeEnum(GetClassesForUserStatus);
-
-/** @internal */
-export const GetClassesForUserStatus$outboundSchema: z.ZodNativeEnum<
-    typeof GetClassesForUserStatus
-> = GetClassesForUserStatus$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetClassesForUserStatus$ {
-    /** @deprecated use `GetClassesForUserStatus$inboundSchema` instead. */
-    export const inboundSchema = GetClassesForUserStatus$inboundSchema;
-    /** @deprecated use `GetClassesForUserStatus$outboundSchema` instead. */
-    export const outboundSchema = GetClassesForUserStatus$outboundSchema;
-}
-
-/** @internal */
-export const GetClassesForUserClassType$inboundSchema: z.ZodNativeEnum<
-    typeof GetClassesForUserClassType
-> = z.nativeEnum(GetClassesForUserClassType);
-
-/** @internal */
-export const GetClassesForUserClassType$outboundSchema: z.ZodNativeEnum<
-    typeof GetClassesForUserClassType
-> = GetClassesForUserClassType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetClassesForUserClassType$ {
-    /** @deprecated use `GetClassesForUserClassType$inboundSchema` instead. */
-    export const inboundSchema = GetClassesForUserClassType$inboundSchema;
-    /** @deprecated use `GetClassesForUserClassType$outboundSchema` instead. */
-    export const outboundSchema = GetClassesForUserClassType$outboundSchema;
-}
-
 /** @internal */
 export const GetClassesForUserCourse$inboundSchema: z.ZodType<
     GetClassesForUserCourse,
@@ -497,7 +420,7 @@ export const GetClassesForUserClass$inboundSchema: z.ZodType<
     unknown
 > = z.object({
     sourcedId: z.string(),
-    status: GetClassesForUserStatus$inboundSchema,
+    status: Status$inboundSchema,
     dateLastModified: z
         .string()
         .datetime({ offset: true })
@@ -506,7 +429,7 @@ export const GetClassesForUserClass$inboundSchema: z.ZodType<
     metadata: z.nullable(z.record(z.any())).optional(),
     title: z.string(),
     classCode: z.nullable(z.string()),
-    classType: GetClassesForUserClassType$inboundSchema,
+    classType: ClassType$inboundSchema,
     location: z.nullable(z.string()),
     grades: z.array(z.string()).optional(),
     subjects: z.array(z.string()).optional(),
@@ -545,7 +468,7 @@ export const GetClassesForUserClass$outboundSchema: z.ZodType<
     GetClassesForUserClass
 > = z.object({
     sourcedId: z.string(),
-    status: GetClassesForUserStatus$outboundSchema,
+    status: Status$outboundSchema,
     dateLastModified: z
         .date()
         .transform((v) => v.toISOString())
@@ -553,7 +476,7 @@ export const GetClassesForUserClass$outboundSchema: z.ZodType<
     metadata: z.nullable(z.record(z.any())).optional(),
     title: z.string(),
     classCode: z.nullable(z.string()),
-    classType: GetClassesForUserClassType$outboundSchema,
+    classType: ClassType$outboundSchema,
     location: z.nullable(z.string()),
     grades: z.array(z.string()).optional(),
     subjects: z.array(z.string()).optional(),