@greensecurity/javascript-sdk 0.46.0-beta.5 → 0.46.0-beta.7

package/src/models/components/event.ts

@@ -12,84 +12,111 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { Invite, Invite$inboundSchema } from "./invite.js";
 
 export type EventFacility2 = {
+  /**
+   * The unique ID of the facility.
+   */
   id: number;
+  /**
+   * The name of the facility, or `null` if not set.
+   */
   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.
+ * The facility id, or a summary when the request passes `event.facility` to `expand`. Null when the appointment is for a department alone.
  */
 export type EventFacility = EventFacility2 | number;
 
 export type Department2 = {
+  /**
+   * The unique ID of the department.
+   */
   id: number;
+  /**
+   * The name of the department, or `null` if not set.
+   */
   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.
+ * The department id, or a summary when the request passes `event.department` to `expand`. Null when the appointment is for 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.
+ * An appointment, in the shape served to SDK builds `0.46.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 the request passes their scope. SDK builds earlier than `0.46.0-beta.1` receive `Feed` or `StandingAppointment` instead, chosen by the server 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.
+ * The boundary is the prerelease build `0.46.0-beta.1`, not the `0.46.0` release. The server compares the build to it by semantic-version ordering. A prerelease sorts before its own release. So `0.46.0-beta.1` itself, every later prerelease (`0.46.0-beta.2`, `0.46.0-rc.1`) and every release from `0.46.0` up receive this shape, while an earlier prerelease of the same release—`0.46.0-alpha.1`—does not.
  */
 export type Event = {
+  /**
+   * The unique ID of the appointment.
+   */
   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 date and time in UTC (ISO 8601 format, for example, 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 date and time in UTC (ISO 8601 format, for example, 2026-02-23T15:00:00Z). Null if not set.
    */
   end?: string | null | undefined;
+  /**
+   * Whether the appointment lasts all day.
+   */
   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.
+   * Verbatim (`"Approved"`) unless the request passes `event.viewer_invite` to `expand`, which lower-cases it and appends the reading user's own outstanding invite, for example, "approved but user invite pending." `/events/standing-appointments` passes it.
    */
   status?: string | null | undefined;
+  /**
+   * Whether the appointment is a standing appointment.
+   */
   standingAppt?: boolean | undefined;
+  /**
+   * Whether the appointment organizer is bringing food.
+   */
   bringingFood?: boolean | undefined;
+  /**
+   * Notes about the appointment, or `null` if there are none.
+   */
   notes?: string | null | undefined;
   /**
-   * ISO 8601 date-time when the event was approved.
+   * The ISO 8601 date and time of the event's approval.
    */
   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.
+   * The facility id, or a summary when the request passes `event.facility` to `expand`. Null when the appointment is for 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.
+   * The department id, or a summary when the request passes `event.department` to `expand`. Null when the appointment is for a facility alone.
    */
   department?: Department2 | number | null | undefined;
   /**
-   * "Facility - Department". Populated when `event.location` is passed to `expand`.
+   * "Facility - Department." Populated when the request passes `event.location` to `expand`.
    */
   location?: string | null | undefined;
   /**
-   * Populated when `event.attendees` is passed to `expand`.
+   * Populated when the request passes `event.attendees` to `expand`.
    */
   attendees?: Array<string> | null | undefined;
   /**
-   * Populated when `event.creator` is passed to `expand`.
+   * Populated when the request passes `event.creator` to `expand`.
    */
   eventCreator?: string | null | undefined;
   /**
-   * Populated when `event.creator` is passed to `expand`.
+   * Populated when the request passes `event.creator` to `expand`.
    */
   eventCreatorImgUrl?: string | null | undefined;
   /**
-   * Populated when `event.invitees` is passed to `expand`.
+   * Populated when the request passes `event.invitees` to `expand`.
    */
   invitees?: Array<Invite> | null | undefined;
 };

package/src/models/components/expand.ts

@@ -6,7 +6,7 @@ import * as z from "zod/v3";
 import { ClosedEnum } from "../../types/enums.js";
 
 /**
- * An expansion scope that is valid for the object being requested.
+ * An expansion scope that is valid for the requested object.
  */
 export const Expand = {
   User: "user",
@@ -173,7 +173,7 @@ export const Expand = {
   InviteInvitee: "invite.invitee",
 } as const;
 /**
- * An expansion scope that is valid for the object being requested.
+ * An expansion scope that is valid for the requested object.
  */
 export type Expand = ClosedEnum<typeof Expand>;
 

package/src/models/components/facility.ts

@@ -36,139 +36,355 @@ import {
   SystemSummary$outboundSchema,
 } from "./systemsummary.js";
 
+/**
+ * The facility's appointment settings. Present only when `facility.appointment_policy` is in `expand`.
+ */
 export type AppointmentPolicy = {
+  /**
+   * The number of days users can schedule a standing appointment ahead.
+   */
   standingApptPeriod?: string | undefined;
+  /**
+   * Instructions shown to people who request an appointment at the facility.
+   */
   apptRequestInfo?: string | undefined;
+  /**
+   * Whether vendors can request appointments at the facility.
+   */
   allowVendorApptRequests?: boolean | undefined;
+  /**
+   * Whether facility contacts can request appointments on behalf of vendors.
+   */
   allowContactApptRequests?: boolean | undefined;
+  /**
+   * Whether vendors with a pending approval status can request appointments.
+   */
   allowPendingVendorApptRequests?: boolean | undefined;
+  /**
+   * Whether a single appointment request can cover more than one facility.
+   */
   allowMultiFacilityApptRequests?: boolean | undefined;
+  /**
+   * The maximum number of invitees allowed on one appointment, or `null` if there is no limit.
+   */
   maxInvitesPerAppt?: number | undefined;
 };
 
+/**
+ * The people who serve as points of contact for the facility. Present only when `facility.contacts` is in `expand`.
+ */
 export type Contacts = {
   /**
-   * This object represents a contact at the system or facility level. Use it to verify vendors, create appointments, or check in visitors.
+   * Describes a contact at the system or facility level. Use it to verify vendors, create appointments, or check in visitors.
    */
   contact?: Contact | null | undefined;
   /**
-   * This object represents a contact at the system or facility level. Use it to verify vendors, create appointments, or check in visitors.
+   * Describes a contact at the system or facility level. Use it to verify vendors, create appointments, or check in visitors.
    */
   adminContact?: Contact | null | undefined;
   /**
-   * This object represents a contact at the system or facility level. Use it to verify vendors, create appointments, or check in visitors.
+   * Describes a contact at the system or facility level. Use it to verify vendors, create appointments, or check in visitors.
    */
   techContact?: Contact | null | undefined;
   /**
-   * This object represents a contact at the system or facility level. Use it to verify vendors, create appointments, or check in visitors.
+   * Describes a contact at the system or facility level. Use it to verify vendors, create appointments, or check in visitors.
    */
   greenSecurityCsm?: Contact | null | undefined;
   /**
-   * This object represents a contact at the system or facility level. Use it to verify vendors, create appointments, or check in visitors.
+   * Describes a contact at the system or facility level. Use it to verify vendors, create appointments, or check in visitors.
    */
   accountManager?: Contact | null | undefined;
 };
 
+/**
+ * Counts of vendors associated with the facility, grouped by relationship, subscription status, and approval status. Present only when `facility.vendor_counts` is in `expand`.
+ */
 export type VendorCounts = {
+  /**
+   * The number of approved vendors that target the facility and have an active subscription.
+   */
   countTargetedActiveApproved?: number | undefined;
+  /**
+   * The number of vendors pending approval that target the facility and have an active subscription.
+   */
   countTargetedActivePending?: number | undefined;
+  /**
+   * The number of approved vendors that target the facility and have an inactive subscription.
+   */
   countTargetedInactiveApproved?: number | undefined;
+  /**
+   * The number of vendors pending approval that target the facility and have an inactive subscription.
+   */
   countTargetedInactivePending?: number | undefined;
+  /**
+   * The number of approved vendors that have the facility as their primary facility and have an active subscription.
+   */
   countPrimaryActiveApproved?: number | undefined;
+  /**
+   * The number of vendors pending approval that have the facility as their primary facility and have an active subscription.
+   */
   countPrimaryActivePending?: number | undefined;
+  /**
+   * The number of approved vendors that have the facility as their primary facility and have an inactive subscription.
+   */
   countPrimaryInactiveApproved?: number | undefined;
+  /**
+   * The number of vendors pending approval that have the facility as their primary facility and have an inactive subscription.
+   */
   countPrimaryInactivePending?: number | undefined;
 };
 
+/**
+ * The flu credential the facility requires, or `null` if none is required. Returns the full credential when `facility.flu_credential` is in `expand`, and its ID otherwise.
+ */
 export type FacilityFluCredential = string | number;
 
+/**
+ * The facility's flu vaccination requirement and the period during which it applies.
+ */
 export type FluCredential = {
+  /**
+   * The flu credential the facility requires, or `null` if none is required. Returns the full credential when `facility.flu_credential` is in `expand`, and its ID otherwise.
+   */
   fluCredential?: string | number | null | undefined;
+  /**
+   * The date the flu season requirement starts, or `null` if not set.
+   */
   fluDateBegins?: Date | null | undefined;
+  /**
+   * The date the flu season requirement ends, or `null` if not set.
+   */
   fluDateEnds?: Date | null | undefined;
 };
 
+/**
+ * The facility's address and contact details.
+ */
 export type FacilityLocation = {
+  /**
+   * The street address of the facility, or `null` if not set.
+   */
   streetAddress?: string | null | undefined;
+  /**
+   * The city where the facility is located, or `null` if not set.
+   */
   city?: string | null | undefined;
+  /**
+   * The state where the facility is located, or `null` if not set.
+   */
   state?: string | null | undefined;
+  /**
+   * The postal code of the facility, or `null` if not set.
+   */
   zip?: string | null | undefined;
+  /**
+   * The general email address of the facility, or `null` if not set.
+   */
   email?: string | null | undefined;
+  /**
+   * The main phone number of the facility, or `null` if not set.
+   */
   phone?: string | null | undefined;
+  /**
+   * The fax number of the facility, or `null` if not set.
+   */
   fax?: string | null | undefined;
+  /**
+   * The website URL of the facility, or `null` if not set.
+   */
   website?: string | null | undefined;
   /**
    * The offset from UTC in hours (based on timezone).
    */
   utcOffset?: number | null | undefined;
   /**
-   * The timezone of the facility. This is used to display times in the facility's local time. Timezones are represented as TZ database names or friendly timezone [from this list](https://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html)
+   * The timezone of the facility. Clients use it to display times in the facility's local time. Timezones use IANA time zone (TZ) database names or friendly timezone names [from this list](https://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html)
    */
   timezone?: string | null | undefined;
 };
 
+/**
+ * The facility's scrubs settings. Present only when `facility.scrubs_policy` is in `expand`.
+ */
 export type ScrubsPolicy = {
+  /**
+   * Whether vendors can use an unlimited number of scrubs at the facility.
+   */
   unlimitedScrubs?: boolean | undefined;
+  /**
+   * The maximum number of scrub debits allowed per day.
+   */
   scrubDebitsPerDay?: number | undefined;
+  /**
+   * The minimum number of minutes required between two scrub debits.
+   */
   minutesBetweenScrubDebits?: number | undefined;
 };
 
+/**
+ * The system the facility belongs to. Returns the full system when `facility.system` is in `expand`, and only its `id` and `name` otherwise.
+ */
 export type FacilitySystem = SystemSummary | number;
 
+/**
+ * The Green Security features the facility uses.
+ */
 export type Uses = {
+  /**
+   * Whether the facility uses appointment calendaring.
+   */
   calendaring: boolean;
+  /**
+   * Whether the facility uses vendor credentialing.
+   */
   credentialing: boolean;
+  /**
+   * Whether the facility uses radio-frequency identification (RFID).
+   */
   rfid: boolean;
+  /**
+   * Whether the facility uses scrubs tracking.
+   */
   scrubs: boolean;
+  /**
+   * Whether the facility uses value analysis.
+   */
   valueAnalysis: boolean;
+  /**
+   * Whether the facility uses visitor management.
+   */
   visitorManagement: boolean;
+  /**
+   * Whether the facility can search visitors.
+   */
   visitorSearch: boolean;
 };
 
+/**
+ * Whether a vendor must exceed both the guest visit limit and the day limit (`and`), or either one (`or`), to be over the limit. Defaults to `or`.
+ */
 export const VendorGuestLimitAndOr = {
   And: "and",
   Or: "or",
 } as const;
+/**
+ * Whether a vendor must exceed both the guest visit limit and the day limit (`and`), or either one (`or`), to be over the limit. Defaults to `or`.
+ */
 export type VendorGuestLimitAndOr = OpenEnum<typeof VendorGuestLimitAndOr>;
 
+/**
+ * The facility's limits on vendor guests. Present only when `facility.vendor_guest_policy` is in `expand`.
+ */
 export type VendorGuestPolicy = {
+  /**
+   * Whether the facility limits how often a vendor can bring guests.
+   */
   enabled: boolean;
+  /**
+   * The maximum number of guest visits allowed for a vendor.
+   */
   vendorGuestLimit?: number | undefined;
+  /**
+   * Whether a vendor must exceed both the guest visit limit and the day limit (`and`), or either one (`or`), to be over the limit. Defaults to `or`.
+   */
   vendorGuestLimitAndOr?: VendorGuestLimitAndOr | undefined;
+  /**
+   * The number of days over which the facility measures the guest limit.
+   */
   vendorGuestLimitDays?: number | undefined;
+  /**
+   * Whether vendors must provide an email address for each guest.
+   */
   vendorGuestRequireEmail: boolean;
 };
 
+/**
+ * The facility's rules for vendors. Present only when `facility.vendor_policy` is in `expand`.
+ */
 export type FacilityVendorPolicy = {
+  /**
+   * Whether vendors can enter a department that is not on the facility's list.
+   */
   allowDepartmentOther: boolean;
+  /**
+   * Whether vendors are allowed to bring food to the facility.
+   */
   allowFood: boolean;
   /**
-   * Whether automatic GPS check-out is enabled for the whole facility. When it is, it supersedes the per-zone allow_gps_checkout setting for every zone in the facility. Only takes effect once gps_checkout_radius and the facility coordinates are all set.
+   * Whether automatic Global Positioning System (GPS) check-out is enabled for the whole facility. When it is, it supersedes the per-zone `allow_gps_checkout` setting for every zone in the facility. Only takes effect once `gps_checkout_radius` and the facility coordinates are all set.
    */
   allowGpsCheckout: boolean;
+  /**
+   * Whether vendors can check out without using a kiosk.
+   */
   allowNonKioskCheckouts: boolean;
+  /**
+   * Whether a vendor who is still checked in after leaving is automatically scanned out and flagged as a violation.
+   */
   autoScanOutViolation: boolean;
+  /**
+   * Whether contractors must provide an email address for each guest.
+   */
   contractorGuestRequireEmail: boolean;
   /**
    * Radius in feet around the facility coordinates used for facility-level automatic GPS check-out.
    */
   gpsCheckoutRadius?: number | null | undefined;
+  /**
+   * Whether visitors must provide a phone number when they check in.
+   */
   visitorCheckinRequirePhone: boolean;
+  /**
+   * The vendor types the facility uses, including any custom names and who each one applies to.
+   */
   vendorTypes: Array<FacilityVendorType>;
 };
 
+/**
+ * The facility's rules for visitors. Present only when `facility.visitor_policy` is in `expand`.
+ */
 export type VisitorPolicy = {
+  /**
+   * Whether visitors are checked out automatically.
+   */
   autoCheckoutVisitors: boolean;
+  /**
+   * Whether a visit request must specify a zone.
+   */
   requireVisitRequestZone: boolean;
+  /**
+   * Whether visit requests show the general visitor option.
+   */
   showGeneralVisitor: boolean;
+  /**
+   * Whether the facility stores the driver's license number of visitors.
+   */
   storeVisitorDlNumber: boolean;
+  /**
+   * Which demographic details a visit request collects.
+   */
   visitRequestDemographics?: string | undefined;
+  /**
+   * The visitor subtypes that visitors can choose from at the facility.
+   */
   visitorSubtypes?: Array<string> | undefined;
 };
 
+/**
+ * The facility's approval settings for change requests. Present only when `facility.workflow_policy` is in `expand`.
+ */
 export type WorkflowPolicy = {
+  /**
+   * Whether the facility approves department change requests automatically.
+   */
   autoApproveDeptChangeRequests: boolean;
+  /**
+   * Whether the facility approves role change requests automatically.
+   */
   autoApproveRoleChangeRequests: boolean;
+  /**
+   * Whether the facility approves zone change requests automatically.
+   */
   autoApproveZoneChangeRequests: boolean;
 };
 
@@ -176,27 +392,81 @@ export type WorkflowPolicy = {
  * Describes a facility which typically represents a physical building or logical grouping of offices which act as a single entity.
  */
 export type Facility = {
+  /**
+   * The facility's appointment settings. Present only when `facility.appointment_policy` is in `expand`.
+   */
   appointmentPolicy?: AppointmentPolicy | null | undefined;
+  /**
+   * The people who serve as points of contact for the facility. Present only when `facility.contacts` is in `expand`.
+   */
   contacts?: Contacts | null | undefined;
+  /**
+   * Counts of vendors associated with the facility, grouped by relationship, subscription status, and approval status. Present only when `facility.vendor_counts` is in `expand`.
+   */
   vendorCounts?: VendorCounts | null | undefined;
+  /**
+   * The email domain associated with the facility, or `null` if none is set.
+   */
   emailDomain?: string | null | undefined;
+  /**
+   * The name of the facility's type, or `null` if none is set.
+   */
   facilityType?: string | null | undefined;
+  /**
+   * The facility's flu vaccination requirement and the period during which it applies.
+   */
   fluCredential?: FluCredential | undefined;
+  /**
+   * The unique ID of the facility.
+   */
   id?: number | undefined;
   /**
-   * A set of images in different sizes. URLs for private images (such as headshots, driver's licenses and visitor faces) are signed and expire after one to two hours, so fetch the record again for fresh URLs instead of storing them.
+   * A set of images in different sizes. URLs for private images (such as headshots, driver's licenses and visitor faces) are signed and expire after one to two hours. Fetch the record again for fresh URLs instead of storing them.
    */
   imageUrls?: ImageSet | null | undefined;
+  /**
+   * The facility's address and contact details.
+   */
   location?: FacilityLocation | undefined;
+  /**
+   * The name of the facility.
+   */
   name?: string | undefined;
+  /**
+   * The facility's scrubs settings. Present only when `facility.scrubs_policy` is in `expand`.
+   */
   scrubsPolicy?: ScrubsPolicy | null | undefined;
+  /**
+   * The status of the facility.
+   */
   status?: string | undefined;
+  /**
+   * The system the facility belongs to. Returns the full system when `facility.system` is in `expand`, and only its `id` and `name` otherwise.
+   */
   system?: SystemSummary | number | undefined;
+  /**
+   * The Green Security features the facility uses.
+   */
   uses?: Uses | undefined;
+  /**
+   * The facility's limits on vendor guests. Present only when `facility.vendor_guest_policy` is in `expand`.
+   */
   vendorGuestPolicy?: VendorGuestPolicy | null | undefined;
+  /**
+   * The facility's rules for vendors. Present only when `facility.vendor_policy` is in `expand`.
+   */
   vendorPolicy?: FacilityVendorPolicy | null | undefined;
+  /**
+   * Whether the Green Security website shows the facility.
+   */
   visible?: boolean | undefined;
+  /**
+   * The facility's rules for visitors. Present only when `facility.visitor_policy` is in `expand`.
+   */
   visitorPolicy?: VisitorPolicy | null | undefined;
+  /**
+   * The facility's approval settings for change requests. Present only when `facility.workflow_policy` is in `expand`.
+   */
   workflowPolicy?: WorkflowPolicy | null | undefined;
 };
 

package/src/models/components/facilitycalendarsummary.ts

@@ -16,19 +16,43 @@ import {
 } from "./facilityvendortype.js";
 
 export type FacilityCalendarSummaryVendorPolicy = {
+  /**
+   * The vendor types defined by the facility's vendor policy.
+   */
   vendorTypes?: Array<FacilityVendorType> | undefined;
 };
 
 /**
- * FacilitySummary extended with appointment options for calendaring.
+ * `FacilitySummary` extended with appointment options for calendaring.
  */
 export type FacilityCalendarSummary = {
+  /**
+   * The unique ID of the facility.
+   */
   id?: number | undefined;
+  /**
+   * The name of the facility.
+   */
   name?: string | undefined;
+  /**
+   * The ID of the system the facility belongs to.
+   */
   systemId?: number | undefined;
+  /**
+   * The status of the facility. `null` if no status is set.
+   */
   status?: string | null | undefined;
+  /**
+   * The facility's vendor policy. `null` if the facility has no vendor policy.
+   */
   vendorPolicy?: FacilityCalendarSummaryVendorPolicy | null | undefined;
+  /**
+   * Whether users can schedule appointments with this facility.
+   */
   allowUserAppointments?: boolean | undefined;
+  /**
+   * Whether users can schedule appointments with departments in this facility.
+   */
   allowDeptAppointments?: boolean | undefined;
 };
 

package/src/models/components/facilitysummary.ts

@@ -16,17 +16,35 @@ import {
 } from "./facilityvendortype.js";
 
 export type VendorPolicy = {
+  /**
+   * The vendor types defined by the facility's vendor policy.
+   */
   vendorTypes?: Array<FacilityVendorType> | undefined;
 };
 
 /**
- * A simplified representation of a Facility, typically used in list views.
+ * A simplified representation of a facility, typically used in list views.
  */
 export type FacilitySummary = {
+  /**
+   * The unique ID of the facility.
+   */
   id?: number | undefined;
+  /**
+   * The name of the facility.
+   */
   name?: string | undefined;
+  /**
+   * The ID of the system the facility belongs to.
+   */
   systemId?: number | undefined;
+  /**
+   * The status of the facility. `null` if no status is set.
+   */
   status?: string | null | undefined;
+  /**
+   * The facility's vendor policy. `null` if the facility has no vendor policy.
+   */
   vendorPolicy?: VendorPolicy | null | undefined;
 };