@vepler/sdk 2.152.0 → 2.155.0

package/src/sdk/models/operations/queryschools.ts

@@ -12,7 +12,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import * as shared from "../shared/index.js";
 
 /**
- * Fields/blocks to return per school. Default (omitted): the full flat record, no blocks. Aggregate blocks (`inspections`, `identifiers`, `trust`) are additive — requesting only block names keeps the full flat record and adds the blocks. List scalar field names to trim.
+ * Fields/blocks to return per school. Default (omitted): the full flat record, no blocks. Aggregate blocks (`inspections`, `identifiers`, `trust`, `images`, `branding`, `accreditations`, `videos`, `about`) are additive — requesting only block names keeps the full flat record and adds the blocks. List scalar field names to trim.
  */
 export type QuerySchoolsAttributes = string | Array<string>;
 
@@ -203,7 +203,7 @@ export type Within = {
  */
 export type QuerySchoolsRequestBody = {
   /**
-   * Fields/blocks to return per school. Default (omitted): the full flat record, no blocks. Aggregate blocks (`inspections`, `identifiers`, `trust`) are additive — requesting only block names keeps the full flat record and adds the blocks. List scalar field names to trim.
+   * Fields/blocks to return per school. Default (omitted): the full flat record, no blocks. Aggregate blocks (`inspections`, `identifiers`, `trust`, `images`, `branding`, `accreditations`, `videos`, `about`) are additive — requesting only block names keeps the full flat record and adds the blocks. List scalar field names to trim.
    */
   attributes?: string | Array<string> | undefined;
   /**
@@ -267,6 +267,78 @@ export type QuerySchoolsRequestBody = {
   within?: Within | undefined;
 };
 
+/**
+ * Institutional narrative (ethos, welcome, term dates …). Opt-in via `attributes=about`.
+ */
+export type QuerySchoolsAbout = {
+  /**
+   * General 'about the school' narrative.
+   */
+  aboutDescription?: string | null | undefined;
+  /**
+   * Whether after-school / wraparound care is offered.
+   */
+  afterSchoolCare?: boolean | null | undefined;
+  /**
+   * Whether a breakfast club is offered.
+   */
+  breakfastClub?: boolean | null | undefined;
+  /**
+   * Extra-curricular clubs description.
+   */
+  clubsDescription?: string | null | undefined;
+  /**
+   * Curriculum narrative.
+   */
+  curriculumDescription?: string | null | undefined;
+  /**
+   * The school's stated ethos / values.
+   */
+  ethos?: string | null | undefined;
+  /**
+   * Facilities description.
+   */
+  facilitiesDescription?: string | null | undefined;
+  /**
+   * Headteacher's welcome message.
+   */
+  headteacherWelcome?: string | null | undefined;
+  /**
+   * School history narrative.
+   */
+  historyDescription?: string | null | undefined;
+  /**
+   * Link to the school prospectus.
+   */
+  prospectusUrl?: string | null | undefined;
+  /**
+   * Results / outcomes summary as published.
+   */
+  resultsSummary?: string | null | undefined;
+  /**
+   * SEND / inclusion statement.
+   */
+  sendStatement?: string | null | undefined;
+  /**
+   * Published term dates.
+   */
+  termDates?: Array<shared.SchoolTermDate> | undefined;
+  /**
+   * Named uniform supplier, where stated.
+   */
+  uniformSupplier?: string | null | undefined;
+};
+
+/**
+ * Award / kitemark / partner badges. Opt-in via `attributes=accreditations`.
+ */
+export type QuerySchoolsAccreditations = {
+  /**
+   * Cleared accreditation / award badges.
+   */
+  accreditations?: Array<shared.SchoolAccreditation> | undefined;
+};
+
 /**
  * Postal address of the school
  */
@@ -293,6 +365,25 @@ export type QuerySchoolsAddress = {
   town?: string | undefined;
 };
 
+/**
+ * School branding — logo/crest, colours, social handles. Opt-in via `attributes=branding`.
+ */
+export type QuerySchoolsBranding = {
+  /**
+   * Public URL to the entity's logo / crest.
+   */
+  logoUrl?: string | undefined;
+  /**
+   * Primary brand colour (hex).
+   */
+  primaryColour?: string | undefined;
+  /**
+   * Secondary brand colour (hex).
+   */
+  secondaryColour?: string | undefined;
+  socialMedia?: shared.SocialMediaLinks | undefined;
+};
+
 /**
  * Latest published inspection rating. Native rating from the inspector body that issued it (England: Ofsted; Wales: Estyn; Scotland: Education Scotland; NI: ETI; IE: DES Inspectorate). Rating scales differ by inspector body — do not assume cross-body equivalence.
  */
@@ -346,6 +437,16 @@ export type QuerySchoolsIdentifiers = {
   ukprn?: string | null | undefined;
 };
 
+/**
+ * Facility / building photography, tagged. Opt-in via `attributes=images`.
+ */
+export type QuerySchoolsImages = {
+  /**
+   * Cleared facility / building photography, newest first.
+   */
+  images?: Array<shared.SchoolImage> | undefined;
+};
+
 /**
  * Inspection history. Present only when requested via `attributes=inspections`.
  */
@@ -446,16 +547,38 @@ export const QuerySchoolsType = {
  */
 export type QuerySchoolsType = OpenEnum<typeof QuerySchoolsType>;
 
+/**
+ * Video embeds (metadata only, by reference). Opt-in via `attributes=videos`.
+ */
+export type QuerySchoolsVideos = {
+  /**
+   * Cleared video embeds.
+   */
+  videos?: Array<shared.SchoolVideo> | undefined;
+};
+
 /**
  * A single school record. Combines identity (country, region, provider+key) with descriptive details, location, the latest inspection rating, and source-register metadata. Use the `provider`+`key` pair as a cross-jurisdiction alternate key, and `id` as the durable internal identifier.
  */
 export type QuerySchoolsData = {
+  /**
+   * Institutional narrative (ethos, welcome, term dates …). Opt-in via `attributes=about`.
+   */
+  about?: QuerySchoolsAbout | null | undefined;
+  /**
+   * Award / kitemark / partner badges. Opt-in via `attributes=accreditations`.
+   */
+  accreditations?: QuerySchoolsAccreditations | null | undefined;
   /**
    * Postal address of the school
    */
   address?: QuerySchoolsAddress | undefined;
   admissionsPolicy?: string | undefined;
   ageRange?: string | undefined;
+  /**
+   * School branding — logo/crest, colours, social handles. Opt-in via `attributes=branding`.
+   */
+  branding?: QuerySchoolsBranding | null | undefined;
   capacity?: number | undefined;
   /**
    * Catchment match block. Present only when the request included `catchmentReference`. `matchBasis` is empty when the school is only in range (Tier 5 distance fallback); `verdict` is always populated.
@@ -488,6 +611,10 @@ export type QuerySchoolsData = {
    * Cross-register identifiers. Present only when requested via `attributes=identifiers`.
    */
   identifiers?: QuerySchoolsIdentifiers | null | undefined;
+  /**
+   * Facility / building photography, tagged. Opt-in via `attributes=images`.
+   */
+  images?: QuerySchoolsImages | null | undefined;
   /**
    * Inspection history. Present only when requested via `attributes=inspections`.
    */
@@ -562,6 +689,10 @@ export type QuerySchoolsData = {
    * ISO 8601 datetime of the most recent update to this record
    */
   updatedAt: string;
+  /**
+   * Video embeds (metadata only, by reference). Opt-in via `attributes=videos`.
+   */
+  videos?: QuerySchoolsVideos | null | undefined;
   website?: string | undefined;
 };
 
@@ -797,6 +928,57 @@ export function querySchoolsRequestBodyToJSON(
   );
 }
 
+/** @internal */
+export const QuerySchoolsAbout$inboundSchema: z.ZodType<
+  QuerySchoolsAbout,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  aboutDescription: z.nullable(z.string()).optional(),
+  afterSchoolCare: z.nullable(z.boolean()).optional(),
+  breakfastClub: z.nullable(z.boolean()).optional(),
+  clubsDescription: z.nullable(z.string()).optional(),
+  curriculumDescription: z.nullable(z.string()).optional(),
+  ethos: z.nullable(z.string()).optional(),
+  facilitiesDescription: z.nullable(z.string()).optional(),
+  headteacherWelcome: z.nullable(z.string()).optional(),
+  historyDescription: z.nullable(z.string()).optional(),
+  prospectusUrl: z.nullable(z.string()).optional(),
+  resultsSummary: z.nullable(z.string()).optional(),
+  sendStatement: z.nullable(z.string()).optional(),
+  termDates: z.array(shared.SchoolTermDate$inboundSchema).optional(),
+  uniformSupplier: z.nullable(z.string()).optional(),
+});
+
+export function querySchoolsAboutFromJSON(
+  jsonString: string,
+): SafeParseResult<QuerySchoolsAbout, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => QuerySchoolsAbout$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QuerySchoolsAbout' from JSON`,
+  );
+}
+
+/** @internal */
+export const QuerySchoolsAccreditations$inboundSchema: z.ZodType<
+  QuerySchoolsAccreditations,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  accreditations: z.array(shared.SchoolAccreditation$inboundSchema).optional(),
+});
+
+export function querySchoolsAccreditationsFromJSON(
+  jsonString: string,
+): SafeParseResult<QuerySchoolsAccreditations, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => QuerySchoolsAccreditations$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QuerySchoolsAccreditations' from JSON`,
+  );
+}
+
 /** @internal */
 export const QuerySchoolsAddress$inboundSchema: z.ZodType<
   QuerySchoolsAddress,
@@ -820,6 +1002,28 @@ export function querySchoolsAddressFromJSON(
   );
 }
 
+/** @internal */
+export const QuerySchoolsBranding$inboundSchema: z.ZodType<
+  QuerySchoolsBranding,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  logoUrl: z.string().optional(),
+  primaryColour: z.string().optional(),
+  secondaryColour: z.string().optional(),
+  socialMedia: shared.SocialMediaLinks$inboundSchema.optional(),
+});
+
+export function querySchoolsBrandingFromJSON(
+  jsonString: string,
+): SafeParseResult<QuerySchoolsBranding, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => QuerySchoolsBranding$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QuerySchoolsBranding' from JSON`,
+  );
+}
+
 /** @internal */
 export const QuerySchoolsCurrentRating$inboundSchema: z.ZodType<
   QuerySchoolsCurrentRating,
@@ -849,6 +1053,25 @@ export function querySchoolsIdentifiersFromJSON(
   );
 }
 
+/** @internal */
+export const QuerySchoolsImages$inboundSchema: z.ZodType<
+  QuerySchoolsImages,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  images: z.array(shared.SchoolImage$inboundSchema).optional(),
+});
+
+export function querySchoolsImagesFromJSON(
+  jsonString: string,
+): SafeParseResult<QuerySchoolsImages, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => QuerySchoolsImages$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QuerySchoolsImages' from JSON`,
+  );
+}
+
 /** @internal */
 export const QuerySchoolsInspections$inboundSchema: z.ZodType<
   QuerySchoolsInspections,
@@ -935,15 +1158,40 @@ export const QuerySchoolsType$inboundSchema: z.ZodType<
   unknown
 > = openEnums.inboundSchema(QuerySchoolsType);
 
+/** @internal */
+export const QuerySchoolsVideos$inboundSchema: z.ZodType<
+  QuerySchoolsVideos,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  videos: z.array(shared.SchoolVideo$inboundSchema).optional(),
+});
+
+export function querySchoolsVideosFromJSON(
+  jsonString: string,
+): SafeParseResult<QuerySchoolsVideos, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => QuerySchoolsVideos$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QuerySchoolsVideos' from JSON`,
+  );
+}
+
 /** @internal */
 export const QuerySchoolsData$inboundSchema: z.ZodType<
   QuerySchoolsData,
   z.ZodTypeDef,
   unknown
 > = z.object({
+  about: z.nullable(z.lazy(() => QuerySchoolsAbout$inboundSchema)).optional(),
+  accreditations: z.nullable(
+    z.lazy(() => QuerySchoolsAccreditations$inboundSchema),
+  ).optional(),
   address: z.lazy(() => QuerySchoolsAddress$inboundSchema).optional(),
   admissionsPolicy: z.string().optional(),
   ageRange: z.string().optional(),
+  branding: z.nullable(z.lazy(() => QuerySchoolsBranding$inboundSchema))
+    .optional(),
   capacity: z.number().int().optional(),
   catchment: shared.SchoolCatchmentBlock$inboundSchema.optional(),
   country: z.string().default("GB"),
@@ -956,6 +1204,7 @@ export const QuerySchoolsData$inboundSchema: z.ZodType<
   id: z.number().int(),
   identifiers: z.nullable(z.lazy(() => QuerySchoolsIdentifiers$inboundSchema))
     .optional(),
+  images: z.nullable(z.lazy(() => QuerySchoolsImages$inboundSchema)).optional(),
   inspections: z.nullable(z.lazy(() => QuerySchoolsInspections$inboundSchema))
     .optional(),
   key: z.string(),
@@ -984,6 +1233,7 @@ export const QuerySchoolsData$inboundSchema: z.ZodType<
   trustName: z.string().optional(),
   type: QuerySchoolsType$inboundSchema,
   updatedAt: z.string(),
+  videos: z.nullable(z.lazy(() => QuerySchoolsVideos$inboundSchema)).optional(),
   website: z.string().optional(),
 });