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

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.15",
+  sdkVersion: "0.48.0-beta.17",
   genVersion: "2.954.8",
   userAgent:
-    "speakeasy-sdk/typescript 0.48.0-beta.15 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.
    */