@greensecurity/javascript-sdk 0.46.0-beta.7 → 0.46.0-beta.8

package/src/funcs/zonesListOrSearchSecurityZones.ts

@@ -3,7 +3,7 @@
  */
 
 import { GreenSecurityCore } from "../core.js";
-import { encodeFormQuery } from "../lib/encodings.js";
+import { encodeFormQuery, queryJoin } from "../lib/encodings.js";
 import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
@@ -40,6 +40,8 @@ import {
  *
  * **Permissions.** Requires the `zones.view` permission.
  *
+ * The `expand` parameter accepts only `zone.device_counts`, which also requires `zone_devices.view`. The server ignores other values.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function zonesListOrSearchSecurityZones(
@@ -108,18 +110,23 @@ async function $do(
 
   const path = pathToFunc("/security_zones")();
 
-  const query = encodeFormQuery({
-    "contact_id": payload.contact_id,
-    "desc": payload.desc,
-    "facility_id": payload.facility_id,
-    "green_location_id": payload.green_location_id,
-    "items_per_page": payload.items_per_page,
-    "latitude": payload.latitude,
-    "longitude": payload.longitude,
-    "name_like": payload.name_like,
-    "page": payload.page,
-    "sort": payload.sort,
-  });
+  const query = queryJoin(
+    encodeFormQuery({
+      "expand": payload.expand,
+    }, { explode: false }),
+    encodeFormQuery({
+      "contact_id": payload.contact_id,
+      "desc": payload.desc,
+      "facility_id": payload.facility_id,
+      "green_location_id": payload.green_location_id,
+      "items_per_page": payload.items_per_page,
+      "latitude": payload.latitude,
+      "longitude": payload.longitude,
+      "name_like": payload.name_like,
+      "page": payload.page,
+      "sort": payload.sort,
+    }),
+  );
 
   const headers = new Headers(compactMap({
     Accept: "application/json",

package/src/index.extras.ts

@@ -59,6 +59,11 @@ import { dismissCommunication } from "./admin-funcs/dismissCommunication.js";
 import { appsListInstalledApps } from "./admin-funcs/appsListInstalledApps.js";
 import { appsExchangeToken } from "./admin-funcs/appsExchangeToken.js";
 import { appsApproveDevice } from "./admin-funcs/appsApproveDevice.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";
 
 // Third-party app platform contract (surfaces, manifest, host/sandbox protocol, components).
 export * as apps from "./apps/index.js";
@@ -160,5 +165,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.46.0-beta.7",
-  genVersion: "2.941.0",
+  sdkVersion: "0.46.0-beta.8",
+  genVersion: "2.943.0",
   userAgent:
-    "speakeasy-sdk/typescript 0.46.0-beta.7 2.941.0 0.45.0 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.46.0-beta.8 2.943.0 0.45.0 @greensecurity/javascript-sdk",
 } as const;

package/src/models/components/authenticatesuccessresponse.ts

@@ -60,6 +60,10 @@ export type AuthenticateSuccessResponseInventoryManager = {};
  * and the login therefore has a SAML flow waiting to be finished.
  */
 export type AuthenticateSuccessResponse = {
+  /**
+   * Whether the user may manage zone devices (the `zone_devices.view` permission, which the Zone Device Managers role grants). Returned only when the caller requests their own record.
+   */
+  canManageZoneDevices?: boolean | undefined;
   /**
    * Whether the user is a `gatekeeper`, a special type of service user assigned to Kiosks and Apps to verify vendors using APIs that have some access to facility data.
    */
@@ -174,6 +178,7 @@ export const AuthenticateSuccessResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  can_manage_zone_devices: types.optional(types.boolean()),
   is_gatekeeper: types.optional(types.boolean()),
   success: types.boolean(),
   user: UserDetails$inboundSchema,
@@ -187,6 +192,7 @@ export const AuthenticateSuccessResponse$inboundSchema: z.ZodType<
   sso: types.optional(SsoContinuation$inboundSchema),
 }).transform((v) => {
   return remap$(v, {
+    "can_manage_zone_devices": "canManageZoneDevices",
     "is_gatekeeper": "isGatekeeper",
     "user_token": "userToken",
     "inventory_manager": "inventoryManager",

package/src/models/components/devicecountpair.ts

@@ -0,0 +1,63 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * How many devices of one kind exist, and how many of those are active.
+ */
+export type DeviceCountPair = {
+  /**
+   * Every device of this kind.
+   */
+  total: number;
+  /**
+   * Devices that reported in recently. A gateway is active if it was seen in the last 5 minutes, and a kiosk is active if any of its devices pinged in the last 2 minutes.
+   */
+  active: number;
+};
+
+/** @internal */
+export const DeviceCountPair$inboundSchema: z.ZodType<
+  DeviceCountPair,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  total: types.number(),
+  active: types.number(),
+});
+/** @internal */
+export type DeviceCountPair$Outbound = {
+  total: number;
+  active: number;
+};
+
+/** @internal */
+export const DeviceCountPair$outboundSchema: z.ZodType<
+  DeviceCountPair$Outbound,
+  z.ZodTypeDef,
+  DeviceCountPair
+> = z.object({
+  total: z.number().int(),
+  active: z.number().int(),
+});
+
+export function deviceCountPairToJSON(
+  deviceCountPair: DeviceCountPair,
+): string {
+  return JSON.stringify(DeviceCountPair$outboundSchema.parse(deviceCountPair));
+}
+export function deviceCountPairFromJSON(
+  jsonString: string,
+): SafeParseResult<DeviceCountPair, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeviceCountPair$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeviceCountPair' from JSON`,
+  );
+}

package/src/models/components/devicecounts.ts

@@ -0,0 +1,66 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  DeviceCountPair,
+  DeviceCountPair$inboundSchema,
+  DeviceCountPair$Outbound,
+  DeviceCountPair$outboundSchema,
+} from "./devicecountpair.js";
+
+/**
+ * Gateway and iPad kiosk totals, counted the same way as the zone devices inventory.
+ */
+export type DeviceCounts = {
+  /**
+   * How many devices of one kind exist, and how many of those are active.
+   */
+  gateways: DeviceCountPair;
+  /**
+   * How many devices of one kind exist, and how many of those are active.
+   */
+  kiosks: DeviceCountPair;
+};
+
+/** @internal */
+export const DeviceCounts$inboundSchema: z.ZodType<
+  DeviceCounts,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  gateways: DeviceCountPair$inboundSchema,
+  kiosks: DeviceCountPair$inboundSchema,
+});
+/** @internal */
+export type DeviceCounts$Outbound = {
+  gateways: DeviceCountPair$Outbound;
+  kiosks: DeviceCountPair$Outbound;
+};
+
+/** @internal */
+export const DeviceCounts$outboundSchema: z.ZodType<
+  DeviceCounts$Outbound,
+  z.ZodTypeDef,
+  DeviceCounts
+> = z.object({
+  gateways: DeviceCountPair$outboundSchema,
+  kiosks: DeviceCountPair$outboundSchema,
+});
+
+export function deviceCountsToJSON(deviceCounts: DeviceCounts): string {
+  return JSON.stringify(DeviceCounts$outboundSchema.parse(deviceCounts));
+}
+export function deviceCountsFromJSON(
+  jsonString: string,
+): SafeParseResult<DeviceCounts, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeviceCounts$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeviceCounts' from JSON`,
+  );
+}

package/src/models/components/expand.ts

@@ -26,6 +26,7 @@ export const Expand = {
   FacilityAppointmentPolicy: "facility.appointment_policy",
   FacilityContacts: "facility.contacts",
   FacilityVendorCounts: "facility.vendor_counts",
+  FacilityDeviceCounts: "facility.device_counts",
   FacilityFluCredential: "facility.flu_credential",
   FacilityScrubsPolicy: "facility.scrubs_policy",
   FacilitySystem: "facility.system",
@@ -126,6 +127,7 @@ export const Expand = {
   ZoneFacility: "zone.facility",
   ZoneDepartment: "zone.department",
   ZoneRules: "zone.rules",
+  ZoneDeviceCounts: "zone.device_counts",
   SystemFacilities: "system.facilities",
   SystemLocation: "system.location",
   SystemAggregate: "system.aggregate",

package/src/models/components/facility.ts

@@ -17,6 +17,12 @@ import {
   Contact$Outbound,
   Contact$outboundSchema,
 } from "./contact.js";
+import {
+  DeviceCounts,
+  DeviceCounts$inboundSchema,
+  DeviceCounts$Outbound,
+  DeviceCounts$outboundSchema,
+} from "./devicecounts.js";
 import {
   FacilityVendorType,
   FacilityVendorType$inboundSchema,
@@ -404,6 +410,10 @@ export type Facility = {
    * Counts of vendors associated with the facility, grouped by relationship, subscription status, and approval status. Present only when `facility.vendor_counts` is in `expand`.
    */
   vendorCounts?: VendorCounts | null | undefined;
+  /**
+   * Gateway and iPad kiosk totals across the facility's zones. Present only when `facility.device_counts` is in `expand` and the caller holds `zone_devices.view`, otherwise `null`.
+   */
+  deviceCounts?: DeviceCounts | null | undefined;
   /**
    * The email domain associated with the facility, or `null` if none is set.
    */
@@ -1292,6 +1302,7 @@ export const Facility$inboundSchema: z.ZodType<
   contacts: z.nullable(z.lazy(() => Contacts$inboundSchema)).optional(),
   vendor_counts: z.nullable(z.lazy(() => VendorCounts$inboundSchema))
     .optional(),
+  device_counts: z.nullable(DeviceCounts$inboundSchema).optional(),
   email_domain: z.nullable(types.string()).optional(),
   facility_type: z.nullable(types.string()).optional(),
   flu_credential: types.optional(z.lazy(() => FluCredential$inboundSchema)),
@@ -1319,6 +1330,7 @@ export const Facility$inboundSchema: z.ZodType<
   return remap$(v, {
     "appointment_policy": "appointmentPolicy",
     "vendor_counts": "vendorCounts",
+    "device_counts": "deviceCounts",
     "email_domain": "emailDomain",
     "facility_type": "facilityType",
     "flu_credential": "fluCredential",
@@ -1335,6 +1347,7 @@ export type Facility$Outbound = {
   appointment_policy?: AppointmentPolicy$Outbound | null | undefined;
   contacts?: Contacts$Outbound | null | undefined;
   vendor_counts?: VendorCounts$Outbound | null | undefined;
+  device_counts?: DeviceCounts$Outbound | null | undefined;
   email_domain?: string | null | undefined;
   facility_type?: string | null | undefined;
   flu_credential?: FluCredential$Outbound | undefined;
@@ -1364,6 +1377,7 @@ export const Facility$outboundSchema: z.ZodType<
   contacts: z.nullable(z.lazy(() => Contacts$outboundSchema)).optional(),
   vendorCounts: z.nullable(z.lazy(() => VendorCounts$outboundSchema))
     .optional(),
+  deviceCounts: z.nullable(DeviceCounts$outboundSchema).optional(),
   emailDomain: z.nullable(z.string()).optional(),
   facilityType: z.nullable(z.string()).optional(),
   fluCredential: z.lazy(() => FluCredential$outboundSchema).optional(),
@@ -1390,6 +1404,7 @@ export const Facility$outboundSchema: z.ZodType<
   return remap$(v, {
     appointmentPolicy: "appointment_policy",
     vendorCounts: "vendor_counts",
+    deviceCounts: "device_counts",
     emailDomain: "email_domain",
     facilityType: "facility_type",
     fluCredential: "flu_credential",

package/src/models/components/index.ts

@@ -30,6 +30,8 @@ export * from "./department.js";
 export * from "./departmentmembership.js";
 export * from "./departmentsummary.js";
 export * from "./desc.js";
+export * from "./devicecountpair.js";
+export * from "./devicecounts.js";
 export * from "./distributor.js";
 export * from "./distributorcreate.js";
 export * from "./distributorupdate.js";

package/src/models/components/user.ts

@@ -50,6 +50,10 @@ export type InventoryManager = {};
  * The User object describes a person or service account.
  */
 export type User = {
+  /**
+   * Whether the user may manage zone devices (the `zone_devices.view` permission, which the Zone Device Managers role grants). Returned only when the caller requests their own record.
+   */
+  canManageZoneDevices?: boolean | undefined;
   /**
    * Whether the user is a `gatekeeper`, a special type of service user assigned to Kiosks and Apps to verify vendors using APIs that have some access to facility data.
    */
@@ -135,6 +139,7 @@ export function inventoryManagerFromJSON(
 /** @internal */
 export const User$inboundSchema: z.ZodType<User, z.ZodTypeDef, unknown> = z
   .object({
+    can_manage_zone_devices: types.optional(types.boolean()),
     is_gatekeeper: types.optional(types.boolean()),
     success: types.boolean(),
     user: UserDetails$inboundSchema,
@@ -147,6 +152,7 @@ export const User$inboundSchema: z.ZodType<User, z.ZodTypeDef, unknown> = z
     company: z.nullable(Company$inboundSchema).optional(),
   }).transform((v) => {
     return remap$(v, {
+      "can_manage_zone_devices": "canManageZoneDevices",
       "is_gatekeeper": "isGatekeeper",
       "user_token": "userToken",
       "inventory_manager": "inventoryManager",

package/src/models/components/zone.ts

@@ -15,6 +15,12 @@ import {
   Department$Outbound,
   Department$outboundSchema,
 } from "./department.js";
+import {
+  DeviceCounts,
+  DeviceCounts$inboundSchema,
+  DeviceCounts$Outbound,
+  DeviceCounts$outboundSchema,
+} from "./devicecounts.js";
 import {
   Facility,
   Facility$inboundSchema,
@@ -287,6 +293,10 @@ export type Zone = {
    * The department the zone belongs to. Contains the full department when you expand `zone.department`, otherwise the department ID.
    */
   department?: Department | number | null | undefined;
+  /**
+   * Gateway and iPad kiosk totals in the zone. Present only when `zone.device_counts` is in `expand` and the caller holds `zone_devices.view`, otherwise `null`.
+   */
+  deviceCounts?: DeviceCounts | null | undefined;
   /**
    * The name of the zone, or `null` if not set.
    */
@@ -936,6 +946,7 @@ export const Zone$inboundSchema: z.ZodType<Zone, z.ZodTypeDef, unknown> = z
     department: z.nullable(
       smartUnion([Department$inboundSchema, types.number()]),
     ).optional(),
+    device_counts: z.nullable(DeviceCounts$inboundSchema).optional(),
     name: z.nullable(types.string()).optional(),
     short_name: z.nullable(types.string()).optional(),
     description: z.nullable(types.string()).optional(),
@@ -960,6 +971,7 @@ export const Zone$inboundSchema: z.ZodType<Zone, z.ZodTypeDef, unknown> = z
     ),
   }).transform((v) => {
     return remap$(v, {
+      "device_counts": "deviceCounts",
       "short_name": "shortName",
       "kiosk_offline_notification": "kioskOfflineNotification",
       "vendor_policy": "vendorPolicy",
@@ -974,6 +986,7 @@ export type Zone$Outbound = {
   id?: number | undefined;
   facility?: Facility$Outbound | Facility2$Outbound | null | undefined;
   department?: Department$Outbound | number | null | undefined;
+  device_counts?: DeviceCounts$Outbound | null | undefined;
   name?: string | null | undefined;
   short_name?: string | null | undefined;
   description?: string | null | undefined;
@@ -1002,6 +1015,7 @@ export const Zone$outboundSchema: z.ZodType<Zone$Outbound, z.ZodTypeDef, Zone> =
     department: z.nullable(
       smartUnion([Department$outboundSchema, z.number().int()]),
     ).optional(),
+    deviceCounts: z.nullable(DeviceCounts$outboundSchema).optional(),
     name: z.nullable(z.string()).optional(),
     shortName: z.nullable(z.string()).optional(),
     description: z.nullable(z.string()).optional(),
@@ -1022,6 +1036,7 @@ export const Zone$outboundSchema: z.ZodType<Zone$Outbound, z.ZodTypeDef, Zone> =
     gpsCheckinPolicy: z.lazy(() => GpsCheckinPolicy$outboundSchema).optional(),
   }).transform((v) => {
     return remap$(v, {
+      deviceCounts: "device_counts",
       shortName: "short_name",
       kioskOfflineNotification: "kiosk_offline_notification",
       vendorPolicy: "vendor_policy",

package/src/models/operations/listorsearchsecurityzones.ts

@@ -38,6 +38,10 @@ export type ListOrSearchSecurityZonesRequest = {
    * A partial string to search in the object name. Do not include any wildcard characters. Searches are not case-sensitive by default.
    */
   nameLike?: string | undefined;
+  /**
+   * An array-style parameter to identify which sections of an object to expand. See documentation for the endpoint for a list of valid expansion values.
+   */
+  expand?: Array<components.Expand> | undefined;
   /**
    * The `contact_id` value.
    */
@@ -76,6 +80,7 @@ export type ListOrSearchSecurityZonesRequest$Outbound = {
   latitude?: number | undefined;
   longitude?: number | undefined;
   name_like?: string | undefined;
+  expand?: Array<string> | undefined;
   contact_id?: number | undefined;
   facility_id?: number | undefined;
   green_location_id?: number | undefined;
@@ -94,6 +99,7 @@ export const ListOrSearchSecurityZonesRequest$outboundSchema: z.ZodType<
   latitude: z.number().optional(),
   longitude: z.number().optional(),
   nameLike: z.string().optional(),
+  expand: z.array(components.Expand$outboundSchema).optional(),
   contactId: z.number().optional(),
   facilityId: z.number().optional(),
   greenLocationId: z.number().optional(),

package/src/react-query/companiesLookupCompanies.ts

@@ -77,6 +77,9 @@ export type CompaniesLookupCompaniesQueryError =
  * @remarks
  * Lists companies available to the caller as minimal lookup summaries for list and typeahead UIs.
  *
+ * For a vendor, the list holds the active companies on the vendor's site: the companies the
+ * vendor can add as managing companies. Other callers see the companies they can view.
+ *
  * **Permissions.** Requires the `companies.view` permission.
  */
 export function useCompaniesLookupCompanies(
@@ -106,6 +109,9 @@ export function useCompaniesLookupCompanies(
  * @remarks
  * Lists companies available to the caller as minimal lookup summaries for list and typeahead UIs.
  *
+ * For a vendor, the list holds the active companies on the vendor's site: the companies the
+ * vendor can add as managing companies. Other callers see the companies they can view.
+ *
  * **Permissions.** Requires the `companies.view` permission.
  */
 export function useCompaniesLookupCompaniesSuspense(
@@ -135,6 +141,9 @@ export function useCompaniesLookupCompaniesSuspense(
  * @remarks
  * Lists companies available to the caller as minimal lookup summaries for list and typeahead UIs.
  *
+ * For a vendor, the list holds the active companies on the vendor's site: the companies the
+ * vendor can add as managing companies. Other callers see the companies they can view.
+ *
  * **Permissions.** Requires the `companies.view` permission.
  */
 export function useCompaniesLookupCompaniesInfinite(
@@ -178,6 +187,9 @@ export function useCompaniesLookupCompaniesInfinite(
  * @remarks
  * Lists companies available to the caller as minimal lookup summaries for list and typeahead UIs.
  *
+ * For a vendor, the list holds the active companies on the vendor's site: the companies the
+ * vendor can add as managing companies. Other callers see the companies they can view.
+ *
  * **Permissions.** Requires the `companies.view` permission.
  */
 export function useCompaniesLookupCompaniesInfiniteSuspense(

package/src/react-query/organizationsGetFacility.ts

@@ -69,6 +69,7 @@ export type OrganizationsGetFacilityQueryError =
  * - `facility.system`
  * - `facility.contacts`
  * - `facility.vendor_counts`
+ * - `facility.device_counts` (also requires `zone_devices.view`)
  * - `facility.appointment_policy`
  * - `facility.vendor_policy`
  * - `facility.vendor_guest_policy`
@@ -116,6 +117,7 @@ export function useOrganizationsGetFacility(
  * - `facility.system`
  * - `facility.contacts`
  * - `facility.vendor_counts`
+ * - `facility.device_counts` (also requires `zone_devices.view`)
  * - `facility.appointment_policy`
  * - `facility.vendor_policy`
  * - `facility.vendor_guest_policy`

package/src/react-query/organizationsListOrSearchFacilities.ts

@@ -84,6 +84,7 @@ export type OrganizationsListOrSearchFacilitiesQueryError =
  * - `facility.system`
  * - `facility.contacts`
  * - `facility.vendor_counts`
+ * - `facility.device_counts` (also requires `zone_devices.view`)
  * - `facility.appointment_policy`
  * - `facility.vendor_policy`
  * - `facility.vendor_guest_policy`
@@ -128,6 +129,7 @@ export function useOrganizationsListOrSearchFacilities(
  * - `facility.system`
  * - `facility.contacts`
  * - `facility.vendor_counts`
+ * - `facility.device_counts` (also requires `zone_devices.view`)
  * - `facility.appointment_policy`
  * - `facility.vendor_policy`
  * - `facility.vendor_guest_policy`
@@ -172,6 +174,7 @@ export function useOrganizationsListOrSearchFacilitiesSuspense(
  * - `facility.system`
  * - `facility.contacts`
  * - `facility.vendor_counts`
+ * - `facility.device_counts` (also requires `zone_devices.view`)
  * - `facility.appointment_policy`
  * - `facility.vendor_policy`
  * - `facility.vendor_guest_policy`
@@ -230,6 +233,7 @@ export function useOrganizationsListOrSearchFacilitiesInfinite(
  * - `facility.system`
  * - `facility.contacts`
  * - `facility.vendor_counts`
+ * - `facility.device_counts` (also requires `zone_devices.view`)
  * - `facility.appointment_policy`
  * - `facility.vendor_policy`
  * - `facility.vendor_guest_policy`

package/src/react-query/vendorsAddVendorManagedByCompany.ts

@@ -50,9 +50,16 @@ export type VendorsAddVendorManagedByCompanyMutationError =
  * Add vendor managed by company
  *
  * @remarks
- * Adds a company as a manager of the vendor.
+ * Adds a company as a manager of the vendor. The new company starts with every access right
+ * turned off. The company must be on the same site as the vendor. Otherwise, the API returns
+ * `404`.
  *
- * **Permissions.** Requires the `vendors.edit` permission.
+ * **Permissions.** Requires the `vendors.edit` permission. Only these callers can change which
+ * companies manage the vendor: the vendor, a company manager at the company the vendor belongs to,
+ * a Green Security administrator, or an app whose API token can update the vendor (an app
+ * installed for the vendor's whole site, for the company the vendor belongs to, or by the vendor).
+ * A company manager whose company manages the vendor through a managed-by-company link, rather
+ * than owning the vendor, gets a `403`, and so do facility and system users.
  */
 export function useVendorsAddVendorManagedByCompanyMutation(
   options?: MutationHookOptions<

package/src/react-query/vendorsCreateVendorCompany.ts

@@ -52,7 +52,13 @@ export type VendorsCreateVendorCompanyMutationError =
  * @remarks
  * Creates vendor company
  *
- * **Permissions.** Requires the `companies.add` permission.
+ * **Permissions.** Requires the `companies.add` permission. Only these callers can move the vendor
+ * into a new company: the vendor, a company manager at the company the vendor belongs to, a Green
+ * Security administrator, or an app installed for the vendor's whole site. An app needs a
+ * site-wide installation because only a site-wide installation can create companies. An app
+ * installed only for a company or by a user gets a `403`, even when its API token can update the
+ * vendor. A company manager whose company manages the vendor through a managed-by-company link,
+ * rather than owning the vendor, gets a `403`, and so do facility and system users.
  */
 export function useVendorsCreateVendorCompanyMutation(
   options?: MutationHookOptions<

package/src/react-query/vendorsDeleteVendorManagedByCompany.ts

@@ -53,7 +53,15 @@ export type VendorsDeleteVendorManagedByCompanyMutationError =
  * @remarks
  * Removes a company as a manager of the vendor.
  *
- * **Permissions.** Requires the `vendors.edit` permission.
+ * **Permissions.** Requires the `vendors.edit` permission. Only these callers can change which
+ * companies manage the vendor: the vendor, a company manager at the company the vendor belongs to,
+ * a Green Security administrator, or an app whose API token can update the vendor (an app
+ * installed for the vendor's whole site, for the company the vendor belongs to, or by the vendor).
+ * A company manager whose company manages the vendor through a managed-by-company link, rather
+ * than owning the vendor, gets a `403`, and so do facility and system users.
+ *
+ * If `managed_vendor_id` doesn't belong to this vendor, the API returns `404`, the same response
+ * as for an ID that doesn't exist.
  */
 export function useVendorsDeleteVendorManagedByCompanyMutation(
   options?: MutationHookOptions<

package/src/react-query/vendorsUpdateVendorCustomField.ts

@@ -60,7 +60,9 @@ export type VendorsUpdateVendorCustomFieldMutationError =
  * Accepts a numeric vendor ID, `me` for the authenticated vendor,
  * or an active QR code (format: contains hyphens).
  *
- * **Permissions.** Requires the `vendors.edit` permission.
+ * **Permissions.** Requires the `vendors.edit` permission. A company manager whose company
+ * manages the vendor through a managed-by-company link, rather than owning it, also needs that
+ * link's `may_edit_profile` access right, or the API returns `403`.
  */
 export function useVendorsUpdateVendorCustomFieldMutation(
   options?: MutationHookOptions<

package/src/react-query/vendorsUpdateVendorManagedByCompany.ts

@@ -52,7 +52,16 @@ export type VendorsUpdateVendorManagedByCompanyMutationError =
  * @remarks
  * Updates the access rights that a company has for the vendor it manages.
  *
- * **Permissions.** Requires the `vendors.edit` permission.
+ * **Permissions.** Requires the `vendors.edit` permission. Only these callers can change access
+ * rights: the vendor, a company manager at the company the vendor belongs to, a Green Security
+ * administrator, or an app whose API token can update the vendor (an app installed for the
+ * vendor's whole site, for the company the vendor belongs to, or by the vendor). A company manager
+ * whose company manages the vendor through a managed-by-company link, rather than owning the
+ * vendor, gets a `403`: that company can't change its own access rights or another company's.
+ * Facility and system users get a `403` too.
+ *
+ * If `managed_vendor_id` doesn't belong to this vendor, the API returns `404`, the same response
+ * as for an ID that doesn't exist.
  */
 export function useVendorsUpdateVendorManagedByCompanyMutation(
   options?: MutationHookOptions<

package/src/react-query/zonesGetSecurityZone.ts

@@ -66,6 +66,7 @@ export type ZonesGetSecurityZoneQueryError =
  * - `zone.facility`
  * - `zone.department`
  * - `zone.rules`
+ * - `zone.device_counts` (also requires `zone_devices.view`)
  *
  * The server ignores unrecognized values.
  */
@@ -103,6 +104,7 @@ export function useZonesGetSecurityZone(
  * - `zone.facility`
  * - `zone.department`
  * - `zone.rules`
+ * - `zone.device_counts` (also requires `zone_devices.view`)
  *
  * The server ignores unrecognized values.
  */