@eduware/oneroster 1.2.4 → 1.2.6

package/src/models/operations/getresourcesforuser.ts

@@ -2,21 +2,22 @@ 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 GetResourcesForUserOrderBy = {
-    Asc: 'asc',
-    Desc: 'desc',
-} as const;
-/**
- * The order to sort the response by
- */
-export type GetResourcesForUserOrderBy = ClosedEnum<typeof GetResourcesForUserOrderBy>;
+import {
+    Importance,
+    Importance$inboundSchema,
+    Importance$outboundSchema,
+    OrderBy,
+    OrderBy$inboundSchema,
+    OrderBy$outboundSchema,
+    RoleType,
+    RoleType$inboundSchema,
+    RoleType$outboundSchema,
+    Status,
+    Status$inboundSchema,
+    Status$outboundSchema,
+} from '../shared/enums.js';
 
 export type GetResourcesForUserRequest = {
     /**
@@ -42,7 +43,7 @@ export type GetResourcesForUserRequest = {
     /**
      * The order to sort the response by
      */
-    orderBy?: GetResourcesForUserOrderBy | undefined;
+    orderBy?: OrderBy | undefined;
     /**
      * The filter to apply to the response
      */
@@ -53,35 +54,17 @@ export type GetResourcesForUserRequest = {
     search?: string | undefined;
 };
 
-export const GetResourcesForUserStatus = {
-    Active: 'active',
-    Tobedeleted: 'tobedeleted',
-} as const;
-export type GetResourcesForUserStatus = ClosedEnum<typeof GetResourcesForUserStatus>;
-
-export const GetResourcesForUserRole = {
-    Primary: 'primary',
-    Secondary: 'secondary',
-} as const;
-export type GetResourcesForUserRole = ClosedEnum<typeof GetResourcesForUserRole>;
-
-export const GetResourcesForUserImportance = {
-    Primary: 'primary',
-    Secondary: 'secondary',
-} as const;
-export type GetResourcesForUserImportance = ClosedEnum<typeof GetResourcesForUserImportance>;
-
 /**
  * Represents a digital resource of some kind.
  */
 export type GetResourcesForUserResource = {
     sourcedId: string;
-    status: GetResourcesForUserStatus;
+    status: Status;
     dateLastModified?: Date | undefined;
     metadata?: { [k: string]: any } | null | undefined;
     title: string;
-    roles?: Array<GetResourcesForUserRole> | undefined;
-    importance?: GetResourcesForUserImportance | undefined;
+    roles?: Array<RoleType> | undefined;
+    importance?: Importance | undefined;
     vendorResourceId: string;
     vendorId?: string | null | undefined;
     applicationId?: string | null | undefined;
@@ -98,27 +81,6 @@ export type GetResourcesForUserResponse = {
     result: GetResourcesForUserResponseBody;
 };
 
-/** @internal */
-export const GetResourcesForUserOrderBy$inboundSchema: z.ZodNativeEnum<
-    typeof GetResourcesForUserOrderBy
-> = z.nativeEnum(GetResourcesForUserOrderBy);
-
-/** @internal */
-export const GetResourcesForUserOrderBy$outboundSchema: z.ZodNativeEnum<
-    typeof GetResourcesForUserOrderBy
-> = GetResourcesForUserOrderBy$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetResourcesForUserOrderBy$ {
-    /** @deprecated use `GetResourcesForUserOrderBy$inboundSchema` instead. */
-    export const inboundSchema = GetResourcesForUserOrderBy$inboundSchema;
-    /** @deprecated use `GetResourcesForUserOrderBy$outboundSchema` instead. */
-    export const outboundSchema = GetResourcesForUserOrderBy$outboundSchema;
-}
-
 /** @internal */
 export const GetResourcesForUserRequest$inboundSchema: z.ZodType<
     GetResourcesForUserRequest,
@@ -130,7 +92,7 @@ export const GetResourcesForUserRequest$inboundSchema: z.ZodType<
     limit: z.number().int().default(100),
     offset: z.number().int().default(0),
     sort: z.string().optional(),
-    orderBy: GetResourcesForUserOrderBy$inboundSchema.optional(),
+    orderBy: OrderBy$inboundSchema.optional(),
     filter: z.string().optional(),
     search: z.string().optional(),
 });
@@ -158,7 +120,7 @@ export const GetResourcesForUserRequest$outboundSchema: z.ZodType<
     limit: z.number().int().default(100),
     offset: z.number().int().default(0),
     sort: z.string().optional(),
-    orderBy: GetResourcesForUserOrderBy$outboundSchema.optional(),
+    orderBy: OrderBy$outboundSchema.optional(),
     filter: z.string().optional(),
     search: z.string().optional(),
 });
@@ -194,69 +156,6 @@ export function getResourcesForUserRequestFromJSON(
     );
 }
 
-/** @internal */
-export const GetResourcesForUserStatus$inboundSchema: z.ZodNativeEnum<
-    typeof GetResourcesForUserStatus
-> = z.nativeEnum(GetResourcesForUserStatus);
-
-/** @internal */
-export const GetResourcesForUserStatus$outboundSchema: z.ZodNativeEnum<
-    typeof GetResourcesForUserStatus
-> = GetResourcesForUserStatus$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetResourcesForUserStatus$ {
-    /** @deprecated use `GetResourcesForUserStatus$inboundSchema` instead. */
-    export const inboundSchema = GetResourcesForUserStatus$inboundSchema;
-    /** @deprecated use `GetResourcesForUserStatus$outboundSchema` instead. */
-    export const outboundSchema = GetResourcesForUserStatus$outboundSchema;
-}
-
-/** @internal */
-export const GetResourcesForUserRole$inboundSchema: z.ZodNativeEnum<
-    typeof GetResourcesForUserRole
-> = z.nativeEnum(GetResourcesForUserRole);
-
-/** @internal */
-export const GetResourcesForUserRole$outboundSchema: z.ZodNativeEnum<
-    typeof GetResourcesForUserRole
-> = GetResourcesForUserRole$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetResourcesForUserRole$ {
-    /** @deprecated use `GetResourcesForUserRole$inboundSchema` instead. */
-    export const inboundSchema = GetResourcesForUserRole$inboundSchema;
-    /** @deprecated use `GetResourcesForUserRole$outboundSchema` instead. */
-    export const outboundSchema = GetResourcesForUserRole$outboundSchema;
-}
-
-/** @internal */
-export const GetResourcesForUserImportance$inboundSchema: z.ZodNativeEnum<
-    typeof GetResourcesForUserImportance
-> = z.nativeEnum(GetResourcesForUserImportance);
-
-/** @internal */
-export const GetResourcesForUserImportance$outboundSchema: z.ZodNativeEnum<
-    typeof GetResourcesForUserImportance
-> = GetResourcesForUserImportance$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetResourcesForUserImportance$ {
-    /** @deprecated use `GetResourcesForUserImportance$inboundSchema` instead. */
-    export const inboundSchema = GetResourcesForUserImportance$inboundSchema;
-    /** @deprecated use `GetResourcesForUserImportance$outboundSchema` instead. */
-    export const outboundSchema = GetResourcesForUserImportance$outboundSchema;
-}
-
 /** @internal */
 export const GetResourcesForUserResource$inboundSchema: z.ZodType<
     GetResourcesForUserResource,
@@ -264,7 +163,7 @@ export const GetResourcesForUserResource$inboundSchema: z.ZodType<
     unknown
 > = z.object({
     sourcedId: z.string(),
-    status: GetResourcesForUserStatus$inboundSchema,
+    status: Status$inboundSchema,
     dateLastModified: z
         .string()
         .datetime({ offset: true })
@@ -272,8 +171,8 @@ export const GetResourcesForUserResource$inboundSchema: z.ZodType<
         .optional(),
     metadata: z.nullable(z.record(z.any())).optional(),
     title: z.string(),
-    roles: z.array(GetResourcesForUserRole$inboundSchema).optional(),
-    importance: GetResourcesForUserImportance$inboundSchema.optional(),
+    roles: z.array(RoleType$inboundSchema).optional(),
+    importance: Importance$inboundSchema.optional(),
     vendorResourceId: z.string(),
     vendorId: z.nullable(z.string()).optional(),
     applicationId: z.nullable(z.string()).optional(),
@@ -300,15 +199,15 @@ export const GetResourcesForUserResource$outboundSchema: z.ZodType<
     GetResourcesForUserResource
 > = z.object({
     sourcedId: z.string(),
-    status: GetResourcesForUserStatus$outboundSchema,
+    status: Status$outboundSchema,
     dateLastModified: z
         .date()
         .transform((v) => v.toISOString())
         .optional(),
     metadata: z.nullable(z.record(z.any())).optional(),
     title: z.string(),
-    roles: z.array(GetResourcesForUserRole$outboundSchema).optional(),
-    importance: GetResourcesForUserImportance$outboundSchema.optional(),
+    roles: z.array(RoleType$outboundSchema).optional(),
+    importance: Importance$outboundSchema.optional(),
     vendorResourceId: z.string(),
     vendorId: z.nullable(z.string()).optional(),
     applicationId: z.nullable(z.string()).optional(),

package/src/models/operations/getstudent.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 GetStudentRequest = {
     /**
@@ -13,35 +26,11 @@ export type GetStudentRequest = {
     sourcedId: string;
 };
 
-export const GetStudentStatus = {
-    Active: 'active',
-    Tobedeleted: 'tobedeleted',
-} as const;
-export type GetStudentStatus = ClosedEnum<typeof GetStudentStatus>;
-
 export type GetStudentUserId = {
     type: string;
     identifier: string;
 };
 
-export const GetStudentRoleType = {
-    Primary: 'primary',
-    Secondary: 'secondary',
-} as const;
-export type GetStudentRoleType = ClosedEnum<typeof GetStudentRoleType>;
-
-export const GetStudentRoleEnum = {
-    Administrator: 'administrator',
-    Aide: 'aide',
-    Guardian: 'guardian',
-    Parent: 'parent',
-    Proctor: 'proctor',
-    Relative: 'relative',
-    Student: 'student',
-    Teacher: 'teacher',
-} as const;
-export type GetStudentRoleEnum = ClosedEnum<typeof GetStudentRoleEnum>;
-
 export type GetStudentOrg = {
     href: string;
     sourcedId: string;
@@ -49,41 +38,18 @@ export type GetStudentOrg = {
 };
 
 export type GetStudentRole = {
-    roleType: GetStudentRoleType;
-    role: GetStudentRoleEnum;
+    roleType: RoleType;
+    role: UserRole;
     org: GetStudentOrg;
     userProfile?: string | undefined;
     beginDate: string | null;
     endDate: string | null;
 };
 
-export const GetStudentType = {
-    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 GetStudentType = ClosedEnum<typeof GetStudentType>;
-
 export type GetStudentAgent = {
     href: string;
     sourcedId: string;
-    type: GetStudentType;
+    type: EntityType;
 };
 
 export type GetStudentPrimaryOrg = {
@@ -94,7 +60,7 @@ export type GetStudentPrimaryOrg = {
 
 export type GetStudentUser = {
     sourcedId: string;
-    status: GetStudentStatus;
+    status: Status;
     dateLastModified?: Date | undefined;
     metadata?: { [k: string]: any } | null | undefined;
     userMasterIdentifier?: string | null | undefined;
@@ -173,25 +139,6 @@ export function getStudentRequestFromJSON(
     );
 }
 
-/** @internal */
-export const GetStudentStatus$inboundSchema: z.ZodNativeEnum<typeof GetStudentStatus> =
-    z.nativeEnum(GetStudentStatus);
-
-/** @internal */
-export const GetStudentStatus$outboundSchema: z.ZodNativeEnum<typeof GetStudentStatus> =
-    GetStudentStatus$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetStudentStatus$ {
-    /** @deprecated use `GetStudentStatus$inboundSchema` instead. */
-    export const inboundSchema = GetStudentStatus$inboundSchema;
-    /** @deprecated use `GetStudentStatus$outboundSchema` instead. */
-    export const outboundSchema = GetStudentStatus$outboundSchema;
-}
-
 /** @internal */
 export const GetStudentUserId$inboundSchema: z.ZodType<GetStudentUserId, z.ZodTypeDef, unknown> =
     z.object({
@@ -242,44 +189,6 @@ export function getStudentUserIdFromJSON(
     );
 }
 
-/** @internal */
-export const GetStudentRoleType$inboundSchema: z.ZodNativeEnum<typeof GetStudentRoleType> =
-    z.nativeEnum(GetStudentRoleType);
-
-/** @internal */
-export const GetStudentRoleType$outboundSchema: z.ZodNativeEnum<typeof GetStudentRoleType> =
-    GetStudentRoleType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetStudentRoleType$ {
-    /** @deprecated use `GetStudentRoleType$inboundSchema` instead. */
-    export const inboundSchema = GetStudentRoleType$inboundSchema;
-    /** @deprecated use `GetStudentRoleType$outboundSchema` instead. */
-    export const outboundSchema = GetStudentRoleType$outboundSchema;
-}
-
-/** @internal */
-export const GetStudentRoleEnum$inboundSchema: z.ZodNativeEnum<typeof GetStudentRoleEnum> =
-    z.nativeEnum(GetStudentRoleEnum);
-
-/** @internal */
-export const GetStudentRoleEnum$outboundSchema: z.ZodNativeEnum<typeof GetStudentRoleEnum> =
-    GetStudentRoleEnum$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetStudentRoleEnum$ {
-    /** @deprecated use `GetStudentRoleEnum$inboundSchema` instead. */
-    export const inboundSchema = GetStudentRoleEnum$inboundSchema;
-    /** @deprecated use `GetStudentRoleEnum$outboundSchema` instead. */
-    export const outboundSchema = GetStudentRoleEnum$outboundSchema;
-}
-
 /** @internal */
 export const GetStudentOrg$inboundSchema: z.ZodType<GetStudentOrg, z.ZodTypeDef, unknown> =
     z.object({
@@ -336,8 +245,8 @@ export function getStudentOrgFromJSON(
 /** @internal */
 export const GetStudentRole$inboundSchema: z.ZodType<GetStudentRole, z.ZodTypeDef, unknown> =
     z.object({
-        roleType: GetStudentRoleType$inboundSchema,
-        role: GetStudentRoleEnum$inboundSchema,
+        roleType: RoleType$inboundSchema,
+        role: UserRole$inboundSchema,
         org: z.lazy(() => GetStudentOrg$inboundSchema),
         userProfile: z.string().optional(),
         beginDate: z.nullable(z.string()),
@@ -360,8 +269,8 @@ export const GetStudentRole$outboundSchema: z.ZodType<
     z.ZodTypeDef,
     GetStudentRole
 > = z.object({
-    roleType: GetStudentRoleType$outboundSchema,
-    role: GetStudentRoleEnum$outboundSchema,
+    roleType: RoleType$outboundSchema,
+    role: UserRole$outboundSchema,
     org: z.lazy(() => GetStudentOrg$outboundSchema),
     userProfile: z.string().optional(),
     beginDate: z.nullable(z.string()),
@@ -395,31 +304,12 @@ export function getStudentRoleFromJSON(
     );
 }
 
-/** @internal */
-export const GetStudentType$inboundSchema: z.ZodNativeEnum<typeof GetStudentType> =
-    z.nativeEnum(GetStudentType);
-
-/** @internal */
-export const GetStudentType$outboundSchema: z.ZodNativeEnum<typeof GetStudentType> =
-    GetStudentType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace GetStudentType$ {
-    /** @deprecated use `GetStudentType$inboundSchema` instead. */
-    export const inboundSchema = GetStudentType$inboundSchema;
-    /** @deprecated use `GetStudentType$outboundSchema` instead. */
-    export const outboundSchema = GetStudentType$outboundSchema;
-}
-
 /** @internal */
 export const GetStudentAgent$inboundSchema: z.ZodType<GetStudentAgent, z.ZodTypeDef, unknown> =
     z.object({
         href: z.string(),
         sourcedId: z.string(),
-        type: GetStudentType$inboundSchema,
+        type: EntityType$inboundSchema,
     });
 
 /** @internal */
@@ -437,7 +327,7 @@ export const GetStudentAgent$outboundSchema: z.ZodType<
 > = z.object({
     href: z.string(),
     sourcedId: z.string(),
-    type: GetStudentType$outboundSchema,
+    type: EntityType$outboundSchema,
 });
 
 /**
@@ -527,7 +417,7 @@ export function getStudentPrimaryOrgFromJSON(
 export const GetStudentUser$inboundSchema: z.ZodType<GetStudentUser, z.ZodTypeDef, unknown> =
     z.object({
         sourcedId: z.string(),
-        status: GetStudentStatus$inboundSchema,
+        status: Status$inboundSchema,
         dateLastModified: z
             .string()
             .datetime({ offset: true })
@@ -591,7 +481,7 @@ export const GetStudentUser$outboundSchema: z.ZodType<
     GetStudentUser
 > = z.object({
     sourcedId: z.string(),
-    status: GetStudentStatus$outboundSchema,
+    status: Status$outboundSchema,
     dateLastModified: z
         .date()
         .transform((v) => v.toISOString())