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

package/src/funcs/vendorsDeleteVendorManagedByCompany.ts

@@ -33,7 +33,15 @@ import { Result } from "../types/fp.js";
  * @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.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/src/funcs/vendorsUpdateVendorCustomField.ts

@@ -40,7 +40,9 @@ import { Result } from "../types/fp.js";
  * 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`.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/src/funcs/vendorsUpdateVendorManagedByCompany.ts

@@ -32,7 +32,16 @@ import { Result } from "../types/fp.js";
  * @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.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/src/funcs/zonesGetSecurityZone.ts

@@ -40,6 +40,7 @@ import { Result } from "../types/fp.js";
  * - `zone.facility`
  * - `zone.department`
  * - `zone.rules`
+ * - `zone.device_counts` (also requires `zone_devices.view`)
  *
  * The server ignores unrecognized values.
  *

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.9",
+  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.9 2.943.0 0.45.0 @greensecurity/javascript-sdk",
 } as const;

package/src/models/components/appbundle.ts

@@ -0,0 +1,64 @@
+/*
+ * 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";
+
+/**
+ * Where the app's UI bundle is hosted. The host downloads it and checks `integrity` before
+ *
+ * @remarks
+ * any of it runs, so publish a new manifest whenever the bundle changes.
+ */
+export type AppBundle = {
+  /**
+   * An https URL serving the single-file ES bundle. No credentials, and the same path characters as `AppCspSource`, since its origin also ends up in a CSP header.
+   */
+  url: string;
+  /**
+   * One Subresource Integrity hash of the bundle, `sha256-`, `sha384-` or `sha512-` followed by the base64 digest of the length that algorithm produces.
+   */
+  integrity: string;
+};
+
+/** @internal */
+export const AppBundle$inboundSchema: z.ZodType<
+  AppBundle,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  url: types.string(),
+  integrity: types.string(),
+});
+/** @internal */
+export type AppBundle$Outbound = {
+  url: string;
+  integrity: string;
+};
+
+/** @internal */
+export const AppBundle$outboundSchema: z.ZodType<
+  AppBundle$Outbound,
+  z.ZodTypeDef,
+  AppBundle
+> = z.object({
+  url: z.string(),
+  integrity: z.string(),
+});
+
+export function appBundleToJSON(appBundle: AppBundle): string {
+  return JSON.stringify(AppBundle$outboundSchema.parse(appBundle));
+}
+export function appBundleFromJSON(
+  jsonString: string,
+): SafeParseResult<AppBundle, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AppBundle$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AppBundle' from JSON`,
+  );
+}

package/src/models/components/appconstantvalue.ts

@@ -0,0 +1,48 @@
+/*
+ * 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 { smartUnion } from "../../types/smartUnion.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * A constant's value.
+ */
+export type AppConstantValue = string | number | boolean;
+
+/** @internal */
+export const AppConstantValue$inboundSchema: z.ZodType<
+  AppConstantValue,
+  z.ZodTypeDef,
+  unknown
+> = smartUnion([types.string(), types.number(), types.boolean()]);
+/** @internal */
+export type AppConstantValue$Outbound = string | number | boolean;
+
+/** @internal */
+export const AppConstantValue$outboundSchema: z.ZodType<
+  AppConstantValue$Outbound,
+  z.ZodTypeDef,
+  AppConstantValue
+> = smartUnion([z.string(), z.number(), z.boolean()]);
+
+export function appConstantValueToJSON(
+  appConstantValue: AppConstantValue,
+): string {
+  return JSON.stringify(
+    AppConstantValue$outboundSchema.parse(appConstantValue),
+  );
+}
+export function appConstantValueFromJSON(
+  jsonString: string,
+): SafeParseResult<AppConstantValue, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AppConstantValue$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AppConstantValue' from JSON`,
+  );
+}

package/src/models/components/appcsp.ts

@@ -0,0 +1,93 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+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";
+
+/**
+ * The extra origins the app's sandbox may reach. The Green Security API is always allowed.
+ *
+ * @remarks
+ * `connect_src` and `image_src` together may use at most 4096 characters, counting each
+ * source's length plus one, because every source goes into the sandbox's
+ * `Content-Security-Policy` header. JSON Schema cannot express this limit, but a manifest
+ * over it is invalid.
+ */
+export type AppCsp = {
+  /**
+   * Added to the sandbox's `connect-src`, for `fetch` to your own API.
+   */
+  connectSrc?: Array<string> | undefined;
+  /**
+   * Sources the host may load images from when your views render `Img`.
+   */
+  imageSrc?: Array<string> | undefined;
+  /**
+   * Accepted for manifests published before bundles were supported, and ignored.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  scriptSrc?: Array<string> | undefined;
+  /**
+   * Why the app needs these origins. Shown to the administrators who install it.
+   */
+  purpose: string;
+};
+
+/** @internal */
+export const AppCsp$inboundSchema: z.ZodType<AppCsp, z.ZodTypeDef, unknown> = z
+  .object({
+    connect_src: types.optional(z.array(types.string())),
+    image_src: types.optional(z.array(types.string())),
+    script_src: types.optional(z.array(types.string())),
+    purpose: types.string(),
+  }).transform((v) => {
+    return remap$(v, {
+      "connect_src": "connectSrc",
+      "image_src": "imageSrc",
+      "script_src": "scriptSrc",
+    });
+  });
+/** @internal */
+export type AppCsp$Outbound = {
+  connect_src?: Array<string> | undefined;
+  image_src?: Array<string> | undefined;
+  script_src?: Array<string> | undefined;
+  purpose: string;
+};
+
+/** @internal */
+export const AppCsp$outboundSchema: z.ZodType<
+  AppCsp$Outbound,
+  z.ZodTypeDef,
+  AppCsp
+> = z.object({
+  connectSrc: z.array(z.string()).optional(),
+  imageSrc: z.array(z.string()).optional(),
+  scriptSrc: z.array(z.string()).optional(),
+  purpose: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    connectSrc: "connect_src",
+    imageSrc: "image_src",
+    scriptSrc: "script_src",
+  });
+});
+
+export function appCspToJSON(appCsp: AppCsp): string {
+  return JSON.stringify(AppCsp$outboundSchema.parse(appCsp));
+}
+export function appCspFromJSON(
+  jsonString: string,
+): SafeParseResult<AppCsp, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AppCsp$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AppCsp' from JSON`,
+  );
+}

package/src/models/components/appdevcsp.ts

@@ -0,0 +1,88 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+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";
+
+/**
+ * `AppCsp` for a dev session, where sources may also be local http origins. The same
+ *
+ * @remarks
+ * limits apply.
+ * `connect_src` and `image_src` together may use at most 4096 characters, counting each
+ * source's length plus one, because every source goes into the sandbox's
+ * `Content-Security-Policy` header. JSON Schema cannot express this limit, but a manifest
+ * over it is invalid.
+ */
+export type AppDevCsp = {
+  connectSrc?: Array<string> | undefined;
+  imageSrc?: Array<string> | undefined;
+  /**
+   * Accepted for manifests published before bundles were supported, and ignored.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  scriptSrc?: Array<string> | undefined;
+  purpose: string;
+};
+
+/** @internal */
+export const AppDevCsp$inboundSchema: z.ZodType<
+  AppDevCsp,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  connect_src: types.optional(z.array(types.string())),
+  image_src: types.optional(z.array(types.string())),
+  script_src: types.optional(z.array(types.string())),
+  purpose: types.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "connect_src": "connectSrc",
+    "image_src": "imageSrc",
+    "script_src": "scriptSrc",
+  });
+});
+/** @internal */
+export type AppDevCsp$Outbound = {
+  connect_src?: Array<string> | undefined;
+  image_src?: Array<string> | undefined;
+  script_src?: Array<string> | undefined;
+  purpose: string;
+};
+
+/** @internal */
+export const AppDevCsp$outboundSchema: z.ZodType<
+  AppDevCsp$Outbound,
+  z.ZodTypeDef,
+  AppDevCsp
+> = z.object({
+  connectSrc: z.array(z.string()).optional(),
+  imageSrc: z.array(z.string()).optional(),
+  scriptSrc: z.array(z.string()).optional(),
+  purpose: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    connectSrc: "connect_src",
+    imageSrc: "image_src",
+    scriptSrc: "script_src",
+  });
+});
+
+export function appDevCspToJSON(appDevCsp: AppDevCsp): string {
+  return JSON.stringify(AppDevCsp$outboundSchema.parse(appDevCsp));
+}
+export function appDevCspFromJSON(
+  jsonString: string,
+): SafeParseResult<AppDevCsp, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AppDevCsp$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AppDevCsp' from JSON`,
+  );
+}

package/src/models/components/appdeveloper.ts

@@ -0,0 +1,73 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+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";
+import {
+  AppDeveloperRole,
+  AppDeveloperRole$inboundSchema,
+} from "./appdeveloperrole.js";
+
+/**
+ * A user allowed to publish, preview and manage an app with the developer CLI.
+ */
+export type AppDeveloper = {
+  /**
+   * Unique identifier for the object.
+   */
+  id: number;
+  appId: number;
+  userId: number;
+  /**
+   * The developer's display name.
+   */
+  name?: string | null | undefined;
+  email?: string | null | undefined;
+  /**
+   * `owner`s can also manage the developer list; `developer`s can publish and run dev sessions.
+   */
+  role: AppDeveloperRole;
+  /**
+   * The user who added this developer.
+   */
+  createdBy?: number | null | undefined;
+  dateCreated?: Date | null | undefined;
+};
+
+/** @internal */
+export const AppDeveloper$inboundSchema: z.ZodType<
+  AppDeveloper,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.number(),
+  app_id: types.number(),
+  user_id: types.number(),
+  name: z.nullable(types.string()).optional(),
+  email: z.nullable(types.string()).optional(),
+  role: AppDeveloperRole$inboundSchema,
+  created_by: z.nullable(types.number()).optional(),
+  date_created: z.nullable(types.date()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "app_id": "appId",
+    "user_id": "userId",
+    "created_by": "createdBy",
+    "date_created": "dateCreated",
+  });
+});
+
+export function appDeveloperFromJSON(
+  jsonString: string,
+): SafeParseResult<AppDeveloper, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AppDeveloper$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AppDeveloper' from JSON`,
+  );
+}

package/src/models/components/appdeveloperadd.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { smartUnion } from "../../types/smartUnion.js";
+import {
+  AppDeveloperAddByEmail,
+  AppDeveloperAddByEmail$Outbound,
+  AppDeveloperAddByEmail$outboundSchema,
+} from "./appdeveloperaddbyemail.js";
+import {
+  AppDeveloperAddByUserId,
+  AppDeveloperAddByUserId$Outbound,
+  AppDeveloperAddByUserId$outboundSchema,
+} from "./appdeveloperaddbyuserid.js";
+
+/**
+ * Identify the user by `user_id` or by `email`, never both (`422` otherwise). The user
+ *
+ * @remarks
+ * must already be covered by an installation of the app, because that is who a dev
+ * session can run for. A user who does not exist and one no installation covers both get
+ * `404`, so the endpoint never reveals whether an email has an account.
+ */
+export type AppDeveloperAdd = AppDeveloperAddByUserId | AppDeveloperAddByEmail;
+
+/** @internal */
+export type AppDeveloperAdd$Outbound =
+  | AppDeveloperAddByUserId$Outbound
+  | AppDeveloperAddByEmail$Outbound;
+
+/** @internal */
+export const AppDeveloperAdd$outboundSchema: z.ZodType<
+  AppDeveloperAdd$Outbound,
+  z.ZodTypeDef,
+  AppDeveloperAdd
+> = smartUnion([
+  AppDeveloperAddByUserId$outboundSchema,
+  AppDeveloperAddByEmail$outboundSchema,
+]);
+
+export function appDeveloperAddToJSON(
+  appDeveloperAdd: AppDeveloperAdd,
+): string {
+  return JSON.stringify(AppDeveloperAdd$outboundSchema.parse(appDeveloperAdd));
+}

package/src/models/components/appdeveloperaddbyemail.ts

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  AppDeveloperRole,
+  AppDeveloperRole$outboundSchema,
+} from "./appdeveloperrole.js";
+
+export type AppDeveloperAddByEmail = {
+  /**
+   * Matched case-insensitively. When several accounts share the email, the first one an installation of the app covers is added.
+   */
+  email: string;
+  /**
+   * `owner`s can also manage the developer list; `developer`s can publish and run dev sessions.
+   */
+  role: AppDeveloperRole;
+};
+
+/** @internal */
+export type AppDeveloperAddByEmail$Outbound = {
+  email: string;
+  role: string;
+};
+
+/** @internal */
+export const AppDeveloperAddByEmail$outboundSchema: z.ZodType<
+  AppDeveloperAddByEmail$Outbound,
+  z.ZodTypeDef,
+  AppDeveloperAddByEmail
+> = z.object({
+  email: z.string(),
+  role: AppDeveloperRole$outboundSchema,
+});
+
+export function appDeveloperAddByEmailToJSON(
+  appDeveloperAddByEmail: AppDeveloperAddByEmail,
+): string {
+  return JSON.stringify(
+    AppDeveloperAddByEmail$outboundSchema.parse(appDeveloperAddByEmail),
+  );
+}

package/src/models/components/appdeveloperaddbyuserid.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  AppDeveloperRole,
+  AppDeveloperRole$outboundSchema,
+} from "./appdeveloperrole.js";
+
+export type AppDeveloperAddByUserId = {
+  userId: number;
+  /**
+   * `owner`s can also manage the developer list; `developer`s can publish and run dev sessions.
+   */
+  role: AppDeveloperRole;
+};
+
+/** @internal */
+export type AppDeveloperAddByUserId$Outbound = {
+  user_id: number;
+  role: string;
+};
+
+/** @internal */
+export const AppDeveloperAddByUserId$outboundSchema: z.ZodType<
+  AppDeveloperAddByUserId$Outbound,
+  z.ZodTypeDef,
+  AppDeveloperAddByUserId
+> = z.object({
+  userId: z.number().int(),
+  role: AppDeveloperRole$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    userId: "user_id",
+  });
+});
+
+export function appDeveloperAddByUserIdToJSON(
+  appDeveloperAddByUserId: AppDeveloperAddByUserId,
+): string {
+  return JSON.stringify(
+    AppDeveloperAddByUserId$outboundSchema.parse(appDeveloperAddByUserId),
+  );
+}