@greensecurity/javascript-sdk 0.48.0-beta.16 → 0.48.0-beta.17

package/src/__tests__/vendors.test.ts

@@ -121,7 +121,7 @@ test("Vendors List Vendor Credits", async () => {
       page: 1,
       useUrlParams: false,
     },
-    creditBalance: 6030.32,
+    creditBalance: 1782.61,
   });
 });
 

package/src/__tests__/webhooks.test.ts

@@ -20,7 +20,7 @@ test("Webhooks List All Webhook Endpoints", async () => {
   const testWebhookListForVendorUserResult = await greenSecurity.webhooks
     .listAllWebhookEndpoints({
       itemsPerPage: 25,
-      desc: true,
+      desc: 0,
       sort: "",
     });
   expect(testWebhookListForVendorUserResult).toBeDefined();
@@ -62,11 +62,10 @@ test("Webhooks Updates The Webhook Endpoint With The Given Id", async () => {
       id: 220782,
       webhookEndpointUpdate: {
         webhookUrl: "https://example.com/webhook/incoming",
-        subscriptions: {
-          model: "Vendor",
-          action: "updated",
-          expands: "vendor.company,vendor.user",
-        },
+        subscriptions: [
+          "Vendor.updated",
+          "Vendor.created",
+        ],
         consumers: {
           systemId: 1,
           facilityId: 1,

package/src/__tests__/zoneDevicesCreate.test.ts

@@ -73,6 +73,33 @@ describe("__internal.zoneDevices", () => {
     });
   });
 
+  it("puts the Wi-Fi firmware version to /zone-devices/:id/firmware-versions", () => {
+    __internal.zoneDevices.firmwareVersions(42, { wifi_version: "v3.8.6" });
+
+    expect(doPutMock).toHaveBeenCalledWith("/zone-devices/42/firmware-versions", { wifi_version: "v3.8.6" });
+  });
+
+  it("puts the BLE firmware version to /zone-devices/:id/firmware-versions", () => {
+    __internal.zoneDevices.firmwareVersions(42, { ble_version: "v1.2.3" });
+
+    expect(doPutMock).toHaveBeenCalledWith("/zone-devices/42/firmware-versions", { ble_version: "v1.2.3" });
+  });
+
+  it("puts both firmware versions verbatim to /zone-devices/:id/firmware-versions", () => {
+    __internal.zoneDevices.firmwareVersions(42, { wifi_version: "v3.8.6", ble_version: "v1.2.3" });
+
+    expect(doPutMock).toHaveBeenCalledWith("/zone-devices/42/firmware-versions", {
+      wifi_version: "v3.8.6",
+      ble_version: "v1.2.3",
+    });
+  });
+
+  it("posts an empty body to /zone-devices/:id/firmware-update", () => {
+    __internal.zoneDevices.firmwareUpdate(42);
+
+    expect(doPostMock).toHaveBeenCalledWith("/zone-devices/42/firmware-update", {});
+  });
+
   // a5d10295d4 once dropped these from __internal while gatekeeper-client still called them.
   it("keeps the gatekeeper networks and zone device calls exported", () => {
     expect(__internal.networks).toEqual({

package/src/__tests__/zoneDevicesList.test.ts

@@ -47,6 +47,8 @@ describe("zoneDevicesList", () => {
       macAvailability: expect.any(Function),
       provisioning: expect.any(Function),
       delete: expect.any(Function),
+      firmwareVersions: expect.any(Function),
+      firmwareUpdate: expect.any(Function),
     });
     expect(__internal.networks).toEqual({
       list: networksList,

package/src/__tests__/zones.test.ts

@@ -36,26 +36,7 @@ test("Zones List Or Search Security Zones", async () => {
     },
     items: [
       {
-        facility: {
-          contacts: {
-            contact: {
-              status: "Inactive",
-              department: 123,
-            },
-            adminContact: {
-              status: "Active",
-              department: null,
-            },
-            techContact: null,
-            greenSecurityCsm: null,
-            accountManager: null,
-          },
-          vendorGuestPolicy: {
-            enabled: false,
-            vendorGuestLimitAndOr: "and",
-            vendorGuestRequireEmail: false,
-          },
-        },
+        facility: {},
       },
       {
         facility: {},
@@ -77,7 +58,7 @@ test("Zones Security Zone Checkin", async () => {
 
   const result = await greenSecurity.zones.securityZoneCheckin({
     qrCode: "<value>",
-    zoneId: 598772,
+    zoneId: 544883,
   });
   expect(result).toBeDefined();
   expect(result).toEqual({});

package/src/admin-funcs/zoneDevicesFirmwareUpdate.ts

@@ -0,0 +1,11 @@
+import { APIPromise } from "../types/async.js";
+import { $doPost, internalApiResult } from "./doAdmin.js";
+
+// Starts a gateway firmware update (the Update button on device details). The update runs over
+// MQTT; follow it by polling zoneDevicesGet for `firmware_update_status`. Returns the device.
+//
+// Internal for the same reason as zoneDevicesUpdate. 409 when an update is already running, 422
+// when the gateway is already on the target firmware.
+export function zoneDevicesFirmwareUpdate(zoneDeviceId: number): internalApiResult {
+  return new APIPromise($doPost(`/zone-devices/${zoneDeviceId}/firmware-update`, {}));
+}

package/src/admin-funcs/zoneDevicesFirmwareVersions.ts

@@ -0,0 +1,19 @@
+import { APIPromise } from "../types/async.js";
+import { $doPut, internalApiResult } from "./doAdmin.js";
+
+// Wire names, posted verbatim. Versions look like `v3.8.6`; send whichever the gateway reported.
+export type zoneDevicesFirmwareVersionsRequest = {
+  wifi_version?: string;
+  ble_version?: string;
+};
+
+// Records the firmware the Gatekeeper app read off a gateway while connected to it. A gateway
+// behind the target firmware is then updated automatically over MQTT. Returns the device.
+//
+// Internal for the same reason as zoneDevicesUpdate.
+export function zoneDevicesFirmwareVersions(
+  zoneDeviceId: number,
+  request: zoneDevicesFirmwareVersionsRequest
+): internalApiResult {
+  return new APIPromise($doPut(`/zone-devices/${zoneDeviceId}/firmware-versions`, request));
+}

package/src/funcs/vendorsChangeSubscription.ts

@@ -32,8 +32,9 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Changes a vendor's credentialing subscription by updating the vendor type,
  * the target facilities, or both. If the selection increases the subscription
- * price, the server creates an invoice and charges the payment profile; the
- * response includes the invoice id.
+ * price, the server creates an invoice and charges the payment profile for the
+ * invoice total, including any tax and convenience fee; the response includes
+ * the invoice id.
  *
  * **Permissions.** Requires the `vendor_transactions.add` permission.
  *

package/src/index.extras.ts

@@ -80,6 +80,8 @@ import { zoneDevicesMacAvailability } from "./admin-funcs/zoneDevicesMacAvailabi
 import { zoneDevicesUpdate } from "./admin-funcs/zoneDevicesUpdate.js";
 import { zoneDevicesProvisioning } from "./admin-funcs/zoneDevicesProvisioning.js";
 import { zoneDevicesDelete } from "./admin-funcs/zoneDevicesDelete.js";
+import { zoneDevicesFirmwareVersions } from "./admin-funcs/zoneDevicesFirmwareVersions.js";
+import { zoneDevicesFirmwareUpdate } from "./admin-funcs/zoneDevicesFirmwareUpdate.js";
 import { lookupsAddressValidation } from "./admin-funcs/lookupsAddressValidation.js";
 import { lookupsAddressAutocomplete } from "./admin-funcs/lookupsAddressAutocomplete.js";
 import { lookupsAddressPlace } from "./admin-funcs/lookupsAddressPlace.js";
@@ -219,6 +221,8 @@ export const __internal = {
     update: zoneDevicesUpdate,
     provisioning: zoneDevicesProvisioning,
     delete: zoneDevicesDelete,
-    macAvailability: zoneDevicesMacAvailability
+    macAvailability: zoneDevicesMacAvailability,
+    firmwareVersions: zoneDevicesFirmwareVersions,
+    firmwareUpdate: zoneDevicesFirmwareUpdate
   }
 };

package/src/lib/config.ts

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

package/src/react-query/vendorsChangeSubscription.ts

@@ -52,8 +52,9 @@ export type VendorsChangeSubscriptionMutationError =
  * @remarks
  * Changes a vendor's credentialing subscription by updating the vendor type,
  * the target facilities, or both. If the selection increases the subscription
- * price, the server creates an invoice and charges the payment profile; the
- * response includes the invoice id.
+ * price, the server creates an invoice and charges the payment profile for the
+ * invoice total, including any tax and convenience fee; the response includes
+ * the invoice id.
  *
  * **Permissions.** Requires the `vendor_transactions.add` permission.
  */

package/src/sdk/vendors.ts

@@ -744,8 +744,9 @@ export class Vendors extends ClientSDK {
    * @remarks
    * Changes a vendor's credentialing subscription by updating the vendor type,
    * the target facilities, or both. If the selection increases the subscription
-   * price, the server creates an invoice and charges the payment profile; the
-   * response includes the invoice id.
+   * price, the server creates an invoice and charges the payment profile for the
+   * invoice total, including any tax and convenience fee; the response includes
+   * the invoice id.
    *
    * **Permissions.** Requires the `vendor_transactions.add` permission.
    */