@greensecurity/javascript-sdk 0.48.0 → 0.49.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@greensecurity/javascript-sdk",
-  "version": "0.48.0",
+  "version": "0.49.0-beta.1",
   "author": "Green Security LLC",
   "type": "module",
   "tshy": {

package/src/__tests__/users.test.ts

@@ -116,8 +116,11 @@ test("Users Update User", async () => {
     user: {
       id: 123,
       firstName: "John",
+      middleName: "Marie",
       lastName: "Doe",
       email: "john@example.com",
+      workEmail: "john.doe@acme.com",
+      personalEmail: "john.doe@gmail.com",
       phone: "555-555-5555",
       userType: "Facility User",
       timezone: "America/Chicago",

package/src/__tests__/vendors.test.ts

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

package/src/__tests__/webhooks.test.ts

@@ -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,54 @@ 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("puts auto_update verbatim to /zone-devices/:id/firmware-versions", () => {
+    __internal.zoneDevices.firmwareVersions(42, { wifi_version: "v3.8.6", auto_update: true });
+
+    expect(doPutMock).toHaveBeenCalledWith("/zone-devices/42/firmware-versions", {
+      wifi_version: "v3.8.6",
+      auto_update: true,
+    });
+  });
+
+  it("posts an empty body to /zone-devices/:id/firmware-update", () => {
+    __internal.zoneDevices.firmwareUpdate(42);
+
+    expect(doPostMock).toHaveBeenCalledWith("/zone-devices/42/firmware-update", {});
+  });
+
+  it("posts an empty body to /zone-devices/:id/reboot", () => {
+    __internal.zoneDevices.reboot(42);
+
+    expect(doPostMock).toHaveBeenCalledWith("/zone-devices/42/reboot", {});
+  });
+
+  it("posts an empty body to /zone-devices/:id/factory-reset", () => {
+    __internal.zoneDevices.factoryReset(42);
+
+    expect(doPostMock).toHaveBeenCalledWith("/zone-devices/42/factory-reset", {});
+  });
+
   // 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,10 @@ describe("zoneDevicesList", () => {
       macAvailability: expect.any(Function),
       provisioning: expect.any(Function),
       delete: expect.any(Function),
+      firmwareVersions: expect.any(Function),
+      firmwareUpdate: expect.any(Function),
+      reboot: expect.any(Function),
+      factoryReset: expect.any(Function),
     });
     expect(__internal.networks).toEqual({
       list: networksList,

package/src/__tests__/zones.test.ts

@@ -58,7 +58,7 @@ test("Zones Security Zone Checkin", async () => {
 
   const result = await greenSecurity.zones.securityZoneCheckin({
     qrCode: "<value>",
-    zoneId: 544883,
+    zoneId: 440362,
   });
   expect(result).toBeDefined();
   expect(result).toEqual({});

package/src/admin-funcs/zoneDevicesFactoryReset.ts

@@ -0,0 +1,11 @@
+import { APIPromise } from "../types/async.js";
+import { $doPost, internalApiResult } from "./doAdmin.js";
+
+// Factory-resets a gateway over MQTT. The server clears its stored firmware versions, since the
+// gateway reverts to factory and stops reporting until it is set up again. Returns the device.
+// 422 when the gateway is offline.
+//
+// Internal for the same reason as zoneDevicesUpdate.
+export function zoneDevicesFactoryReset(zoneDeviceId: number): internalApiResult {
+  return new APIPromise($doPost(`/zone-devices/${zoneDeviceId}/factory-reset`, {}));
+}

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,22 @@
+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;
+  // true only from provisioning's final step (a safe point): a gateway found behind target flashes
+  // now instead of waiting for the nightly sweep. Omitted/false for mid-connection reports.
+  auto_update?: boolean;
+};
+
+// 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/admin-funcs/zoneDevicesReboot.ts

@@ -0,0 +1,10 @@
+import { APIPromise } from "../types/async.js";
+import { $doPost, internalApiResult } from "./doAdmin.js";
+
+// Reboots a gateway over MQTT (cgic-reboot). Fire-and-forget: the gateway drops the reply and
+// reconnects on its own. Returns the device. 422 when the gateway is offline.
+//
+// Internal for the same reason as zoneDevicesUpdate.
+export function zoneDevicesReboot(zoneDeviceId: number): internalApiResult {
+  return new APIPromise($doPost(`/zone-devices/${zoneDeviceId}/reboot`, {}));
+}

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/funcs/vendorsUpdateVendorDetails.ts

@@ -36,12 +36,20 @@ import * as types$ from "../types/primitives.js";
  * can also remove the vendor from their company by sending `company_id: null`.
  *
  * From `location` this endpoint reads only `timezone`, `address1`, `address2`,
- * `city`, `state`, `zip`, `phone`, `mobile_phone` and `fax`. The `address` and
+ * `city`, `state`, `zip`, `phone`, `mobile_phone`, `fax`, `work_email` and `personal_email`. The `address` and
  * `country` properties of the shared `UserLocation` schema have no effect here, and
  * updating them is not supported. `state` accepts a US state or a Canadian
  * province—the vendor's country, set only at registration, is not editable
  * through this endpoint.
  *
+ * `location.work_email` and `location.personal_email` are stored lowercased, and a
+ * value that is not a valid email address, or is longer than 255 characters, gets a
+ * `422` response. They are contact fields: the login stays `email`, which this
+ * endpoint does not change. When an update sets either of them, one must be the
+ * vendor's `email` and the other a different address or empty, or it gets a `422`.
+ * A vendor with neither one copying `email` yet can set just one and leave the
+ * other empty: the save puts `email` in the empty one (work, if both are).
+ *
  * Submitting `location.zip` or `location.state` cross-checks the postal code
  * against the resulting state (using the vendor's existing value for whichever
  * of the two you omit from the request). The server rejects a code that is not shaped like a real

package/src/funcs/zonesSecurityZoneCheckin.ts

@@ -32,7 +32,7 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Requests a check-in to a security zone.
  *
- * **Permissions.** Requires a valid token. This endpoint is not gated on a named permission: the caller's role and their relationship to the record determine what the response contains.
+ * **Permissions.** Requires the `vendor_scans.add` permission, including for a vendor checking themselves in. App tokens (`gsu_`, `gsi_`) get `403`.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/src/index.extras.ts

@@ -80,6 +80,10 @@ 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 { zoneDevicesReboot } from "./admin-funcs/zoneDevicesReboot.js";
+import { zoneDevicesFactoryReset } from "./admin-funcs/zoneDevicesFactoryReset.js";
 import { lookupsAddressValidation } from "./admin-funcs/lookupsAddressValidation.js";
 import { lookupsAddressAutocomplete } from "./admin-funcs/lookupsAddressAutocomplete.js";
 import { lookupsAddressPlace } from "./admin-funcs/lookupsAddressPlace.js";
@@ -219,6 +223,10 @@ export const __internal = {
     update: zoneDevicesUpdate,
     provisioning: zoneDevicesProvisioning,
     delete: zoneDevicesDelete,
-    macAvailability: zoneDevicesMacAvailability
+    macAvailability: zoneDevicesMacAvailability,
+    firmwareVersions: zoneDevicesFirmwareVersions,
+    firmwareUpdate: zoneDevicesFirmwareUpdate,
+    reboot: zoneDevicesReboot,
+    factoryReset: zoneDevicesFactoryReset
   }
 };

package/src/lib/config.ts

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

package/src/models/components/userdetails.ts

@@ -85,6 +85,10 @@ export type UserDetails = {
    * First name of the user.
    */
   firstName?: string | null | undefined;
+  /**
+   * Middle name of the user, or `null` if not set. Returned only in the full user record (`expand=user`).
+   */
+  middleName?: string | null | undefined;
   /**
    * Last name of the user.
    */
@@ -93,6 +97,24 @@ export type UserDetails = {
    * Email address (not always valid)
    */
   email: string;
+  /**
+   * A vendor's work email address, a contact field kept apart from `email`,
+   *
+   * @remarks
+   * which stays the login. When it is the same address as `email`, it follows
+   * any change to the login. `null` if not set. Returned only in the full user
+   * record (`expand=user`).
+   */
+  workEmail?: string | null | undefined;
+  /**
+   * A vendor's personal email address, a contact field kept apart from `email`,
+   *
+   * @remarks
+   * which stays the login. When it is the same address as `email`, it follows
+   * any change to the login. `null` if not set. Returned only in the full user
+   * record (`expand=user`).
+   */
+  personalEmail?: string | null | undefined;
   /**
    * The user's landline phone number, or `null` if not set.
    */
@@ -253,8 +275,11 @@ export const UserDetails$inboundSchema: z.ZodType<
 > = z.object({
   id: types.number(),
   first_name: z.nullable(types.string()).optional(),
+  middle_name: z.nullable(types.string()).optional(),
   last_name: z.nullable(types.string()).optional(),
   email: types.string(),
+  work_email: z.nullable(types.string()).optional(),
+  personal_email: z.nullable(types.string()).optional(),
   phone: z.nullable(types.string()).optional(),
   mobile_phone: z.nullable(types.string()).optional(),
   fax: z.nullable(types.string()).optional(),
@@ -274,7 +299,10 @@ export const UserDetails$inboundSchema: z.ZodType<
 }).transform((v) => {
   return remap$(v, {
     "first_name": "firstName",
+    "middle_name": "middleName",
     "last_name": "lastName",
+    "work_email": "workEmail",
+    "personal_email": "personalEmail",
     "mobile_phone": "mobilePhone",
     "phone_confirmed": "phoneConfirmed",
     "email_confirmed": "emailConfirmed",

package/src/models/components/userlocation.ts

@@ -212,6 +212,14 @@ export type UserLocation = {
    * The fax number of the location. `null` if not set.
    */
   fax?: string | null | undefined;
+  /**
+   * The vendor's work email address. Only `PUT /vendors/{vendor_id_or_me}` reads it. `null` if not set.
+   */
+  workEmail?: string | null | undefined;
+  /**
+   * The vendor's personal email address. Only `PUT /vendors/{vendor_id_or_me}` reads it. `null` if not set.
+   */
+  personalEmail?: string | null | undefined;
   /**
    * The country of the location. `null` if not set.
    */
@@ -250,11 +258,15 @@ export const UserLocation$inboundSchema: z.ZodType<
   phone: z.nullable(types.string()).optional(),
   mobile_phone: z.nullable(types.string()).optional(),
   fax: z.nullable(types.string()).optional(),
+  work_email: z.nullable(types.string()).optional(),
+  personal_email: z.nullable(types.string()).optional(),
   country: z.nullable(types.string()).optional(),
   timezone: z.nullable(Timezone$inboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     "mobile_phone": "mobilePhone",
+    "work_email": "workEmail",
+    "personal_email": "personalEmail",
   });
 });
 /** @internal */
@@ -268,6 +280,8 @@ export type UserLocation$Outbound = {
   phone?: string | null | undefined;
   mobile_phone?: string | null | undefined;
   fax?: string | null | undefined;
+  work_email?: string | null | undefined;
+  personal_email?: string | null | undefined;
   country?: string | null | undefined;
   timezone?: string | null | undefined;
 };
@@ -287,11 +301,15 @@ export const UserLocation$outboundSchema: z.ZodType<
   phone: z.nullable(z.string()).optional(),
   mobilePhone: z.nullable(z.string()).optional(),
   fax: z.nullable(z.string()).optional(),
+  workEmail: z.nullable(z.string()).optional(),
+  personalEmail: z.nullable(z.string()).optional(),
   country: z.nullable(z.string()).optional(),
   timezone: z.nullable(Timezone$outboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     mobilePhone: "mobile_phone",
+    workEmail: "work_email",
+    personalEmail: "personal_email",
   });
 });
 

package/src/models/operations/updateuser.ts

@@ -17,7 +17,6 @@ export type UpdateUserRequestBody = {
   lastName?: string | undefined;
   username?: string | undefined;
   email?: string | undefined;
-  email2?: string | undefined;
   phone?: string | undefined;
   mobilePhone?: string | undefined;
   fax?: string | undefined;
@@ -80,7 +79,6 @@ export type UpdateUserRequestBody$Outbound = {
   last_name?: string | undefined;
   username?: string | undefined;
   email?: string | undefined;
-  email2?: string | undefined;
   phone?: string | undefined;
   mobile_phone?: string | undefined;
   fax?: string | undefined;
@@ -106,7 +104,6 @@ export const UpdateUserRequestBody$outboundSchema: z.ZodType<
   lastName: z.string().optional(),
   username: z.string().optional(),
   email: z.string().optional(),
-  email2: z.string().optional(),
   phone: z.string().optional(),
   mobilePhone: z.string().optional(),
   fax: z.string().optional(),

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/react-query/vendorsUpdateVendorDetails.ts

@@ -55,12 +55,20 @@ export type VendorsUpdateVendorDetailsMutationError =
  * can also remove the vendor from their company by sending `company_id: null`.
  *
  * From `location` this endpoint reads only `timezone`, `address1`, `address2`,
- * `city`, `state`, `zip`, `phone`, `mobile_phone` and `fax`. The `address` and
+ * `city`, `state`, `zip`, `phone`, `mobile_phone`, `fax`, `work_email` and `personal_email`. The `address` and
  * `country` properties of the shared `UserLocation` schema have no effect here, and
  * updating them is not supported. `state` accepts a US state or a Canadian
  * province—the vendor's country, set only at registration, is not editable
  * through this endpoint.
  *
+ * `location.work_email` and `location.personal_email` are stored lowercased, and a
+ * value that is not a valid email address, or is longer than 255 characters, gets a
+ * `422` response. They are contact fields: the login stays `email`, which this
+ * endpoint does not change. When an update sets either of them, one must be the
+ * vendor's `email` and the other a different address or empty, or it gets a `422`.
+ * A vendor with neither one copying `email` yet can set just one and leave the
+ * other empty: the save puts `email` in the empty one (work, if both are).
+ *
  * Submitting `location.zip` or `location.state` cross-checks the postal code
  * against the resulting state (using the vendor's existing value for whichever
  * of the two you omit from the request). The server rejects a code that is not shaped like a real

package/src/react-query/zonesSecurityZoneCheckin.ts

@@ -52,7 +52,7 @@ export type ZonesSecurityZoneCheckinMutationError =
  * @remarks
  * Requests a check-in to a security zone.
  *
- * **Permissions.** Requires a valid token. This endpoint is not gated on a named permission: the caller's role and their relationship to the record determine what the response contains.
+ * **Permissions.** Requires the `vendor_scans.add` permission, including for a vendor checking themselves in. App tokens (`gsu_`, `gsi_`) get `403`.
  */
 export function useZonesSecurityZoneCheckinMutation(
   options?: MutationHookOptions<

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.
    */
@@ -1026,12 +1027,20 @@ export class Vendors extends ClientSDK {
    * can also remove the vendor from their company by sending `company_id: null`.
    *
    * From `location` this endpoint reads only `timezone`, `address1`, `address2`,
-   * `city`, `state`, `zip`, `phone`, `mobile_phone` and `fax`. The `address` and
+   * `city`, `state`, `zip`, `phone`, `mobile_phone`, `fax`, `work_email` and `personal_email`. The `address` and
    * `country` properties of the shared `UserLocation` schema have no effect here, and
    * updating them is not supported. `state` accepts a US state or a Canadian
    * province—the vendor's country, set only at registration, is not editable
    * through this endpoint.
    *
+   * `location.work_email` and `location.personal_email` are stored lowercased, and a
+   * value that is not a valid email address, or is longer than 255 characters, gets a
+   * `422` response. They are contact fields: the login stays `email`, which this
+   * endpoint does not change. When an update sets either of them, one must be the
+   * vendor's `email` and the other a different address or empty, or it gets a `422`.
+   * A vendor with neither one copying `email` yet can set just one and leave the
+   * other empty: the save puts `email` in the empty one (work, if both are).
+   *
    * Submitting `location.zip` or `location.state` cross-checks the postal code
    * against the resulting state (using the vendor's existing value for whichever
    * of the two you omit from the request). The server rejects a code that is not shaped like a real

package/src/sdk/zones.ts

@@ -69,7 +69,7 @@ export class Zones extends ClientSDK {
    * @remarks
    * Requests a check-in to a security zone.
    *
-   * **Permissions.** Requires a valid token. This endpoint is not gated on a named permission: the caller's role and their relationship to the record determine what the response contains.
+   * **Permissions.** Requires the `vendor_scans.add` permission, including for a vendor checking themselves in. App tokens (`gsu_`, `gsi_`) get `403`.
    */
   async securityZoneCheckin(
     request: operations.SecurityZoneCheckinRequestBody,