@eduware/oneroster 1.0.0

package/src/models/operations/getallschools.ts

@@ -0,0 +1,535 @@
+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 GetAllSchoolsOrderBy = {
+    Asc: 'asc',
+    Desc: 'desc',
+} as const;
+/**
+ * The order to sort the response by
+ */
+export type GetAllSchoolsOrderBy = ClosedEnum<typeof GetAllSchoolsOrderBy>;
+
+export type GetAllSchoolsRequest = {
+    /**
+     * Comma-separated list of fields to include in the response
+     */
+    fields?: string | undefined;
+    /**
+     * The maximum number of items to return in the paginated response
+     */
+    limit?: number | undefined;
+    /**
+     * The number of items to skip in the paginated response
+     */
+    offset?: number | undefined;
+    /**
+     * The field to sort the response by
+     */
+    sort?: string | undefined;
+    /**
+     * The order to sort the response by
+     */
+    orderBy?: GetAllSchoolsOrderBy | undefined;
+    /**
+     * The filter to apply to the response
+     */
+    filter?: string | undefined;
+    /**
+     * The search query to apply to the response
+     */
+    search?: string | undefined;
+};
+
+export const GetAllSchoolsStatus = {
+    Active: 'active',
+    Tobedeleted: 'tobedeleted',
+} as const;
+export type GetAllSchoolsStatus = ClosedEnum<typeof GetAllSchoolsStatus>;
+
+export const GetAllSchoolsType = {
+    Department: 'department',
+    School: 'school',
+    District: 'district',
+    Local: 'local',
+    State: 'state',
+    National: 'national',
+} as const;
+export type GetAllSchoolsType = ClosedEnum<typeof GetAllSchoolsType>;
+
+export type GetAllSchoolsParent = {
+    href: string;
+    sourcedId: string;
+    type: string;
+};
+
+export type GetAllSchoolsChild = {
+    href: string;
+    sourcedId: string;
+    type: string;
+};
+
+/**
+ * Represents an organization.
+ */
+export type GetAllSchoolsOrg = {
+    sourcedId: string;
+    status: GetAllSchoolsStatus;
+    dateLastModified?: Date | undefined;
+    metadata?: { [k: string]: any } | null | undefined;
+    name: string;
+    type: GetAllSchoolsType;
+    identifier: string;
+    parent?: GetAllSchoolsParent | null | undefined;
+    children: Array<GetAllSchoolsChild> | null;
+};
+
+/**
+ * Collection of schools successfully retrieved
+ */
+export type GetAllSchoolsResponseBody = {
+    orgs: Array<GetAllSchoolsOrg>;
+};
+
+export type GetAllSchoolsResponse = {
+    result: GetAllSchoolsResponseBody;
+};
+
+/** @internal */
+export const GetAllSchoolsOrderBy$inboundSchema: z.ZodNativeEnum<typeof GetAllSchoolsOrderBy> =
+    z.nativeEnum(GetAllSchoolsOrderBy);
+
+/** @internal */
+export const GetAllSchoolsOrderBy$outboundSchema: z.ZodNativeEnum<typeof GetAllSchoolsOrderBy> =
+    GetAllSchoolsOrderBy$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetAllSchoolsOrderBy$ {
+    /** @deprecated use `GetAllSchoolsOrderBy$inboundSchema` instead. */
+    export const inboundSchema = GetAllSchoolsOrderBy$inboundSchema;
+    /** @deprecated use `GetAllSchoolsOrderBy$outboundSchema` instead. */
+    export const outboundSchema = GetAllSchoolsOrderBy$outboundSchema;
+}
+
+/** @internal */
+export const GetAllSchoolsRequest$inboundSchema: z.ZodType<
+    GetAllSchoolsRequest,
+    z.ZodTypeDef,
+    unknown
+> = z.object({
+    fields: z.string().optional(),
+    limit: z.number().int().default(100),
+    offset: z.number().int().default(0),
+    sort: z.string().optional(),
+    orderBy: GetAllSchoolsOrderBy$inboundSchema.optional(),
+    filter: z.string().optional(),
+    search: z.string().optional(),
+});
+
+/** @internal */
+export type GetAllSchoolsRequest$Outbound = {
+    fields?: string | undefined;
+    limit: number;
+    offset: number;
+    sort?: string | undefined;
+    orderBy?: string | undefined;
+    filter?: string | undefined;
+    search?: string | undefined;
+};
+
+/** @internal */
+export const GetAllSchoolsRequest$outboundSchema: z.ZodType<
+    GetAllSchoolsRequest$Outbound,
+    z.ZodTypeDef,
+    GetAllSchoolsRequest
+> = z.object({
+    fields: z.string().optional(),
+    limit: z.number().int().default(100),
+    offset: z.number().int().default(0),
+    sort: z.string().optional(),
+    orderBy: GetAllSchoolsOrderBy$outboundSchema.optional(),
+    filter: z.string().optional(),
+    search: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetAllSchoolsRequest$ {
+    /** @deprecated use `GetAllSchoolsRequest$inboundSchema` instead. */
+    export const inboundSchema = GetAllSchoolsRequest$inboundSchema;
+    /** @deprecated use `GetAllSchoolsRequest$outboundSchema` instead. */
+    export const outboundSchema = GetAllSchoolsRequest$outboundSchema;
+    /** @deprecated use `GetAllSchoolsRequest$Outbound` instead. */
+    export type Outbound = GetAllSchoolsRequest$Outbound;
+}
+
+export function getAllSchoolsRequestToJSON(getAllSchoolsRequest: GetAllSchoolsRequest): string {
+    return JSON.stringify(GetAllSchoolsRequest$outboundSchema.parse(getAllSchoolsRequest));
+}
+
+export function getAllSchoolsRequestFromJSON(
+    jsonString: string
+): SafeParseResult<GetAllSchoolsRequest, SDKValidationError> {
+    return safeParse(
+        jsonString,
+        (x) => GetAllSchoolsRequest$inboundSchema.parse(JSON.parse(x)),
+        `Failed to parse 'GetAllSchoolsRequest' from JSON`
+    );
+}
+
+/** @internal */
+export const GetAllSchoolsStatus$inboundSchema: z.ZodNativeEnum<typeof GetAllSchoolsStatus> =
+    z.nativeEnum(GetAllSchoolsStatus);
+
+/** @internal */
+export const GetAllSchoolsStatus$outboundSchema: z.ZodNativeEnum<typeof GetAllSchoolsStatus> =
+    GetAllSchoolsStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetAllSchoolsStatus$ {
+    /** @deprecated use `GetAllSchoolsStatus$inboundSchema` instead. */
+    export const inboundSchema = GetAllSchoolsStatus$inboundSchema;
+    /** @deprecated use `GetAllSchoolsStatus$outboundSchema` instead. */
+    export const outboundSchema = GetAllSchoolsStatus$outboundSchema;
+}
+
+/** @internal */
+export const GetAllSchoolsType$inboundSchema: z.ZodNativeEnum<typeof GetAllSchoolsType> =
+    z.nativeEnum(GetAllSchoolsType);
+
+/** @internal */
+export const GetAllSchoolsType$outboundSchema: z.ZodNativeEnum<typeof GetAllSchoolsType> =
+    GetAllSchoolsType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetAllSchoolsType$ {
+    /** @deprecated use `GetAllSchoolsType$inboundSchema` instead. */
+    export const inboundSchema = GetAllSchoolsType$inboundSchema;
+    /** @deprecated use `GetAllSchoolsType$outboundSchema` instead. */
+    export const outboundSchema = GetAllSchoolsType$outboundSchema;
+}
+
+/** @internal */
+export const GetAllSchoolsParent$inboundSchema: z.ZodType<
+    GetAllSchoolsParent,
+    z.ZodTypeDef,
+    unknown
+> = z.object({
+    href: z.string(),
+    sourcedId: z.string(),
+    type: z.string(),
+});
+
+/** @internal */
+export type GetAllSchoolsParent$Outbound = {
+    href: string;
+    sourcedId: string;
+    type: string;
+};
+
+/** @internal */
+export const GetAllSchoolsParent$outboundSchema: z.ZodType<
+    GetAllSchoolsParent$Outbound,
+    z.ZodTypeDef,
+    GetAllSchoolsParent
+> = z.object({
+    href: z.string(),
+    sourcedId: z.string(),
+    type: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetAllSchoolsParent$ {
+    /** @deprecated use `GetAllSchoolsParent$inboundSchema` instead. */
+    export const inboundSchema = GetAllSchoolsParent$inboundSchema;
+    /** @deprecated use `GetAllSchoolsParent$outboundSchema` instead. */
+    export const outboundSchema = GetAllSchoolsParent$outboundSchema;
+    /** @deprecated use `GetAllSchoolsParent$Outbound` instead. */
+    export type Outbound = GetAllSchoolsParent$Outbound;
+}
+
+export function getAllSchoolsParentToJSON(getAllSchoolsParent: GetAllSchoolsParent): string {
+    return JSON.stringify(GetAllSchoolsParent$outboundSchema.parse(getAllSchoolsParent));
+}
+
+export function getAllSchoolsParentFromJSON(
+    jsonString: string
+): SafeParseResult<GetAllSchoolsParent, SDKValidationError> {
+    return safeParse(
+        jsonString,
+        (x) => GetAllSchoolsParent$inboundSchema.parse(JSON.parse(x)),
+        `Failed to parse 'GetAllSchoolsParent' from JSON`
+    );
+}
+
+/** @internal */
+export const GetAllSchoolsChild$inboundSchema: z.ZodType<
+    GetAllSchoolsChild,
+    z.ZodTypeDef,
+    unknown
+> = z.object({
+    href: z.string(),
+    sourcedId: z.string(),
+    type: z.string(),
+});
+
+/** @internal */
+export type GetAllSchoolsChild$Outbound = {
+    href: string;
+    sourcedId: string;
+    type: string;
+};
+
+/** @internal */
+export const GetAllSchoolsChild$outboundSchema: z.ZodType<
+    GetAllSchoolsChild$Outbound,
+    z.ZodTypeDef,
+    GetAllSchoolsChild
+> = z.object({
+    href: z.string(),
+    sourcedId: z.string(),
+    type: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetAllSchoolsChild$ {
+    /** @deprecated use `GetAllSchoolsChild$inboundSchema` instead. */
+    export const inboundSchema = GetAllSchoolsChild$inboundSchema;
+    /** @deprecated use `GetAllSchoolsChild$outboundSchema` instead. */
+    export const outboundSchema = GetAllSchoolsChild$outboundSchema;
+    /** @deprecated use `GetAllSchoolsChild$Outbound` instead. */
+    export type Outbound = GetAllSchoolsChild$Outbound;
+}
+
+export function getAllSchoolsChildToJSON(getAllSchoolsChild: GetAllSchoolsChild): string {
+    return JSON.stringify(GetAllSchoolsChild$outboundSchema.parse(getAllSchoolsChild));
+}
+
+export function getAllSchoolsChildFromJSON(
+    jsonString: string
+): SafeParseResult<GetAllSchoolsChild, SDKValidationError> {
+    return safeParse(
+        jsonString,
+        (x) => GetAllSchoolsChild$inboundSchema.parse(JSON.parse(x)),
+        `Failed to parse 'GetAllSchoolsChild' from JSON`
+    );
+}
+
+/** @internal */
+export const GetAllSchoolsOrg$inboundSchema: z.ZodType<GetAllSchoolsOrg, z.ZodTypeDef, unknown> =
+    z.object({
+        sourcedId: z.string(),
+        status: GetAllSchoolsStatus$inboundSchema,
+        dateLastModified: z
+            .string()
+            .datetime({ offset: true })
+            .transform((v) => new Date(v))
+            .optional(),
+        metadata: z.nullable(z.record(z.any())).optional(),
+        name: z.string(),
+        type: GetAllSchoolsType$inboundSchema,
+        identifier: z.string(),
+        parent: z.nullable(z.lazy(() => GetAllSchoolsParent$inboundSchema)).optional(),
+        children: z.nullable(z.array(z.lazy(() => GetAllSchoolsChild$inboundSchema))),
+    });
+
+/** @internal */
+export type GetAllSchoolsOrg$Outbound = {
+    sourcedId: string;
+    status: string;
+    dateLastModified?: string | undefined;
+    metadata?: { [k: string]: any } | null | undefined;
+    name: string;
+    type: string;
+    identifier: string;
+    parent?: GetAllSchoolsParent$Outbound | null | undefined;
+    children: Array<GetAllSchoolsChild$Outbound> | null;
+};
+
+/** @internal */
+export const GetAllSchoolsOrg$outboundSchema: z.ZodType<
+    GetAllSchoolsOrg$Outbound,
+    z.ZodTypeDef,
+    GetAllSchoolsOrg
+> = z.object({
+    sourcedId: z.string(),
+    status: GetAllSchoolsStatus$outboundSchema,
+    dateLastModified: z
+        .date()
+        .transform((v) => v.toISOString())
+        .optional(),
+    metadata: z.nullable(z.record(z.any())).optional(),
+    name: z.string(),
+    type: GetAllSchoolsType$outboundSchema,
+    identifier: z.string(),
+    parent: z.nullable(z.lazy(() => GetAllSchoolsParent$outboundSchema)).optional(),
+    children: z.nullable(z.array(z.lazy(() => GetAllSchoolsChild$outboundSchema))),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetAllSchoolsOrg$ {
+    /** @deprecated use `GetAllSchoolsOrg$inboundSchema` instead. */
+    export const inboundSchema = GetAllSchoolsOrg$inboundSchema;
+    /** @deprecated use `GetAllSchoolsOrg$outboundSchema` instead. */
+    export const outboundSchema = GetAllSchoolsOrg$outboundSchema;
+    /** @deprecated use `GetAllSchoolsOrg$Outbound` instead. */
+    export type Outbound = GetAllSchoolsOrg$Outbound;
+}
+
+export function getAllSchoolsOrgToJSON(getAllSchoolsOrg: GetAllSchoolsOrg): string {
+    return JSON.stringify(GetAllSchoolsOrg$outboundSchema.parse(getAllSchoolsOrg));
+}
+
+export function getAllSchoolsOrgFromJSON(
+    jsonString: string
+): SafeParseResult<GetAllSchoolsOrg, SDKValidationError> {
+    return safeParse(
+        jsonString,
+        (x) => GetAllSchoolsOrg$inboundSchema.parse(JSON.parse(x)),
+        `Failed to parse 'GetAllSchoolsOrg' from JSON`
+    );
+}
+
+/** @internal */
+export const GetAllSchoolsResponseBody$inboundSchema: z.ZodType<
+    GetAllSchoolsResponseBody,
+    z.ZodTypeDef,
+    unknown
+> = z.object({
+    orgs: z.array(z.lazy(() => GetAllSchoolsOrg$inboundSchema)),
+});
+
+/** @internal */
+export type GetAllSchoolsResponseBody$Outbound = {
+    orgs: Array<GetAllSchoolsOrg$Outbound>;
+};
+
+/** @internal */
+export const GetAllSchoolsResponseBody$outboundSchema: z.ZodType<
+    GetAllSchoolsResponseBody$Outbound,
+    z.ZodTypeDef,
+    GetAllSchoolsResponseBody
+> = z.object({
+    orgs: z.array(z.lazy(() => GetAllSchoolsOrg$outboundSchema)),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetAllSchoolsResponseBody$ {
+    /** @deprecated use `GetAllSchoolsResponseBody$inboundSchema` instead. */
+    export const inboundSchema = GetAllSchoolsResponseBody$inboundSchema;
+    /** @deprecated use `GetAllSchoolsResponseBody$outboundSchema` instead. */
+    export const outboundSchema = GetAllSchoolsResponseBody$outboundSchema;
+    /** @deprecated use `GetAllSchoolsResponseBody$Outbound` instead. */
+    export type Outbound = GetAllSchoolsResponseBody$Outbound;
+}
+
+export function getAllSchoolsResponseBodyToJSON(
+    getAllSchoolsResponseBody: GetAllSchoolsResponseBody
+): string {
+    return JSON.stringify(
+        GetAllSchoolsResponseBody$outboundSchema.parse(getAllSchoolsResponseBody)
+    );
+}
+
+export function getAllSchoolsResponseBodyFromJSON(
+    jsonString: string
+): SafeParseResult<GetAllSchoolsResponseBody, SDKValidationError> {
+    return safeParse(
+        jsonString,
+        (x) => GetAllSchoolsResponseBody$inboundSchema.parse(JSON.parse(x)),
+        `Failed to parse 'GetAllSchoolsResponseBody' from JSON`
+    );
+}
+
+/** @internal */
+export const GetAllSchoolsResponse$inboundSchema: z.ZodType<
+    GetAllSchoolsResponse,
+    z.ZodTypeDef,
+    unknown
+> = z
+    .object({
+        Result: z.lazy(() => GetAllSchoolsResponseBody$inboundSchema),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            Result: 'result',
+        });
+    });
+
+/** @internal */
+export type GetAllSchoolsResponse$Outbound = {
+    Result: GetAllSchoolsResponseBody$Outbound;
+};
+
+/** @internal */
+export const GetAllSchoolsResponse$outboundSchema: z.ZodType<
+    GetAllSchoolsResponse$Outbound,
+    z.ZodTypeDef,
+    GetAllSchoolsResponse
+> = z
+    .object({
+        result: z.lazy(() => GetAllSchoolsResponseBody$outboundSchema),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            result: 'Result',
+        });
+    });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetAllSchoolsResponse$ {
+    /** @deprecated use `GetAllSchoolsResponse$inboundSchema` instead. */
+    export const inboundSchema = GetAllSchoolsResponse$inboundSchema;
+    /** @deprecated use `GetAllSchoolsResponse$outboundSchema` instead. */
+    export const outboundSchema = GetAllSchoolsResponse$outboundSchema;
+    /** @deprecated use `GetAllSchoolsResponse$Outbound` instead. */
+    export type Outbound = GetAllSchoolsResponse$Outbound;
+}
+
+export function getAllSchoolsResponseToJSON(getAllSchoolsResponse: GetAllSchoolsResponse): string {
+    return JSON.stringify(GetAllSchoolsResponse$outboundSchema.parse(getAllSchoolsResponse));
+}
+
+export function getAllSchoolsResponseFromJSON(
+    jsonString: string
+): SafeParseResult<GetAllSchoolsResponse, SDKValidationError> {
+    return safeParse(
+        jsonString,
+        (x) => GetAllSchoolsResponse$inboundSchema.parse(JSON.parse(x)),
+        `Failed to parse 'GetAllSchoolsResponse' from JSON`
+    );
+}