@greensecurity/javascript-sdk 0.45.0 → 0.46.0-beta.2

package/src/funcs/vendorsListVendorScrubPurchases.ts

@@ -38,6 +38,8 @@ import {
  * @remarks
  * List vendor scrub purchases
  *
+ * **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.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function vendorsListVendorScrubPurchases(

package/src/funcs/vendorsListVendorTypes.ts

@@ -38,6 +38,8 @@ import {
  * @remarks
  * List vendor types.
  *
+ * **Permissions.** No authentication required. A token is accepted if supplied, but anonymous callers are allowed.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function vendorsListVendorTypes(

package/src/funcs/vendorsListVendors.ts

@@ -42,41 +42,45 @@ import {
  * Common use cases for this are 1099 contractors who represent multiple companies or any vendor that has their
  * credentials or payments handled by a company other than the one they use to do business with a facility.
  *
- * Available `expand` scopes are:
+ * **Permissions.** Requires the `vendors.view` permission.
  *
- * vendor.user
- * vendor.vendor_type
- * vendor.vendor_job
- * vendor.image_urls
- * vendor.payment_profile
- * vendor.primary_facility
- * vendor.primary_department
- * vendor.company
- * vendor.credentialing_subscription
- * vendor.scrubs_subscription
- * vendor.payment_responsibility
- * vendor.background_check_date_expires
- * vendor.credit_balance
- * vendor.registration_data
- * vendor.registration_finished
- * vendor.target_facilities
- * vendor.approved_calendaring_facilities
- * vendor.pending_invoice
- * vendor.vendor_groups
- * vendor.has_credentialed_facilities
- * vendor.has_emerald_status
- * vendor.custom_fields
- * vendor.last_scanned
+ * Available `expand` scopes are:
  *
- * Subscription expand scopes (require vendor.credentialing_subscription):
+ * - `vendor.user`
+ * - `vendor.vendor_type`
+ * - `vendor.vendor_job`
+ * - `vendor.badge_details`
+ * - `vendor.required_badge_type`
+ * - `vendor.image_urls`
+ * - `vendor.payment_profile`
+ * - `vendor.primary_facility`
+ * - `vendor.primary_department`
+ * - `vendor.company`
+ * - `vendor.credentialing_subscription`
+ * - `vendor.scrubs_subscription`
+ * - `vendor.payment_responsibility`
+ * - `vendor.background_check_date_expires`
+ * - `vendor.credit_balance`
+ * - `vendor.registration_data`
+ * - `vendor.registration_finished`
+ * - `vendor.target_facilities`
+ * - `vendor.approved_calendaring_facilities`
+ * - `vendor.pending_invoice`
+ * - `vendor.vendor_groups`
+ * - `vendor.has_credentialed_facilities`
+ * - `vendor.has_emerald_status`
+ * - `vendor.has_target_facility_questions`
+ * - `vendor.custom_fields`
+ * - `vendor.last_scanned`
+ * - `subscription.current_line_item`
+ * - `subscription.date_ends`
+ * - `subscription.variant_title`
+ * - `subscription.next_line_item`
+ * - `subscription.current_financial_status`
+ * - `subscription.next_financial_status`
+ * - `subscription.expedited_offers`
  *
- * subscription.date_ends
- * subscription.variant_title
- * subscription.current_line_item
- * subscription.next_line_item
- * subscription.current_financial_status
- * subscription.next_financial_status
- * subscription.expedited_offers
+ * Any other value is rejected with `422 Unprocessable Entity`.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/src/funcs/vendorsPurchaseScrubCredits.ts

@@ -32,6 +32,8 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Purchase scrub credits
  *
+ * **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.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function vendorsPurchaseScrubCredits(

package/src/funcs/vendorsSendDownloadCode.ts

@@ -33,6 +33,8 @@ import * as types$ from "../types/primitives.js";
  * @remarks
  * It will send download code for vendor credential
  *
+ * **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.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function vendorsSendDownloadCode(

package/src/funcs/vendorsSubmitVendorCredential.ts

@@ -33,6 +33,8 @@ import * as types$ from "../types/primitives.js";
  * @remarks
  * It will submit vendor credential
  *
+ * **Permissions.** Requires the `vendor_credentials.view` permission.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function vendorsSubmitVendorCredential(

package/src/funcs/vendorsUpdateVendorCredentialData.ts

@@ -33,6 +33,8 @@ import * as types$ from "../types/primitives.js";
  * @remarks
  * Update vendor credential data
  *
+ * **Permissions.** Requires the `vendor_credentials.edit` permission.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function vendorsUpdateVendorCredentialData(

package/src/funcs/vendorsUpdateVendorCredentialFile.ts

@@ -33,6 +33,8 @@ import * as types$ from "../types/primitives.js";
  * @remarks
  * It will update the vendor credential file properties
  *
+ * **Permissions.** Requires the `vendor_credentials.view` permission.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function vendorsUpdateVendorCredentialFile(

package/src/funcs/vendorsUpdateVendorCustomField.ts

@@ -40,6 +40,8 @@ import { Result } from "../types/fp.js";
  * Accepts a numeric vendor ID, `me` for the authenticated vendor,
  * or an active QR code (format: contains hyphens).
  *
+ * **Permissions.** Requires the `vendors.edit` permission.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function vendorsUpdateVendorCustomField(

package/src/funcs/vendorsUpdateVendorDetails.ts

@@ -54,6 +54,8 @@ import * as types$ from "../types/primitives.js";
  * exception — it accepts only the values in its enum, so send one of those to
  * change it and omit it to leave it unchanged.
  *
+ * **Permissions.** Requires the `vendors.edit` permission.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function vendorsUpdateVendorDetails(

package/src/funcs/vendorsUpdateVendorManagedByCompany.ts

@@ -32,6 +32,8 @@ import { Result } from "../types/fp.js";
  * @remarks
  * It will update the vendor managed by company access rights
  *
+ * **Permissions.** Requires the `vendors.edit` permission.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function vendorsUpdateVendorManagedByCompany(

package/src/funcs/vendorsUpdateVendorPaymentResponsibility.ts

@@ -36,6 +36,8 @@ import { Result } from "../types/fp.js";
  * authenticated manager's own user ID (to claim responsibility). Omitted fields
  * are left unchanged.
  *
+ * **Permissions.** Requires the `vendors.edit` permission.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function vendorsUpdateVendorPaymentResponsibility(

package/src/funcs/vendorsUpdateVendorScrubDetails.ts

@@ -33,6 +33,8 @@ import * as types$ from "../types/primitives.js";
  * @remarks
  * Update vendor scrub details
  *
+ * **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.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function vendorsUpdateVendorScrubDetails(

package/src/funcs/vendorsVendorsExport.ts

@@ -39,6 +39,46 @@ import { Result } from "../types/fp.js";
  * Returns a `status_url` to poll until the export is ready, plus a
  * `download_url` and `status_id`.
  *
+ * **Permissions.** Requires the `vendors.view` permission.
+ *
+ * Available `expand` scopes are:
+ *
+ * - `vendor.user`
+ * - `vendor.vendor_type`
+ * - `vendor.vendor_job`
+ * - `vendor.badge_details`
+ * - `vendor.required_badge_type`
+ * - `vendor.image_urls`
+ * - `vendor.payment_profile`
+ * - `vendor.primary_facility`
+ * - `vendor.primary_department`
+ * - `vendor.company`
+ * - `vendor.credentialing_subscription`
+ * - `vendor.scrubs_subscription`
+ * - `vendor.payment_responsibility`
+ * - `vendor.background_check_date_expires`
+ * - `vendor.credit_balance`
+ * - `vendor.registration_data`
+ * - `vendor.registration_finished`
+ * - `vendor.target_facilities`
+ * - `vendor.approved_calendaring_facilities`
+ * - `vendor.pending_invoice`
+ * - `vendor.vendor_groups`
+ * - `vendor.has_credentialed_facilities`
+ * - `vendor.has_emerald_status`
+ * - `vendor.has_target_facility_questions`
+ * - `vendor.custom_fields`
+ * - `vendor.last_scanned`
+ * - `subscription.current_line_item`
+ * - `subscription.date_ends`
+ * - `subscription.variant_title`
+ * - `subscription.next_line_item`
+ * - `subscription.current_financial_status`
+ * - `subscription.next_financial_status`
+ * - `subscription.expedited_offers`
+ *
+ * Any other value is rejected with `422 Unprocessable Entity`. The export job builds its own columns and does not consult `expand`, so the parameter is validated but has no effect on the generated CSV; it is accepted for backwards compatibility.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function vendorsVendorsExport(

package/src/funcs/webhooksCreateWebhookEndpoint.ts

@@ -46,6 +46,8 @@ import { Result } from "../types/fp.js";
  * site-wide marketplace app installations, to every event of the site.
  *
  * Requires the `webhook` / `add` permission.
+ *
+ * **Permissions.** Requires the `webhook.add` permission.
  */
 export function webhooksCreateWebhookEndpoint(
   client: GreenSecurityCore,

package/src/funcs/webhooksDeleteWebhookEndpoint.ts

@@ -38,6 +38,8 @@ import { Result } from "../types/fp.js";
  * events for entities it lost access to.
  *
  * Requires the `webhook` / `delete` permission.
+ *
+ * **Permissions.** Requires the `webhook.delete` permission.
  */
 export function webhooksDeleteWebhookEndpoint(
   client: GreenSecurityCore,

package/src/funcs/webhooksGetWebhookEndpoint.ts

@@ -38,6 +38,8 @@ import { Result } from "../types/fp.js";
  * indistinguishable from one that does not exist.
  *
  * Requires the `webhook` / `view` permission.
+ *
+ * **Permissions.** Requires the `webhook.view` permission.
  */
 export function webhooksGetWebhookEndpoint(
   client: GreenSecurityCore,

package/src/funcs/webhooksListAllWebhookEndpoints.ts

@@ -43,6 +43,8 @@ import {
  * Sortable by `id`, `webhook_url`, `created_at` and `updated_at`.
  *
  * Requires the `webhook` / `view` permission.
+ *
+ * **Permissions.** Requires the `webhook.view` permission.
  */
 export function webhooksListAllWebhookEndpoints(
   client: GreenSecurityCore,

package/src/funcs/webhooksUpdatesTheWebhookEndpointWithTheGivenId.ts

@@ -56,6 +56,8 @@ import { Result } from "../types/fp.js";
  * ignored if you send them back.
  *
  * Requires the `webhook` / `edit` permission.
+ *
+ * **Permissions.** Requires the `webhook.edit` permission.
  */
 export function webhooksUpdatesTheWebhookEndpointWithTheGivenId(
   client: GreenSecurityCore,

package/src/funcs/zonesGetSecurityZone.ts

@@ -33,11 +33,15 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Get security zone details
  *
+ * **Permissions.** Requires the `zones.view` permission.
+ *
  * Available `expand` scopes are:
  *
- * - zone.facility
- * - zone.department
- * - zone.rules
+ * - `zone.facility`
+ * - `zone.department`
+ * - `zone.rules`
+ *
+ * Unrecognised values are ignored.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/src/funcs/zonesListOrSearchSecurityZones.ts

@@ -38,6 +38,8 @@ import {
  * @remarks
  * List or search security zones
  *
+ * **Permissions.** Requires the `zones.view` permission.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function zonesListOrSearchSecurityZones(

package/src/funcs/zonesSecurityZoneCheckin.ts

@@ -32,6 +32,8 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Security zone checkin request
  *
+ * **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.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function zonesSecurityZoneCheckin(

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",
-  genVersion: "2.937.18",
+  sdkVersion: "0.46.0-beta.2",
+  genVersion: "2.941.0",
   userAgent:
-    "speakeasy-sdk/typescript 0.45.0 2.937.18 0.45.0 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.46.0-beta.2 2.941.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`,
+  );
+}