@greensecurity/javascript-sdk 0.45.0-beta.25 → 0.45.0-beta.27

package/src/__tests__/zones.test.ts

@@ -42,16 +42,13 @@ test("Zones List Or Search Security Zones", async () => {
         facility: {
           contacts: {
             contact: {
-              status: "Active",
-              department: 123,
-            },
-            adminContact: {
-              status: "Inactive",
+              status: "Deleted",
               department: 123,
             },
+            adminContact: null,
             techContact: {
               status: "Active",
-              department: 123,
+              department: null,
             },
             greenSecurityCsm: {
               status: "Active",
@@ -60,9 +57,9 @@ test("Zones List Or Search Security Zones", async () => {
             accountManager: null,
           },
           vendorGuestPolicy: {
-            enabled: false,
+            enabled: true,
             vendorGuestLimitAndOr: "and",
-            vendorGuestRequireEmail: true,
+            vendorGuestRequireEmail: false,
           },
         },
       },
@@ -83,7 +80,7 @@ test("Zones Security Zone Checkin", async () => {
 
   const result = await greenSecurity.zones.securityZoneCheckin({
     qrCode: "<value>",
-    zoneId: 776072,
+    zoneId: 542818,
   });
   expect(result).toBeDefined();
   expect(result).toEqual({});

package/src/funcs/eventsCreateEvent.ts

@@ -44,6 +44,7 @@ export function eventsCreateEvent(
   Result<
     operations.CreateEventCreateEventOk,
     | errors.ApiErrorResponse
+    | errors.ApiValidationErrorResponse
     | GreenSecurityError
     | ResponseValidationError
     | ConnectionError
@@ -70,6 +71,7 @@ async function $do(
     Result<
       operations.CreateEventCreateEventOk,
       | errors.ApiErrorResponse
+      | errors.ApiValidationErrorResponse
       | GreenSecurityError
       | ResponseValidationError
       | ConnectionError
@@ -152,6 +154,7 @@ async function $do(
   const [result] = await M.match<
     operations.CreateEventCreateEventOk,
     | errors.ApiErrorResponse
+    | errors.ApiValidationErrorResponse
     | GreenSecurityError
     | ResponseValidationError
     | ConnectionError
@@ -163,6 +166,7 @@ async function $do(
   >(
     M.json(200, operations.CreateEventCreateEventOk$inboundSchema),
     M.jsonErr([400, 401, 403, 404], errors.ApiErrorResponse$inboundSchema),
+    M.jsonErr(422, errors.ApiValidationErrorResponse$inboundSchema),
     M.fail("4XX"),
     M.fail([500, "5XX"]),
   )(response, req, { extraFields: responseFields });

package/src/funcs/eventsGetEvent.ts

@@ -11,6 +11,7 @@ import { safeParse } from "../lib/schemas.js";
 import { RequestOptions } from "../lib/sdks.js";
 import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
 import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
 import { GreenSecurityError } from "../models/errors/greensecurityerror.js";
 import {
   ConnectionError,
@@ -36,12 +37,19 @@ import { Result } from "../types/fp.js";
  *
  * Available `expand` scopes are:
  *
- * - `event.facility`
- * - `event.department`
- * - `event.invitees`
+ * - event.facility
+ * - event.department
+ * - event.invitees
+ * - event.location
+ * - event.attendees
+ * - event.creator
  *
  * Unrecognised values are ignored.
  *
+ * This route always returns the current `Event` shape, whatever SDK version is calling: it was
+ * introduced after the calendar list endpoints and has never served the older string-valued
+ * shape they did.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function eventsGetEvent(
@@ -50,7 +58,7 @@ export function eventsGetEvent(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.GetEventGetEventOk,
+    components.Event,
     | errors.ApiErrorResponse
     | GreenSecurityError
     | ResponseValidationError
@@ -76,7 +84,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.GetEventGetEventOk,
+      components.Event,
       | errors.ApiErrorResponse
       | GreenSecurityError
       | ResponseValidationError
@@ -168,7 +176,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.GetEventGetEventOk,
+    components.Event,
     | errors.ApiErrorResponse
     | GreenSecurityError
     | ResponseValidationError
@@ -179,7 +187,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.GetEventGetEventOk$inboundSchema),
+    M.json(200, components.Event$inboundSchema),
     M.jsonErr([400, 401, 403, 404], errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
     M.fail([500, "5XX"]),

package/src/funcs/eventsListFeed.ts

@@ -36,9 +36,21 @@ import {
  * List events feed
  *
  * @remarks
- * List events feed
+ * List events feed.
+ *
+ * **Permissions.** Requires a valid token. This endpoint is not gated on a named permission -
+ * the caller's role and their relationship to the record decide what is returned.
+ *
+ * Returns `Event` items with the `event.creator` and `event.invitees` scopes already applied,
+ * so `event_creator`, `event_creator_img_url` and `invitees` are populated — the fields this
+ * feed has always carried. SDK builds below `0.55.0-beta.1` receive the older `Feed` shape
+ * instead, in which `facility` and `department` are name strings rather than ids; the server
+ * chooses by the `X-SDK-User-Agent` header the SDK sends, so an existing client keeps the
+ * shape it was generated against until it is regenerated.
  *
- * **Permissions.** Requires a valid token. This endpoint is not gated on a named permission - the caller's role and their relationship to the record decide what is returned.
+ * The boundary is the prerelease build `0.55.0-beta.1`, not the `0.55.0` release, so
+ * `0.55.0-beta.1` itself already receives `Event`. See the `Event` schema for exactly how a
+ * build is compared against it.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/src/funcs/eventsListOrSearchVendorInvitees.ts

@@ -123,10 +123,12 @@ async function $do(
     }, { explode: false }),
     encodeFormQuery({
       "desc": payload.desc,
+      "facility_id": payload.facility_id,
       "items_per_page": payload.items_per_page,
       "page": payload.page,
       "search": payload.search,
       "sort": payload.sort,
+      "vendor_id": payload.vendor_id,
     }),
   );
 

package/src/funcs/eventsListPendingInvitations.ts

@@ -36,9 +36,21 @@ import {
  * List pending invitations
  *
  * @remarks
- * List pending invitations
+ * List pending invitations.
+ *
+ * **Permissions.** Requires a valid token. This endpoint is not gated on a named permission -
+ * the caller's role and their relationship to the record decide what is returned.
+ *
+ * Returns `Invite` items with the `invite.event` and `invite.invitee` scopes already applied,
+ * so `event` is the expanded `{ id, name }` summary rather than a bare id, and `invitee` is
+ * populated — the appointment and the recipient this list has always named. This endpoint
+ * takes no `expand` parameter; both scopes are applied on every call and cannot be turned off.
+ * SDK builds below `0.55.0-beta.1` receive the older `PendingInvitation` shape instead, which
+ * embeds the appointment.
  *
- * **Permissions.** Requires a valid token. This endpoint is not gated on a named permission - the caller's role and their relationship to the record decide what is returned.
+ * The boundary is the prerelease build `0.55.0-beta.1`, not the `0.55.0` release, so
+ * `0.55.0-beta.1` itself already receives `Invite`. See the `Invite` schema for exactly how a
+ * build is compared against it.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/src/funcs/eventsListStandingAppointments.ts

@@ -36,9 +36,20 @@ import {
  * List standing appointments
  *
  * @remarks
- * List standing appointment
+ * List standing appointments.
  *
- * **Permissions.** Requires a valid token. This endpoint is not gated on a named permission - the caller's role and their relationship to the record decide what is returned.
+ * **Permissions.** Requires a valid token. This endpoint is not gated on a named permission -
+ * the caller's role and their relationship to the record decide what is returned.
+ *
+ * Returns `Event` items with the `event.location`, `event.attendees`, `event.viewer_invite`,
+ * `event.creator` and `event.invitees` scopes already applied, so `location`, `attendees`,
+ * `event_creator`, `event_creator_img_url` and `invitees` are populated and `status` carries
+ * the reader's own outstanding invite. SDK builds below `0.55.0-beta.1` receive the older
+ * `StandingAppointment` shape instead.
+ *
+ * The boundary is the prerelease build `0.55.0-beta.1`, not the `0.55.0` release, so
+ * `0.55.0-beta.1` itself already receives `Event`. See the `Event` schema for exactly how a
+ * build is compared against it.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/src/funcs/fhirConfigsDeleteFhirConfigById.ts

@@ -31,6 +31,8 @@ import { Result } from "../types/fp.js";
  * Delete a FHIR config by ID
  *
  * @remarks
+ * Requires the `fhir_config` / `delete` permission.
+ *
  * **Permissions.** Requires the `fhir_configs.delete` permission.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.

package/src/funcs/fhirConfigsGetFhirConfig.ts

@@ -33,6 +33,8 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Retrieve a FHIR configuration by ID.
  *
+ * This endpoint requires the `fhir_configs` / `view` permission.
+ *
  * **Permissions.** Requires the `fhir_configs.view` permission.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.

package/src/funcs/fhirConfigsListOfFhirConfigurations.ts

@@ -36,7 +36,7 @@ import {
  * List of FHIR configurations
  *
  * @remarks
- * List available FHIR configurations.
+ * List available FHIR configurations. This method requires the `fhir_config` / `view` permission.
  *
  * **Permissions.** Requires the `fhir_configs.view` permission.
  *

package/src/funcs/organizationsCreateCompanyTargetFacility.ts

@@ -50,6 +50,8 @@ import { Result } from "../types/fp.js";
  *
  * **Permissions.** Requires the `target_facilities.add` permission.
  *
+ * **Permissions.** Requires the `target_facilities.add` permission.
+ *
  * Available `expand` scopes are:
  *
  * - `company_target_facility.facility`

package/src/funcs/vendorsGetVendorInvoiceDetails.ts

@@ -35,6 +35,8 @@ import { Result } from "../types/fp.js";
  *
  * **Permissions.** Requires the `invoices.view` permission.
  *
+ * **Permissions.** Requires the `invoices.view` permission.
+ *
  * Available `expand` scopes are:
  *
  * - `invoice.invoice_type`

package/src/lib/config.ts

@@ -80,8 +80,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.45.0",
-  sdkVersion: "0.45.0-beta.25",
+  sdkVersion: "0.45.0-beta.27",
   genVersion: "2.938.0",
   userAgent:
-    "speakeasy-sdk/typescript 0.45.0-beta.25 2.938.0 0.45.0 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.45.0-beta.27 2.938.0 0.45.0 @greensecurity/javascript-sdk",
 } as const;

package/src/models/components/event.ts

@@ -0,0 +1,214 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { smartUnion } from "../../types/smartUnion.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { Invite, Invite$inboundSchema } from "./invite.js";
+
+export type EventFacility2 = {
+  id: number;
+  name: string | null;
+};
+
+/**
+ * The facility id, or a summary when `event.facility` is passed to `expand`. Null when the appointment was booked against a department alone.
+ */
+export type EventFacility = EventFacility2 | number;
+
+export type Department2 = {
+  id: number;
+  name: string | null;
+};
+
+/**
+ * The department id, or a summary when `event.department` is passed to `expand`. Null when the appointment was booked against a facility alone.
+ */
+export type EventDepartment = Department2 | number;
+
+/**
+ * An appointment, in the shape served to SDK builds `0.55.0-beta.1` and above. Associations are the numeric id by default, and `{ id, name }` under their expand scope. The display fields (`location`, `attendees`, `event_creator`, `event_creator_img_url`, `invitees`) are null unless their scope is passed. SDK builds below `0.55.0-beta.1` receive `Feed` or `StandingAppointment` instead, which is chosen from the `X-SDK-User-Agent` header.
+ *
+ * @remarks
+ *
+ * The boundary is the prerelease build `0.55.0-beta.1`, not the `0.55.0` release. A build is compared to it by semantic-version ordering, in which a prerelease sorts below its own release: so `0.55.0-beta.1` itself, every later prerelease (`0.55.0-beta.2`, `0.55.0-rc.1`) and every release from `0.55.0` up receive this shape, while an earlier prerelease of the same release — `0.55.0-alpha.1` — does not.
+ */
+export type Event = {
+  id?: number | undefined;
+  /**
+   * The event name.
+   */
+  title?: string | null | undefined;
+  /**
+   * Start date and time in UTC (ISO 8601 format, e.g. 2026-02-23T14:00:00Z). Null if not set.
+   */
+  start?: string | null | undefined;
+  /**
+   * End date and time in UTC (ISO 8601 format, e.g. 2026-02-23T15:00:00Z). Null if not set.
+   */
+  end?: string | null | undefined;
+  allDay?: boolean | undefined;
+  /**
+   * Verbatim ("Approved") unless `event.viewer_invite` is passed to `expand`, which lower-cases it and appends the reading user's own outstanding invite, e.g. "approved but user invite pending". `/events/standing-appointments` passes it.
+   */
+  status?: string | null | undefined;
+  standingAppt?: boolean | undefined;
+  bringingFood?: boolean | undefined;
+  notes?: string | null | undefined;
+  /**
+   * ISO 8601 date-time when the event was approved.
+   */
+  dateApproved?: string | null | undefined;
+  /**
+   * The facility id, or a summary when `event.facility` is passed to `expand`. Null when the appointment was booked against a department alone.
+   */
+  facility?: EventFacility2 | number | null | undefined;
+  /**
+   * The department id, or a summary when `event.department` is passed to `expand`. Null when the appointment was booked against a facility alone.
+   */
+  department?: Department2 | number | null | undefined;
+  /**
+   * "Facility - Department". Populated when `event.location` is passed to `expand`.
+   */
+  location?: string | null | undefined;
+  /**
+   * Populated when `event.attendees` is passed to `expand`.
+   */
+  attendees?: Array<string> | null | undefined;
+  /**
+   * Populated when `event.creator` is passed to `expand`.
+   */
+  eventCreator?: string | null | undefined;
+  /**
+   * Populated when `event.creator` is passed to `expand`.
+   */
+  eventCreatorImgUrl?: string | null | undefined;
+  /**
+   * Populated when `event.invitees` is passed to `expand`.
+   */
+  invitees?: Array<Invite> | null | undefined;
+};
+
+/** @internal */
+export const EventFacility2$inboundSchema: z.ZodType<
+  EventFacility2,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.number(),
+  name: types.nullable(types.string()),
+});
+
+export function eventFacility2FromJSON(
+  jsonString: string,
+): SafeParseResult<EventFacility2, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventFacility2$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventFacility2' from JSON`,
+  );
+}
+
+/** @internal */
+export const EventFacility$inboundSchema: z.ZodType<
+  EventFacility,
+  z.ZodTypeDef,
+  unknown
+> = smartUnion([z.lazy(() => EventFacility2$inboundSchema), types.number()]);
+
+export function eventFacilityFromJSON(
+  jsonString: string,
+): SafeParseResult<EventFacility, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventFacility$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventFacility' from JSON`,
+  );
+}
+
+/** @internal */
+export const Department2$inboundSchema: z.ZodType<
+  Department2,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.number(),
+  name: types.nullable(types.string()),
+});
+
+export function department2FromJSON(
+  jsonString: string,
+): SafeParseResult<Department2, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Department2$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Department2' from JSON`,
+  );
+}
+
+/** @internal */
+export const EventDepartment$inboundSchema: z.ZodType<
+  EventDepartment,
+  z.ZodTypeDef,
+  unknown
+> = smartUnion([z.lazy(() => Department2$inboundSchema), types.number()]);
+
+export function eventDepartmentFromJSON(
+  jsonString: string,
+): SafeParseResult<EventDepartment, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventDepartment$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventDepartment' from JSON`,
+  );
+}
+
+/** @internal */
+export const Event$inboundSchema: z.ZodType<Event, z.ZodTypeDef, unknown> = z
+  .object({
+    id: types.optional(types.number()),
+    title: z.nullable(types.string()).optional(),
+    start: z.nullable(types.string()).optional(),
+    end: z.nullable(types.string()).optional(),
+    all_day: types.optional(types.boolean()),
+    status: z.nullable(types.string()).optional(),
+    standing_appt: types.optional(types.boolean()),
+    bringing_food: types.optional(types.boolean()),
+    notes: z.nullable(types.string()).optional(),
+    date_approved: z.nullable(types.string()).optional(),
+    facility: z.nullable(
+      smartUnion([z.lazy(() => EventFacility2$inboundSchema), types.number()]),
+    ).optional(),
+    department: z.nullable(
+      smartUnion([z.lazy(() => Department2$inboundSchema), types.number()]),
+    ).optional(),
+    location: z.nullable(types.string()).optional(),
+    attendees: z.nullable(z.array(types.string())).optional(),
+    event_creator: z.nullable(types.string()).optional(),
+    event_creator_img_url: z.nullable(types.string()).optional(),
+    invitees: z.nullable(z.array(Invite$inboundSchema)).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "all_day": "allDay",
+      "standing_appt": "standingAppt",
+      "bringing_food": "bringingFood",
+      "date_approved": "dateApproved",
+      "event_creator": "eventCreator",
+      "event_creator_img_url": "eventCreatorImgUrl",
+    });
+  });
+
+export function eventFromJSON(
+  jsonString: string,
+): SafeParseResult<Event, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Event$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Event' from JSON`,
+  );
+}

package/src/models/components/expand.ts

@@ -165,6 +165,12 @@ export const Expand = {
   VisitorCheckinVisitingZone: "visitor_checkin.visiting_zone",
   VisitorCheckinPii: "visitor_checkin.pii",
   VisitorCheckinExternalScreens: "visitor_checkin.external_screens",
+  EventLocation: "event.location",
+  EventAttendees: "event.attendees",
+  EventCreator: "event.creator",
+  EventViewerInvite: "event.viewer_invite",
+  InviteEvent: "invite.event",
+  InviteInvitee: "invite.invitee",
 } as const;
 /**
  * An expansion scope that is valid for the object being requested.

package/src/models/components/index.ts

@@ -34,13 +34,13 @@ export * from "./distributor.js";
 export * from "./distributorcreate.js";
 export * from "./distributorupdate.js";
 export * from "./emailpreferences.js";
+export * from "./event.js";
 export * from "./expand.js";
 export * from "./facility.js";
 export * from "./facilitycalendarsummary.js";
 export * from "./facilitystatus.js";
 export * from "./facilitysummary.js";
 export * from "./facilityvendortype.js";
-export * from "./feed.js";
 export * from "./fhirconfig.js";
 export * from "./fhirconfigcreate.js";
 export * from "./fhirconfigpartialupdate.js";
@@ -49,7 +49,7 @@ export * from "./financialstatus.js";
 export * from "./fullreport.js";
 export * from "./handoff.js";
 export * from "./imageset.js";
-export * from "./invitee.js";
+export * from "./invite.js";
 export * from "./invoice.js";
 export * from "./invoicefinancialstatus.js";
 export * from "./invoiceitem.js";
@@ -80,7 +80,6 @@ export * from "./passwordnotsetresponse.js";
 export * from "./passwordrequiredresponse.js";
 export * from "./paymentprofile.js";
 export * from "./paymentprofileinfo.js";
-export * from "./pendinginvitation.js";
 export * from "./product.js";
 export * from "./productvariant.js";
 export * from "./samlloginrequiredresponse.js";
@@ -91,7 +90,6 @@ export * from "./screeningquestion.js";
 export * from "./screeningresponse.js";
 export * from "./security.js";
 export * from "./ssocontinuation.js";
-export * from "./standingappointment.js";
 export * from "./state.js";
 export * from "./subscription.js";
 export * from "./supervisor.js";