@greensecurity/javascript-sdk 0.45.0-beta.26 → 0.45.0-beta.28

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/index.extras.ts

@@ -55,6 +55,12 @@ import { kioskHeartbeat } from "./admin-funcs/kioskHeartbeat.js";
 import { listCommunications } from "./admin-funcs/listCommunications.js";
 import { dismissCommunication } from "./admin-funcs/dismissCommunication.js";
 
+import { networksList } from "./admin-funcs/networksList.js";
+import { networksGet } from "./admin-funcs/networksGet.js";
+import { networksCreate } from "./admin-funcs/networksCreate.js";
+import { zoneDevicesList } from "./admin-funcs/zoneDevicesList.js";
+import { zoneDevicesGet } from "./admin-funcs/zoneDevicesGet.js";
+
 export const __internal = {
   getInternalCore,
   initializeInternalCore,
@@ -139,5 +145,18 @@ export const __internal = {
     createZoneDevice: kioskCreateZoneDevice,
     createEvent: kioskCreateEvent,
     heartbeat: kioskHeartbeat
+  },
+
+  // Gatekeeper provisioning: the network a facility's devices join, and the
+  // inventory of the devices themselves.
+  networks: {
+    list: networksList,
+    get: networksGet,
+    create: networksCreate
+  },
+
+  zoneDevices: {
+    list: zoneDevicesList,
+    get: zoneDevicesGet
   }
 };

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.26",
+  sdkVersion: "0.45.0-beta.28",
   genVersion: "2.938.0",
   userAgent:
-    "speakeasy-sdk/typescript 0.45.0-beta.26 2.938.0 0.45.0 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.45.0-beta.28 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";

package/src/models/components/invite.ts

@@ -0,0 +1,168 @@
+/*
+ * 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 * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.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";
+
+export type Event2 = {
+  id: number;
+  name: string | null;
+};
+
+/**
+ * The event id, or a summary when `invite.event` is passed to `expand`.
+ */
+export type InviteEvent = Event2 | number;
+
+export const InviteStatus = {
+  Pending: "Pending",
+  Accepted: "Accepted",
+  Declined: "Declined",
+} as const;
+export type InviteStatus = OpenEnum<typeof InviteStatus>;
+
+export const InviteType = {
+  User: "user",
+  Department: "department",
+  Company: "company",
+} as const;
+export type InviteType = OpenEnum<typeof InviteType>;
+
+/**
+ * Who the invitation is addressed to. Populated when `invite.invitee` is passed to `expand`.
+ */
+export type Invitee = {
+  id?: number | undefined;
+  name?: string | null | undefined;
+  type?: InviteType | undefined;
+};
+
+/**
+ * An invitation to an appointment, in the shape served to SDK builds `0.55.0-beta.1` and above. SDK builds below `0.55.0-beta.1` receive `PendingInvitation` instead.
+ *
+ * @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 Invite = {
+  id?: number | undefined;
+  /**
+   * The event id, or a summary when `invite.event` is passed to `expand`.
+   */
+  event?: Event2 | number | undefined;
+  userId?: number | null | undefined;
+  companyId?: number | null | undefined;
+  departmentId?: number | null | undefined;
+  status?: InviteStatus | null | undefined;
+  dateReviewed?: string | null | undefined;
+  /**
+   * Who the invitation is addressed to. Populated when `invite.invitee` is passed to `expand`.
+   */
+  invitee?: Invitee | null | undefined;
+};
+
+/** @internal */
+export const Event2$inboundSchema: z.ZodType<Event2, z.ZodTypeDef, unknown> = z
+  .object({
+    id: types.number(),
+    name: types.nullable(types.string()),
+  });
+
+export function event2FromJSON(
+  jsonString: string,
+): SafeParseResult<Event2, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Event2$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Event2' from JSON`,
+  );
+}
+
+/** @internal */
+export const InviteEvent$inboundSchema: z.ZodType<
+  InviteEvent,
+  z.ZodTypeDef,
+  unknown
+> = smartUnion([z.lazy(() => Event2$inboundSchema), types.number()]);
+
+export function inviteEventFromJSON(
+  jsonString: string,
+): SafeParseResult<InviteEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InviteEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InviteEvent' from JSON`,
+  );
+}
+
+/** @internal */
+export const InviteStatus$inboundSchema: z.ZodType<
+  InviteStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(InviteStatus);
+
+/** @internal */
+export const InviteType$inboundSchema: z.ZodType<
+  InviteType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(InviteType);
+
+/** @internal */
+export const Invitee$inboundSchema: z.ZodType<Invitee, z.ZodTypeDef, unknown> =
+  z.object({
+    id: types.optional(types.number()),
+    name: z.nullable(types.string()).optional(),
+    type: types.optional(InviteType$inboundSchema),
+  });
+
+export function inviteeFromJSON(
+  jsonString: string,
+): SafeParseResult<Invitee, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Invitee$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Invitee' from JSON`,
+  );
+}
+
+/** @internal */
+export const Invite$inboundSchema: z.ZodType<Invite, z.ZodTypeDef, unknown> = z
+  .object({
+    id: types.optional(types.number()),
+    event: types.optional(
+      smartUnion([z.lazy(() => Event2$inboundSchema), types.number()]),
+    ),
+    user_id: z.nullable(types.number()).optional(),
+    company_id: z.nullable(types.number()).optional(),
+    department_id: z.nullable(types.number()).optional(),
+    status: z.nullable(InviteStatus$inboundSchema).optional(),
+    date_reviewed: z.nullable(types.string()).optional(),
+    invitee: z.nullable(z.lazy(() => Invitee$inboundSchema)).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "user_id": "userId",
+      "company_id": "companyId",
+      "department_id": "departmentId",
+      "date_reviewed": "dateReviewed",
+    });
+  });
+
+export function inviteFromJSON(
+  jsonString: string,
+): SafeParseResult<Invite, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Invite$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Invite' from JSON`,
+  );
+}

package/src/models/operations/createevent.ts

@@ -32,6 +32,23 @@ export type CreateEventRequestBody = {
   inviteeUserIds?: Array<number> | undefined;
   inviteeDepartmentIds?: Array<number> | undefined;
   notes?: string | undefined;
+  /**
+   * The user the appointment is booked for. Defaults to the authenticated user, which
+   *
+   * @remarks
+   * is what a vendor or a facility user means. An API service account has no calendar
+   * of its own, so it names one here; the user must be a contact of the selected
+   * facility (or of its system), or a vendor targeting it.
+   */
+  organizerUserId?: number | undefined;
+  /**
+   * The time zone `begin_date`/`begin_time` and `end_date`/`end_time` are given in, as
+   *
+   * @remarks
+   * a Rails time zone name (e.g. "Central Time (US & Canada)"). Defaults to the
+   * organizer's own time zone.
+   */
+  timezone?: string | undefined;
 };
 
 /**
@@ -57,6 +74,8 @@ export type CreateEventRequestBody$Outbound = {
   invitee_user_ids?: Array<number> | undefined;
   invitee_department_ids?: Array<number> | undefined;
   notes?: string | undefined;
+  organizer_user_id?: number | undefined;
+  timezone?: string | undefined;
 };
 
 /** @internal */
@@ -78,6 +97,8 @@ export const CreateEventRequestBody$outboundSchema: z.ZodType<
   inviteeUserIds: z.array(z.number().int()).optional(),
   inviteeDepartmentIds: z.array(z.number().int()).optional(),
   notes: z.string().optional(),
+  organizerUserId: z.number().int().optional(),
+  timezone: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     facilityId: "facility_id",
@@ -91,6 +112,7 @@ export const CreateEventRequestBody$outboundSchema: z.ZodType<
     endDate: "end_date",
     inviteeUserIds: "invitee_user_ids",
     inviteeDepartmentIds: "invitee_department_ids",
+    organizerUserId: "organizer_user_id",
   });
 });