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

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;

package/src/sdk/companies.ts

@@ -77,6 +77,9 @@ export class Companies extends ClientSDK {
    * @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.
    */
   async lookupCompanies(

package/src/sdk/organizations.ts

@@ -36,6 +36,7 @@ export class Organizations extends ClientSDK {
    * - `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`
@@ -75,6 +76,7 @@ export class Organizations extends ClientSDK {
    * - `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/sdk/vendors.ts

@@ -1152,7 +1152,9 @@ export class Vendors extends ClientSDK {
    * 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`.
    */
   async updateVendorCustomField(
     request: operations.UpdateVendorCustomFieldRequest,
@@ -1193,9 +1195,16 @@ export class Vendors extends ClientSDK {
    * Add vendor managed by company
    *
    * @remarks
-   * Adds a company as a manager of the vendor.
-   *
-   * **Permissions.** Requires the `vendors.edit` permission.
+   * 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. 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.
    */
   async addVendorManagedByCompany(
     request: operations.AddVendorManagedByCompanyRequest,
@@ -1214,7 +1223,15 @@ export class Vendors extends ClientSDK {
    * @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.
    */
   async deleteVendorManagedByCompany(
     request: operations.DeleteVendorManagedByCompanyRequest,
@@ -1233,7 +1250,16 @@ export class Vendors extends ClientSDK {
    * @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.
    */
   async updateVendorManagedByCompany(
     request: operations.UpdateVendorManagedByCompanyRequest,
@@ -1377,7 +1403,13 @@ export class Vendors extends ClientSDK {
    * @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.
    */
   async createVendorCompany(
     request: operations.CreateVendorCompanyRequest,

package/src/sdk/zones.ts

@@ -19,6 +19,8 @@ export class Zones extends ClientSDK {
    * 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.
    */
   async listOrSearchSecurityZones(
     request: operations.ListOrSearchSecurityZonesRequest,
@@ -46,6 +48,7 @@ export class Zones extends ClientSDK {
    * - `zone.facility`
    * - `zone.department`
    * - `zone.rules`
+   * - `zone.device_counts` (also requires `zone_devices.view`)
    *
    * The server ignores unrecognized values.
    */