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

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.
  */

package/src/react-query/zonesListOrSearchSecurityZones.core.ts

@@ -82,6 +82,7 @@ export function buildZonesListOrSearchSecurityZonesQuery(
       latitude: request.latitude,
       longitude: request.longitude,
       nameLike: request.nameLike,
+      expand: request.expand,
       contactId: request.contactId,
       facilityId: request.facilityId,
       greenLocationId: request.greenLocationId,
@@ -131,6 +132,7 @@ export function buildZonesListOrSearchSecurityZonesInfiniteQuery(
       latitude: request.latitude,
       longitude: request.longitude,
       nameLike: request.nameLike,
+      expand: request.expand,
       contactId: request.contactId,
       facilityId: request.facilityId,
       greenLocationId: request.greenLocationId,
@@ -178,6 +180,7 @@ export function queryKeyZonesListOrSearchSecurityZones(
     latitude?: number | undefined;
     longitude?: number | undefined;
     nameLike?: string | undefined;
+    expand?: Array<components.Expand> | undefined;
     contactId?: number | undefined;
     facilityId?: number | undefined;
     greenLocationId?: number | undefined;
@@ -200,6 +203,7 @@ export function queryKeyZonesListOrSearchSecurityZonesInfinite(
     latitude?: number | undefined;
     longitude?: number | undefined;
     nameLike?: string | undefined;
+    expand?: Array<components.Expand> | undefined;
     contactId?: number | undefined;
     facilityId?: number | undefined;
     greenLocationId?: number | undefined;

package/src/react-query/zonesListOrSearchSecurityZones.ts

@@ -78,6 +78,8 @@ export type ZonesListOrSearchSecurityZonesQueryError =
  * Lists or searches security zones
  *
  * **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.
  */
 export function useZonesListOrSearchSecurityZones(
   request: operations.ListOrSearchSecurityZonesRequest,
@@ -107,6 +109,8 @@ export function useZonesListOrSearchSecurityZones(
  * Lists or searches security zones
  *
  * **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.
  */
 export function useZonesListOrSearchSecurityZonesSuspense(
   request: operations.ListOrSearchSecurityZonesRequest,
@@ -136,6 +140,8 @@ export function useZonesListOrSearchSecurityZonesSuspense(
  * Lists or searches security zones
  *
  * **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.
  */
 export function useZonesListOrSearchSecurityZonesInfinite(
   request: operations.ListOrSearchSecurityZonesRequest,
@@ -179,6 +185,8 @@ export function useZonesListOrSearchSecurityZonesInfinite(
  * Lists or searches security zones
  *
  * **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.
  */
 export function useZonesListOrSearchSecurityZonesInfiniteSuspense(
   request: operations.ListOrSearchSecurityZonesRequest,
@@ -226,6 +234,7 @@ export function setZonesListOrSearchSecurityZonesData(
       latitude?: number | undefined;
       longitude?: number | undefined;
       nameLike?: string | undefined;
+      expand?: Array<components.Expand> | undefined;
       contactId?: number | undefined;
       facilityId?: number | undefined;
       greenLocationId?: number | undefined;
@@ -252,6 +261,7 @@ export function invalidateZonesListOrSearchSecurityZones(
       latitude?: number | undefined;
       longitude?: number | undefined;
       nameLike?: string | undefined;
+      expand?: Array<components.Expand> | undefined;
       contactId?: number | undefined;
       facilityId?: number | undefined;
       greenLocationId?: number | undefined;