@greensecurity/javascript-sdk 0.39.60-beta.0 → 0.40.3

package/docs/sdks/zones/README.md

@@ -0,0 +1,344 @@
+# Zones
+(*zones*)
+
+## Overview
+
+### Available Operations
+
+* [listOrSearchSecurityZones](#listorsearchsecurityzones) - List or search security zones
+* [getSecurityZone](#getsecurityzone) - Get security zone details
+* [securityZoneCheckin](#securityzonecheckin) - Security zone checkin request
+
+## listOrSearchSecurityZones
+
+List or search security zones
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="listOrSearchSecurityZones" method="get" path="/security_zones" -->
+```typescript
+import { GreenSecurity } from "@greensecurity/javascript-sdk";
+
+const greenSecurity = new GreenSecurity({
+  security: {
+    token: process.env["GREEN_SECURITY_TOKEN"] ?? "",
+  },
+});
+
+async function run() {
+  const result = await greenSecurity.zones.listOrSearchSecurityZones({
+    sort: "job",
+    desc: true,
+    itemsPerPage: 25,
+  });
+
+  for await (const page of result) {
+    console.log(page);
+  }
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { GreenSecurityCore } from "@greensecurity/javascript-sdk/core.js";
+import { zonesListOrSearchSecurityZones } from "@greensecurity/javascript-sdk/funcs/zonesListOrSearchSecurityZones.js";
+
+// Use `GreenSecurityCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const greenSecurity = new GreenSecurityCore({
+  security: {
+    token: process.env["GREEN_SECURITY_TOKEN"] ?? "",
+  },
+});
+
+async function run() {
+  const res = await zonesListOrSearchSecurityZones(greenSecurity, {
+    sort: "job",
+    desc: true,
+    itemsPerPage: 25,
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    for await (const page of result) {
+    console.log(page);
+  }
+  } else {
+    console.log("zonesListOrSearchSecurityZones failed:", res.error);
+  }
+}
+
+run();
+```
+
+### React hooks and utilities
+
+This method can be used in React components through the following hooks and
+associated utilities.
+
+> Check out [this guide][hook-guide] for information about each of the utilities
+> below and how to get started using React hooks.
+
+[hook-guide]: ../../../REACT_QUERY.md
+
+```tsx
+import {
+  // Query hooks for fetching data.
+  useZonesListOrSearchSecurityZones,
+  useZonesListOrSearchSecurityZonesSuspense,
+  // Query hooks suitable for building infinite scrolling or "load more" UIs.
+  useZonesListOrSearchSecurityZonesInfinite,
+  useZonesListOrSearchSecurityZonesInfiniteSuspense,
+
+  // Utility for prefetching data during server-side rendering and in React
+  // Server Components that will be immediately available to client components
+  // using the hooks.
+  prefetchZonesListOrSearchSecurityZones,
+  
+  // Utilities to invalidate the query cache for this query in response to
+  // mutations and other user actions.
+  invalidateZonesListOrSearchSecurityZones,
+  invalidateAllZonesListOrSearchSecurityZones,
+} from "@greensecurity/javascript-sdk/react-query/zonesListOrSearchSecurityZones.js";
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.ListOrSearchSecurityZonesRequest](../../models/operations/listorsearchsecurityzonesrequest.md)                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.ListOrSearchSecurityZonesResponse](../../models/operations/listorsearchsecurityzonesresponse.md)\>**
+
+### Errors
+
+| Error Type              | Status Code             | Content Type            |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ApiErrorResponse | 400, 401, 403           | application/json        |
+| errors.APIError         | 4XX, 5XX                | \*/\*                   |
+
+## getSecurityZone
+
+Get security zone details
+
+Available `expand` scopes are:
+
+- zone.facility
+- zone.department
+- zone.rules
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="getSecurityZone" method="get" path="/security_zones/{id}" -->
+```typescript
+import { GreenSecurity } from "@greensecurity/javascript-sdk";
+
+const greenSecurity = new GreenSecurity({
+  security: {
+    token: process.env["GREEN_SECURITY_TOKEN"] ?? "",
+  },
+});
+
+async function run() {
+  const result = await greenSecurity.zones.getSecurityZone({
+    id: 99489,
+    expand: [
+      "facility.system",
+    ],
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { GreenSecurityCore } from "@greensecurity/javascript-sdk/core.js";
+import { zonesGetSecurityZone } from "@greensecurity/javascript-sdk/funcs/zonesGetSecurityZone.js";
+
+// Use `GreenSecurityCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const greenSecurity = new GreenSecurityCore({
+  security: {
+    token: process.env["GREEN_SECURITY_TOKEN"] ?? "",
+  },
+});
+
+async function run() {
+  const res = await zonesGetSecurityZone(greenSecurity, {
+    id: 99489,
+    expand: [
+      "facility.system",
+    ],
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("zonesGetSecurityZone failed:", res.error);
+  }
+}
+
+run();
+```
+
+### React hooks and utilities
+
+This method can be used in React components through the following hooks and
+associated utilities.
+
+> Check out [this guide][hook-guide] for information about each of the utilities
+> below and how to get started using React hooks.
+
+[hook-guide]: ../../../REACT_QUERY.md
+
+```tsx
+import {
+  // Query hooks for fetching data.
+  useZonesGetSecurityZone,
+  useZonesGetSecurityZoneSuspense,
+
+  // Utility for prefetching data during server-side rendering and in React
+  // Server Components that will be immediately available to client components
+  // using the hooks.
+  prefetchZonesGetSecurityZone,
+  
+  // Utilities to invalidate the query cache for this query in response to
+  // mutations and other user actions.
+  invalidateZonesGetSecurityZone,
+  invalidateAllZonesGetSecurityZone,
+} from "@greensecurity/javascript-sdk/react-query/zonesGetSecurityZone.js";
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.GetSecurityZoneRequest](../../models/operations/getsecurityzonerequest.md)                                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.Zone](../../models/components/zone.md)\>**
+
+### Errors
+
+| Error Type              | Status Code             | Content Type            |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ApiErrorResponse | 400, 401, 403, 404      | application/json        |
+| errors.ApiErrorResponse | 500                     | application/json        |
+| errors.APIError         | 4XX, 5XX                | \*/\*                   |
+
+## securityZoneCheckin
+
+Security zone checkin request
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="securityZoneCheckin" method="post" path="/security_zones/checkin_request" -->
+```typescript
+import { GreenSecurity } from "@greensecurity/javascript-sdk";
+
+const greenSecurity = new GreenSecurity({
+  security: {
+    token: process.env["GREEN_SECURITY_TOKEN"] ?? "",
+  },
+});
+
+async function run() {
+  const result = await greenSecurity.zones.securityZoneCheckin({
+    qrCode: "<value>",
+    zoneId: 572658,
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { GreenSecurityCore } from "@greensecurity/javascript-sdk/core.js";
+import { zonesSecurityZoneCheckin } from "@greensecurity/javascript-sdk/funcs/zonesSecurityZoneCheckin.js";
+
+// Use `GreenSecurityCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const greenSecurity = new GreenSecurityCore({
+  security: {
+    token: process.env["GREEN_SECURITY_TOKEN"] ?? "",
+  },
+});
+
+async function run() {
+  const res = await zonesSecurityZoneCheckin(greenSecurity, {
+    qrCode: "<value>",
+    zoneId: 572658,
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("zonesSecurityZoneCheckin failed:", res.error);
+  }
+}
+
+run();
+```
+
+### React hooks and utilities
+
+This method can be used in React components through the following hooks and
+associated utilities.
+
+> Check out [this guide][hook-guide] for information about each of the utilities
+> below and how to get started using React hooks.
+
+[hook-guide]: ../../../REACT_QUERY.md
+
+```tsx
+import {
+  // Mutation hook for triggering the API call.
+  useZonesSecurityZoneCheckinMutation
+} from "@greensecurity/javascript-sdk/react-query/zonesSecurityZoneCheckin.js";
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.SecurityZoneCheckinRequestBody](../../models/operations/securityzonecheckinrequestbody.md)                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.SecurityZoneCheckinResponseBody](../../models/operations/securityzonecheckinresponsebody.md)\>**
+
+### Errors
+
+| Error Type              | Status Code             | Content Type            |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ApiErrorResponse | 400, 401, 403, 404      | application/json        |
+| errors.ApiErrorResponse | 500                     | application/json        |
+| errors.APIError         | 4XX, 5XX                | \*/\*                   |

package/examples/README.md

@@ -0,0 +1,31 @@
+# @greensecurity/javascript-sdk Examples
+
+This directory contains example scripts demonstrating how to use the @greensecurity/javascript-sdk SDK.
+
+## Prerequisites
+
+- Node.js (v18 or higher)
+- npm
+
+## Setup
+
+1. Copy `.env.template` to `.env`:
+   ```bash
+   cp .env.template .env
+   ```
+
+2. Edit `.env` and add your actual credentials (API keys, tokens, etc.)
+
+## Running the Examples
+
+To run an example file from the examples directory:
+
+```bash
+npm run build && npx tsx example.ts
+```
+
+## Creating new examples
+
+Duplicate an existing example file, they won't be overwritten by the generation process.
+
+

package/examples/package-lock.json

@@ -18,25 +18,16 @@
     },
     "..": {
       "name": "@greensecurity/javascript-sdk",
-      "version": "0.39.59",
+      "version": "0.40.3",
       "dependencies": {
         "zod": "^3.20.0"
       },
-      "bin": {
-        "mcp": "bin/mcp-server.js"
-      },
       "devDependencies": {
         "@eslint/js": "^9.19.0",
-        "@modelcontextprotocol/sdk": ">=1.5.0 <1.10.0",
-        "@stricli/core": "^1.1.1",
         "@tanstack/react-query": "^5.61.4",
-        "@types/express": "^4.17.21",
         "@types/node": "^18.19.3",
         "@types/react": "^18.3.12",
-        "bun": "1.2.17",
-        "bun-types": "1.2.17",
         "eslint": "^9.19.0",
-        "express": "^4.21.2",
         "globals": "^15.14.0",
         "tshy": "^2.0.0",
         "typescript": "~5.8.3",
@@ -44,15 +35,11 @@
         "vitest": "^3.0.2"
       },
       "peerDependencies": {
-        "@modelcontextprotocol/sdk": ">=1.5.0 <1.10.0",
         "@tanstack/react-query": "^5",
         "react": "^18 || ^19",
         "react-dom": "^18 || ^19"
       },
       "peerDependenciesMeta": {
-        "@modelcontextprotocol/sdk": {
-          "optional": true
-        },
         "@tanstack/react-query": {
           "optional": true
         },

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@greensecurity/javascript-sdk",
-  "version": "0.39.59",
+  "version": "0.40.3",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,11 +1,8 @@
 {
   "name": "@greensecurity/javascript-sdk",
-  "version": "0.39.60-beta.0",
+  "version": "0.40.3",
   "author": "Green Security LLC",
   "type": "module",
-  "bin": {
-    "mcp": "bin/mcp-server.js"
-  },
   "tshy": {
     "sourceDialects": [
       "@greensecurity/javascript-sdk/source"
@@ -32,20 +29,15 @@
     "test": "vitest run src --reporter=junit --outputFile=.speakeasy/reports/tests.xml --reporter=default",
     "check": "npm run test && npm run lint",
     "lint": "eslint --cache --max-warnings=0 src",
-    "build:mcp": "bun src/mcp-server/build.mts",
-    "build": "npm run build:mcp && tshy",
+    "build": "tshy",
     "prepublishOnly": "npm run build"
   },
   "peerDependencies": {
-    "@modelcontextprotocol/sdk": ">=1.5.0 <1.10.0",
     "@tanstack/react-query": "^5",
     "react": "^18 || ^19",
     "react-dom": "^18 || ^19"
   },
   "peerDependenciesMeta": {
-    "@modelcontextprotocol/sdk": {
-      "optional": true
-    },
     "@tanstack/react-query": {
       "optional": true
     },
@@ -58,16 +50,10 @@
   },
   "devDependencies": {
     "@eslint/js": "^9.19.0",
-    "@modelcontextprotocol/sdk": ">=1.5.0 <1.10.0",
-    "@stricli/core": "^1.1.1",
     "@tanstack/react-query": "^5.61.4",
-    "@types/express": "^4.17.21",
     "@types/node": "^18.19.3",
     "@types/react": "^18.3.12",
-    "bun": "1.2.17",
-    "bun-types": "1.2.17",
     "eslint": "^9.19.0",
-    "express": "^4.21.2",
     "globals": "^15.14.0",
     "tshy": "^2.0.0",
     "typescript": "~5.8.3",

package/src/__tests__/zones.test.ts

@@ -36,10 +36,7 @@ test("Zones List Or Search Security Zones", async () => {
     },
     items: [
       {
-        facility: {
-          contacts: null,
-          vendorGuestPolicy: null,
-        },
+        facility: {},
       },
       {
         facility: {},
@@ -61,6 +58,7 @@ test("Zones Security Zone Checkin", async () => {
 
   const result = await greenSecurity.zones.securityZoneCheckin({
     qrCode: "<value>",
+    zoneId: 544883,
   });
   expect(result).toBeDefined();
   expect(result).toEqual({});

package/src/funcs/vendorsGetVendorsDetails.ts

@@ -52,7 +52,6 @@ import { Result } from "../types/fp.js";
  * vendor.target_facilities
  * vendor.pending_invoice
  * vendor.vendor_groups
- * vendor.has_credentialed_facilities
  */
 export function vendorsGetVendorsDetails(
   client: GreenSecurityCore,

package/src/lib/config.ts

@@ -80,8 +80,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.3",
-  sdkVersion: "0.39.59",
-  genVersion: "2.681.8",
+  sdkVersion: "0.40.3",
+  genVersion: "2.683.1",
   userAgent:
-    "speakeasy-sdk/typescript 0.39.59 2.681.8 0.0.3 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.40.3 2.683.1 0.0.3 @greensecurity/javascript-sdk",
 } as const;

package/src/models/components/expand.ts

@@ -42,7 +42,6 @@ export const Expand = {
   VendorTargetFacilities: "vendor.target_facilities",
   VendorPendingInvoice: "vendor.pending_invoice",
   VendorVendorGroups: "vendor.vendor_groups",
-  VendorHasCredentialedFacilities: "vendor.has_credentialed_facilities",
   SupportArticleDescription: "support_article.description",
   SupportArticlePublished: "support_article.published",
   SupportArticleNotes: "support_article.notes",

package/src/models/components/feed.ts

@@ -30,7 +30,6 @@ export type Feed = {
   facility?: string | null | undefined;
   department?: string | null | undefined;
   eventCreator?: string | null | undefined;
-  eventCreatorImgUrl?: string | null | undefined;
   invitees?: Array<Invitee | null> | undefined;
 };
 
@@ -49,7 +48,6 @@ export const Feed$inboundSchema: z.ZodType<Feed, z.ZodTypeDef, unknown> = z
     facility: z.nullable(z.string()).optional(),
     department: z.nullable(z.string()).optional(),
     event_creator: z.nullable(z.string()).optional(),
-    event_creator_img_url: z.nullable(z.string()).optional(),
     invitees: z.array(z.nullable(Invitee$inboundSchema)).optional(),
   }).transform((v) => {
     return remap$(v, {
@@ -57,7 +55,6 @@ export const Feed$inboundSchema: z.ZodType<Feed, z.ZodTypeDef, unknown> = z
       "standing_appt": "standingAppt",
       "bringing_food": "bringingFood",
       "event_creator": "eventCreator",
-      "event_creator_img_url": "eventCreatorImgUrl",
     });
   });
 
@@ -75,7 +72,6 @@ export type Feed$Outbound = {
   facility?: string | null | undefined;
   department?: string | null | undefined;
   event_creator?: string | null | undefined;
-  event_creator_img_url?: string | null | undefined;
   invitees?: Array<Invitee$Outbound | null> | undefined;
 };
 
@@ -94,7 +90,6 @@ export const Feed$outboundSchema: z.ZodType<Feed$Outbound, z.ZodTypeDef, Feed> =
     facility: z.nullable(z.string()).optional(),
     department: z.nullable(z.string()).optional(),
     eventCreator: z.nullable(z.string()).optional(),
-    eventCreatorImgUrl: z.nullable(z.string()).optional(),
     invitees: z.array(z.nullable(Invitee$outboundSchema)).optional(),
   }).transform((v) => {
     return remap$(v, {
@@ -102,7 +97,6 @@ export const Feed$outboundSchema: z.ZodType<Feed$Outbound, z.ZodTypeDef, Feed> =
       standingAppt: "standing_appt",
       bringingFood: "bringing_food",
       eventCreator: "event_creator",
-      eventCreatorImgUrl: "event_creator_img_url",
     });
   });
 

package/src/models/components/invitee.ts

@@ -3,7 +3,6 @@
  */
 
 import * as z from "zod";
-import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
@@ -12,7 +11,6 @@ export type Invitee = {
   name?: string | null | undefined;
   details?: string | null | undefined;
   status?: string | null | undefined;
-  imgUrl?: string | null | undefined;
 };
 
 /** @internal */
@@ -21,11 +19,6 @@ export const Invitee$inboundSchema: z.ZodType<Invitee, z.ZodTypeDef, unknown> =
     name: z.nullable(z.string()).optional(),
     details: z.nullable(z.string()).optional(),
     status: z.nullable(z.string()).optional(),
-    img_url: z.nullable(z.string()).optional(),
-  }).transform((v) => {
-    return remap$(v, {
-      "img_url": "imgUrl",
-    });
   });
 
 /** @internal */
@@ -33,7 +26,6 @@ export type Invitee$Outbound = {
   name?: string | null | undefined;
   details?: string | null | undefined;
   status?: string | null | undefined;
-  img_url?: string | null | undefined;
 };
 
 /** @internal */
@@ -45,11 +37,6 @@ export const Invitee$outboundSchema: z.ZodType<
   name: z.nullable(z.string()).optional(),
   details: z.nullable(z.string()).optional(),
   status: z.nullable(z.string()).optional(),
-  imgUrl: z.nullable(z.string()).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    imgUrl: "img_url",
-  });
 });
 
 /**