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

package/src/admin-funcs/networksList.ts

@@ -0,0 +1,56 @@
+import { APIPromise } from "../types/async.js";
+import { $doGetSingle, internalApiResult } from "./doAdmin.js";
+
+export type networksListSortField =
+  | "id"
+  | "name"
+  | "setup_complete"
+  | "created_at"
+  | "updated_at";
+
+export type networksListRequest = {
+  facilityId?: number;
+  setupComplete?: boolean;
+  page?: number;
+  itemsPerPage?: number;
+  sort?: networksListSortField;
+  desc?: boolean;
+};
+
+// The Wi-Fi/Ethernet configurations a facility hands to its Gatekeeper devices.
+//
+// Internal rather than part of the public spec: a network only means anything to the admin
+// surfaces that provision our own hardware, and it carries the shape of credentials we hold on
+// the operator's behalf — not something a third-party SDK consumer has any use for. See the
+// public/app-only split in AGENTS.md.
+//
+// Every filter is optional and the server answers with the caller's own scope when none is
+// given, so the no-argument call is the safe default rather than a request for everything.
+//
+// setupComplete is checked against undefined rather than for truthiness: `false` is a filter a
+// caller genuinely wants (the networks still being provisioned), not an absent one.
+export function networksList(
+  request: networksListRequest = {},
+): internalApiResult {
+  const query: Record<string, string | number | boolean> = {};
+  if (request.facilityId !== undefined) {
+    query["facility_id"] = request.facilityId;
+  }
+  if (request.setupComplete !== undefined) {
+    query["setup_complete"] = request.setupComplete;
+  }
+  if (request.page !== undefined) {
+    query["page"] = request.page;
+  }
+  if (request.itemsPerPage !== undefined) {
+    query["items_per_page"] = request.itemsPerPage;
+  }
+  if (request.sort !== undefined) {
+    query["sort"] = request.sort;
+  }
+  if (request.desc !== undefined) {
+    query["desc"] = request.desc;
+  }
+
+  return new APIPromise($doGetSingle("/networks", query));
+}

package/src/admin-funcs/zoneDevicesGet.ts

@@ -0,0 +1,13 @@
+import { APIPromise } from "../types/async.js";
+import { $doGetSingle, internalApiResult } from "./doAdmin.js";
+
+// One zone device (a gateway), for the detail screen zoneDevicesList leads to.
+//
+// Internal for the same reason as zoneDevicesList: our own device inventory. See the
+// public/app-only split in AGENTS.md.
+//
+// Gateways only. The kiosks that zoneDevicesList folds into the same list live in a different
+// table and are not addressable here, so their ids do not belong in this call.
+export function zoneDevicesGet(zoneDeviceId: number): internalApiResult {
+  return new APIPromise($doGetSingle(`/zone-devices/${zoneDeviceId}`, {}));
+}

package/src/admin-funcs/zoneDevicesList.ts

@@ -0,0 +1,47 @@
+import { APIPromise } from "../types/async.js";
+import { $doGetSingle, internalApiResult } from "./doAdmin.js";
+
+export type zoneDevicesListSortField = "id" | "name";
+
+export type zoneDevicesListRequest = {
+  facilityId?: number;
+  page?: number;
+  itemsPerPage?: number;
+  sort?: zoneDevicesListSortField;
+  desc?: boolean;
+};
+
+// The caller's devices — kiosks and zone gateways alike — grouped by facility.
+//
+// Internal rather than part of the public spec: this is the device inventory behind our own
+// admin surfaces, and it merges two unrelated tables into a shape only those screens read. See
+// the public/app-only split in AGENTS.md.
+//
+// The page is a page of FACILITIES, not of devices: paging the devices would cut a facility in
+// half, so `itemsPerPage` counts facilities and the nested device arrays come back whole. A
+// facility holds a handful of devices, so those arrays stay bounded.
+//
+// Facilities holding no device at all are left out, so an empty response means the caller
+// reaches no device rather than that the filter matched nothing.
+export function zoneDevicesList(
+  request: zoneDevicesListRequest = {},
+): internalApiResult {
+  const query: Record<string, string | number | boolean> = {};
+  if (request.facilityId !== undefined) {
+    query["facility_id"] = request.facilityId;
+  }
+  if (request.page !== undefined) {
+    query["page"] = request.page;
+  }
+  if (request.itemsPerPage !== undefined) {
+    query["items_per_page"] = request.itemsPerPage;
+  }
+  if (request.sort !== undefined) {
+    query["sort"] = request.sort;
+  }
+  if (request.desc !== undefined) {
+    query["desc"] = request.desc;
+  }
+
+  return new APIPromise($doGetSingle("/zone-devices", query));
+}

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