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

package/examples/vendorsCreateVendorRegistration.example.ts

@@ -16,7 +16,7 @@ import { GreenSecurity } from "@greensecurity/javascript-sdk";
 const greenSecurity = new GreenSecurity();
 
 async function main() {
-  const result = await greenSecurity.createVendorRegistration({
+  const result = await greenSecurity.vendors.createVendorRegistration({
     email: "user@example.com",
     password: "Abcdef123!",
     timezone: "America/Chicago",

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@greensecurity/javascript-sdk",
-  "version": "0.40.8-beta.2",
+  "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.3",
+  "version": "0.40.8-beta.31",
   "author": "Green Security LLC",
   "type": "module",
   "tshy": {

package/src/__tests__/alerts.test.ts

@@ -0,0 +1,55 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { expect, test } from "vitest";
+import { GreenSecurity } from "../index.js";
+import { createTestHTTPClient } from "./testclient.js";
+
+test("Alerts List Alerts", async () => {
+  const testHttpClient = createTestHTTPClient("listAlerts");
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
+    },
+  });
+
+  const result = await greenSecurity.alerts.listAlerts({
+    sort: "job",
+    desc: true,
+    itemsPerPage: 25,
+  });
+  expect(result).toBeDefined();
+  expect(result.result).toBeDefined();
+  expect(result.result).toEqual({
+    pager: {
+      baseUrl: "api/vendors/job_titles",
+      sort: "job,title",
+      desc: 0,
+      itemCount: 228,
+      itemsPerPage: 562526,
+      page: 1,
+      useUrlParams: true,
+    },
+    items: [],
+  });
+});
+
+test("Alerts Update User Alerts", async () => {
+  const testHttpClient = createTestHTTPClient("updateUserAlerts");
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
+    },
+  });
+
+  const result = await greenSecurity.alerts.updateUserAlerts({});
+  expect(result).toBeDefined();
+  expect(result).toEqual({});
+});

package/src/__tests__/vendors.test.ts

@@ -954,3 +954,35 @@ test("Vendors Get Vendor Invoice Receipt", async () => {
     base64Pdf: "<value>",
   });
 });
+
+test("Vendors Get Next Unanswered Screening Question", async () => {
+  const testHttpClient = createTestHTTPClient(
+    "getNextUnansweredScreeningQuestion",
+  );
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
+    },
+  });
+
+  const result = await greenSecurity.vendors.getNextUnansweredScreeningQuestion(
+    {
+      vendorIdOrMe: "<value>",
+      expand: [
+        "facility.system",
+      ],
+    },
+  );
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    screeningQuestion: {
+      id: 395343,
+      screeningQuestionSeriesId: 238185,
+    },
+    screeningResponse: {},
+    success: false,
+  });
+});

package/src/__tests__/zones.test.ts

@@ -57,8 +57,9 @@ test("Zones Security Zone Checkin", async () => {
   });
 
   const result = await greenSecurity.zones.securityZoneCheckin({
-    qrCode: "<value>",
-    zoneId: 544883,
+    longitude: "89.6981",
+    latitude: "68.5943",
+    zoneId: 456404,
   });
   expect(result).toBeDefined();
   expect(result).toEqual({});

package/src/admin-funcs/registerCompanies.ts

@@ -0,0 +1,23 @@
+import { APIPromise } from "../types/async.js";
+import { $doPost, internalApiResult } from "./doAdmin.js";
+
+export type companyPayload = {
+  name: string;
+  contact_name: string;
+  contact_email: string;
+  address: string;
+  city: string;
+  state: string;
+  zip: string;
+  country: string;
+  phone: string;
+  website: string;
+  tax_id: string;
+};
+
+export function submitCompany(request: companyPayload): internalApiResult {
+  return new APIPromise($doPost(
+    "/vendors/register/companies",
+    request
+  ));
+}

package/src/admin-funcs/registerEmail.ts

@@ -0,0 +1,16 @@
+import { APIPromise } from "../types/async.js";
+import { $doPost, internalApiResult } from "./doAdmin.js";
+
+export type registerData = {
+  timezone: string;
+  email: string | null;
+  override?: number;
+  code?: string;
+};
+
+export function submitEmailStep(request: registerData): internalApiResult {
+  return new APIPromise($doPost(
+    "/vendors/register/email",
+    request
+  ));
+}

package/src/admin-funcs/registerGeneralInfo.ts

@@ -0,0 +1,30 @@
+import { APIPromise } from "../types/async.js";
+import { $doPost, internalApiResult } from "./doAdmin.js";
+
+export type formInputs = {
+  federal: string;
+  first_name: string;
+  last_name: string;
+  vendor_job_id: number;
+  job_category: string;
+  phone: string;
+  fax: string;
+  timezone: string;
+  company_id: string;
+  supervisor_name: string;
+  supervisor_email: string;
+  supervisor_phone: string;
+  country: string;
+  address1: string;
+  address2: string;
+  city: string;
+  state: string;
+  zip: string;
+};
+
+export function submitGeneralInfo(request: formInputs): internalApiResult {
+  return new APIPromise($doPost(
+    "/vendors/register/general-info",
+    request
+  ));
+}

package/src/admin-funcs/registerPassword.ts

@@ -0,0 +1,14 @@
+import { APIPromise } from "../types/async.js";
+import { $doPost, internalApiResult } from "./doAdmin.js";
+
+export type passwordRegisterData = {
+  password: string | null;
+  password_confirm: string | null;
+};
+
+export function submitPassword(request: passwordRegisterData): internalApiResult {
+  return new APIPromise($doPost(
+    "/vendors/register/password",
+    request
+  ));
+}