@greensecurity/javascript-sdk 0.40.8-beta.30 → 0.40.8-beta.31

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,7 +18,7 @@
     },
     "..": {
       "name": "@greensecurity/javascript-sdk",
-      "version": "0.40.8-beta.29",
+      "version": "0.40.8-beta.31",
       "dependencies": {
         "zod": "^3.20.0"
       },

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@greensecurity/javascript-sdk",
-  "version": "0.40.8-beta.29",
+  "version": "0.40.8-beta.31",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@greensecurity/javascript-sdk",
-  "version": "0.40.8-beta.30",
+  "version": "0.40.8-beta.31",
   "author": "Green Security LLC",
   "type": "module",
   "tshy": {

package/src/__tests__/webhooks.test.ts

@@ -20,7 +20,7 @@ test("Webhooks List All Webhook Endpoints", async () => {
   const testWebhookListForVendorUserResult = await greenSecurity.webhooks
     .listAllWebhookEndpoints({
       itemsPerPage: 25,
-      desc: true,
+      desc: 0,
       sort: "",
     });
   expect(testWebhookListForVendorUserResult).toBeDefined();

package/src/__tests__/zones.test.ts

@@ -36,24 +36,10 @@ test("Zones List Or Search Security Zones", async () => {
     },
     items: [
       {
-        facility: {
-          contacts: null,
-          vendorGuestPolicy: {
-            enabled: false,
-            vendorGuestLimitAndOr: "and",
-            vendorGuestRequireEmail: false,
-          },
-        },
+        facility: {},
       },
       {
-        facility: {
-          contacts: null,
-          vendorGuestPolicy: {
-            enabled: false,
-            vendorGuestLimitAndOr: "and",
-            vendorGuestRequireEmail: false,
-          },
-        },
+        facility: {},
       },
     ],
   });
@@ -71,9 +57,9 @@ test("Zones Security Zone Checkin", async () => {
   });
 
   const result = await greenSecurity.zones.securityZoneCheckin({
-    longitude: "-35.784",
-    latitude: "-14.5802",
-    zoneId: 199208,
+    longitude: "89.6981",
+    latitude: "68.5943",
+    zoneId: 456404,
   });
   expect(result).toBeDefined();
   expect(result).toEqual({});

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.6",
-  sdkVersion: "0.40.8-beta.29",
+  sdkVersion: "0.40.8-beta.31",
   genVersion: "2.716.10",
   userAgent:
-    "speakeasy-sdk/typescript 0.40.8-beta.29 2.716.10 0.0.6 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.40.8-beta.31 2.716.10 0.0.6 @greensecurity/javascript-sdk",
 } as const;

package/src/models/components/vendor.ts

@@ -176,6 +176,7 @@ export type Vendor = {
   emailRecepient?: string | null | undefined;
   sendWeeklySummaryEmail?: boolean | null | undefined;
   title?: string | null | undefined;
+  hasEmeraldStatus?: boolean | null | undefined;
   user?: One | number | undefined;
   registrationData?: { [k: string]: any } | null | undefined;
   registrationFinished?: boolean | null | undefined;
@@ -1056,6 +1057,7 @@ export const Vendor$inboundSchema: z.ZodType<Vendor, z.ZodTypeDef, unknown> = z
     email_recepient: z.nullable(z.string()).optional(),
     send_weekly_summary_email: z.nullable(z.boolean()).optional(),
     title: z.nullable(z.string()).optional(),
+    has_emerald_status: z.nullable(z.boolean()).optional(),
     user: z.union([z.lazy(() => One$inboundSchema), z.number().int()])
       .optional(),
     registration_data: z.nullable(z.record(z.any())).optional(),
@@ -1112,6 +1114,7 @@ export const Vendor$inboundSchema: z.ZodType<Vendor, z.ZodTypeDef, unknown> = z
     return remap$(v, {
       "email_recepient": "emailRecepient",
       "send_weekly_summary_email": "sendWeeklySummaryEmail",
+      "has_emerald_status": "hasEmeraldStatus",
       "registration_data": "registrationData",
       "registration_finished": "registrationFinished",
       "vendor_job": "vendorJob",
@@ -1143,6 +1146,7 @@ export type Vendor$Outbound = {
   email_recepient?: string | null | undefined;
   send_weekly_summary_email?: boolean | null | undefined;
   title?: string | null | undefined;
+  has_emerald_status?: boolean | null | undefined;
   user?: One$Outbound | number | undefined;
   registration_data?: { [k: string]: any } | null | undefined;
   registration_finished?: boolean | null | undefined;
@@ -1189,6 +1193,7 @@ export const Vendor$outboundSchema: z.ZodType<
   emailRecepient: z.nullable(z.string()).optional(),
   sendWeeklySummaryEmail: z.nullable(z.boolean()).optional(),
   title: z.nullable(z.string()).optional(),
+  hasEmeraldStatus: z.nullable(z.boolean()).optional(),
   user: z.union([z.lazy(() => One$outboundSchema), z.number().int()])
     .optional(),
   registrationData: z.nullable(z.record(z.any())).optional(),
@@ -1243,6 +1248,7 @@ export const Vendor$outboundSchema: z.ZodType<
   return remap$(v, {
     emailRecepient: "email_recepient",
     sendWeeklySummaryEmail: "send_weekly_summary_email",
+    hasEmeraldStatus: "has_emerald_status",
     registrationData: "registration_data",
     registrationFinished: "registration_finished",
     vendorJob: "vendor_job",