@greensecurity/javascript-sdk 0.44.0-beta.6 → 0.44.0-beta.61

package/src/__tests__/users.test.ts

@@ -59,7 +59,9 @@ test("Users Get Linked Users", async () => {
     },
   });
 
-  const result = await greenSecurity.users.getLinkedUsers({});
+  const result = await greenSecurity.users.getLinkedUsers({
+    userId: "<id>",
+  });
   expect(result).toBeDefined();
   expect(result).toEqual({
     linkedUsers: [

package/src/__tests__/vendors.test.ts

@@ -121,6 +121,7 @@ test("Vendors List Vendor Credits", async () => {
       page: 1,
       useUrlParams: false,
     },
+    creditBalance: 2864.65,
   });
 });
 
@@ -983,6 +984,7 @@ test("Vendors Get Next Unanswered Screening Question", async () => {
       screeningQuestionSeriesId: 238185,
     },
     screeningResponse: {},
+    facilityName: "<value>",
     success: false,
   });
 });
@@ -1215,7 +1217,9 @@ test("Vendors Vendors Export", async () => {
     },
   });
 
-  const result = await greenSecurity.vendors.vendorsExport({});
+  const result = await greenSecurity.vendors.vendorsExport({
+    desc: true,
+  });
   expect(result).toBeDefined();
   expect(result).toEqual({
     statusUrl: "https://plump-lava.info/",
@@ -1263,3 +1267,75 @@ test("Vendors Download Vendors Export", async () => {
   expect(result!.result).toBeDefined();
   expect(result!.result).toEqual({});
 });
+
+test("Vendors Get Vendor Payment Responsibility", async () => {
+  const testHttpClient = createTestHTTPClient("getVendorPaymentResponsibility");
+
+  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.getVendorPaymentResponsibility({
+    vendorId: 217127,
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({});
+});
+
+test("Vendors Update Vendor Payment Responsibility", async () => {
+  const testHttpClient = createTestHTTPClient(
+    "updateVendorPaymentResponsibility",
+  );
+
+  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.updateVendorPaymentResponsibility({
+    vendorId: 155493,
+    requestBody: {},
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({});
+});
+
+test("Vendors Get Vendor Target Facilities", async () => {
+  const testHttpClient = createTestHTTPClient("getVendorTargetFacilities");
+
+  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.getVendorTargetFacilities({
+    vendorIdOrMe: "<value>",
+    expand: [
+      "facility.system",
+    ],
+  });
+  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: 570346,
+      page: 1,
+      useUrlParams: true,
+    },
+    items: [],
+  });
+});

package/src/__tests__/vendorscans.test.ts

@@ -4,6 +4,8 @@
 
 import { expect, test } from "vitest";
 import { GreenSecurity } from "../index.js";
+import { DownloadVendorScansExportAcceptEnum } from "../sdk/vendorscans.js";
+import { filesToByteArray, streamToByteArray } from "./files.js";
 import { createTestHTTPClient } from "./testclient.js";
 
 test("Vendor Scans Vendor Scan Out", async () => {
@@ -128,3 +130,121 @@ test("Vendor Scans Get Vendor Scan", async () => {
     zone: 997496,
   });
 });
+
+test("Vendor Scans Export Vendor Scans", async () => {
+  const testHttpClient = createTestHTTPClient("exportVendorScans");
+
+  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.vendorScans.exportVendorScans({
+    desc: true,
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    statusUrl: "https://good-decision.com",
+    downloadUrl: "https://slight-typeface.name",
+    statusId: "<id>",
+  });
+});
+
+test("Vendor Scans Get Vendor Scans Export Status", async () => {
+  const testHttpClient = createTestHTTPClient("getVendorScansExportStatus");
+
+  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.vendorScans.getVendorScansExportStatus({
+    id: "<id>",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    ready: false,
+    statusId: "<id>",
+  });
+});
+
+test("Vendor Scans Download Vendor Scans Export", async () => {
+  const testHttpClient = createTestHTTPClient("downloadVendorScansExport");
+
+  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.vendorScans.downloadVendorScansExport({
+    id: "<id>",
+  }, {
+    acceptHeaderOverride: DownloadVendorScansExportAcceptEnum.textCsv,
+  });
+  expect(result).toBeDefined();
+  expect(result!.result).toBeDefined();
+  expect(
+    new Uint8Array(
+      await streamToByteArray(result!.result as ReadableStream<Uint8Array>),
+    ),
+  ).toEqual(await filesToByteArray(".speakeasy/testfiles/example.file"));
+});
+
+test("Vendor Scans Vendor Scan Gps Checkout Config", async () => {
+  const testHttpClient = createTestHTTPClient("vendorScanGpsCheckoutConfig");
+
+  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.vendorScans.vendorScanGpsCheckoutConfig({
+    id: 603032,
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    enabled: true,
+    level: "facility",
+    latitude: 6011.7,
+    longitude: 1303.03,
+    radiusFt: 569907,
+    locationName: "<value>",
+  });
+});
+
+test("Vendor Scans Vendor Scan Gps Scan Out", async () => {
+  const testHttpClient = createTestHTTPClient("vendorScanGpsScanOut");
+
+  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.vendorScans.vendorScanGpsScanOut({
+    id: 818416,
+    requestBody: {
+      latitude: 9788.59,
+      longitude: 5803.63,
+    },
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    success: true,
+    outcome: "possibly_left",
+  });
+});

package/src/__tests__/webhooks.test.ts

@@ -60,13 +60,13 @@ test("Webhooks Updates The Webhook Endpoint With The Given Id", async () => {
   const result = await greenSecurity.webhooks
     .updatesTheWebhookEndpointWithTheGivenId({
       id: 220782,
-      webhookEndpoint: {
-        id: 1,
+      webhookEndpointUpdate: {
         webhookUrl: "https://example.com/webhook/incoming",
-        subscriptions: [
-          "<value 1>",
-          "<value 2>",
-        ],
+        subscriptions: {
+          model: "Vendor",
+          action: "updated",
+          expands: "vendor.company,vendor.user",
+        },
         consumers: {
           systemId: 1,
           facilityId: 1,
@@ -81,8 +81,67 @@ test("Webhooks Updates The Webhook Endpoint With The Given Id", async () => {
     webhookUrl: "https://example.com/webhook/incoming",
     signatureAlgo: "sig_hmac_sha256",
     subscriptions: [
-      "<value 1>",
-      "<value 2>",
+      {
+        model: "Vendor",
+        action: "updated",
+      },
+      {
+        model: "Vendor",
+        action: "updated",
+      },
+    ],
+    consumers: {
+      systemId: 1,
+      facilityId: 1,
+      companyId: 1,
+      userId: 1,
+    },
+  });
+});
+
+test("Webhooks Create Webhook Endpoint", async () => {
+  const testHttpClient = createTestHTTPClient("createWebhookEndpoint");
+
+  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.webhooks.createWebhookEndpoint({
+    webhookUrl: "https://example.com/webhook/incoming",
+    subscriptions: [
+      "Vendor.updated",
+      "Vendor.created",
+    ],
+    expand: [
+      "vendor.company",
+    ],
+    consumers: {
+      systemId: 1,
+      facilityId: 1,
+      companyId: 1,
+      userId: 1,
+    },
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    id: 1,
+    webhookUrl: "https://example.com/webhook/incoming",
+    signatureAlgo: "sig_hmac_sha256",
+    subscriptions: [
+      {
+        model: "Vendor",
+        action: "updated",
+        expands: "vendor.company,vendor.user",
+      },
+      {
+        model: "Vendor",
+        action: "created",
+        expands: "",
+      },
     ],
     consumers: {
       systemId: 1,
@@ -92,3 +151,23 @@ test("Webhooks Updates The Webhook Endpoint With The Given Id", async () => {
     },
   });
 });
+
+test("Webhooks Delete Webhook Endpoint", async () => {
+  const testHttpClient = createTestHTTPClient("deleteWebhookEndpoint");
+
+  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.webhooks.deleteWebhookEndpoint({
+    id: 256003,
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    success: false,
+  });
+});

package/src/__tests__/zones.test.ts

@@ -58,7 +58,7 @@ test("Zones Security Zone Checkin", async () => {
 
   const result = await greenSecurity.zones.securityZoneCheckin({
     qrCode: "<value>",
-    zoneId: 169658,
+    zoneId: 997849,
   });
   expect(result).toBeDefined();
   expect(result).toEqual({});

package/src/admin-funcs/companyManagerGetPaymentForm.ts

@@ -0,0 +1,6 @@
+import { APIPromise } from "../types/async.js";
+import { $doGetSingle, internalApiResult } from "./doAdmin.js";
+
+export function companyManagerGetPaymentForm(): internalApiResult {
+  return new APIPromise($doGetSingle("/company_managers/me/payment_form", {}));
+}

package/src/admin-funcs/registerEmail.ts

@@ -6,6 +6,17 @@ export type registerData = {
   email: string | null;
   override?: number;
   code?: string;
+
+  affiliate_id?: number;
+  vendor_group_id?: number;
+  managing_company_id?: number;
+
+  // Optional UTM parameters for tracking
+  utm_source?: string;
+  utm_medium?: string;
+  utm_campaign?: string;
+  utm_term?: string;
+  utm_content?: string;
 };
 
 export function submitEmailStep(request: registerData): internalApiResult {

package/src/admin-funcs/smartBadgeGetPsks.ts

@@ -0,0 +1,23 @@
+import { APIPromise } from "../types/async.js";
+import { $doGetSingle, internalApiResult } from "./doAdmin.js";
+import { smartBadgeMacAddressPathSegment } from "./smartBadgeMacAddress.js";
+
+// The pre-shared keys to try when writing to a smart badge, in the order worth trying.
+//
+// Badges from the two production runs carry different keys and only the badge can say which one it
+// holds, so the backend derives the candidates and the client works through them. This exists so
+// clients do not have to hold any key in code.
+//
+// macAddress may be bare hex, colon-separated or dash-separated, and the backend normalizes it. Not
+// the dot-separated form: Rails treats a dot in a path segment as a format separator, so
+// `c300.0083.ba4d` would not reach this route at all.
+//
+// Validated and encoded before it reaches the path, rather than interpolated raw: this builds the route
+// directly instead of going through pathToFunc, which is what applies charEncoding for generated
+// operations. See smartBadgeMacAddress for why encoding alone is not enough.
+export function smartBadgeGetPsks(macAddress: string): internalApiResult {
+  return new APIPromise($doGetSingle(
+      `/smart-badges/${smartBadgeMacAddressPathSegment(macAddress)}/psks`,
+      {}
+  ));
+}

package/src/admin-funcs/smartBadgeMacAddress.ts

@@ -0,0 +1,25 @@
+// Turns a badge MAC address into a path segment for the smart badge routes.
+//
+// Validated rather than only encoded. encodeURIComponent leaves `.` untouched — it is in the unreserved
+// set — and GreenSecurityCore._createRequest resolves the finished route with `new URL(path, baseURL)`
+// (lib/sdks.ts:136), which canonicalizes dot segments. So a macAddress of `..` survives encoding intact
+// and turns `/api/smart-badges/../psks` into `/api/psks`, leaving the intended route before the backend
+// validates anything; `.` collapses to `/api/smart-badges/psks` the same way. Encoding cannot close
+// that, because there is nothing to encode. Rejecting anything that is not a MAC address can.
+//
+// The accepted forms are bare hex, colon-separated and dash-separated, matching what the backend's
+// VendorScan.normalize_mac_address handles minus the dot-separated form: Rails treats a dot in a path
+// segment as a format separator, so that form never reaches these routes anyway. The backreference
+// keeps the separator consistent, so `c3:00-00:83:ba:4d` is not accepted either.
+const MAC_ADDRESS = /^(?:[0-9a-fA-F]{12}|[0-9a-fA-F]{2}([:-])(?:[0-9a-fA-F]{2}\1){4}[0-9a-fA-F]{2})$/;
+
+export function smartBadgeMacAddressPathSegment(macAddress: string): string {
+  if (!MAC_ADDRESS.test(macAddress)) {
+    throw new Error(
+      "Invalid smart badge MAC address: expected 12 hex digits, optionally colon- or dash-separated, " +
+        `got ${JSON.stringify(macAddress)}`
+    );
+  }
+
+  return encodeURIComponent(macAddress);
+}

package/src/admin-funcs/smartBadgeReportVerifiedPsk.ts

@@ -0,0 +1,25 @@
+import { APIPromise } from "../types/async.js";
+import { $doPost, internalApiResult } from "./doAdmin.js";
+import { smartBadgeMacAddressPathSegment } from "./smartBadgeMacAddress.js";
+
+export type smartBadgeReportVerifiedPskRequest = {
+  psk: string;
+};
+
+// Records which pre-shared key a badge actually accepted, so the next write to it goes straight to
+// that key instead of paying for a rejected handshake and a reconnect.
+//
+// The key travels in the body rather than the query string to keep it out of access and proxy logs.
+//
+// macAddress is validated and encoded for the same reason as in smartBadgeGetPsks, and it matters more
+// here: this request is an authenticated POST, so a value that escapes the route redirects that rather
+// than a read.
+export function smartBadgeReportVerifiedPsk(
+  macAddress: string,
+  request: smartBadgeReportVerifiedPskRequest
+): internalApiResult {
+  return new APIPromise($doPost(
+      `/smart-badges/${smartBadgeMacAddressPathSegment(macAddress)}/psk-verified`,
+      request
+  ));
+}

package/src/admin-funcs/subscriptionGetSmartBadgePrompt.ts

@@ -0,0 +1,13 @@
+import { APIPromise } from "../types/async.js";
+import { $doGetSingle, internalApiResult } from "./doAdmin.js";
+
+export type subscriptionGetSmartBadgePromptRequest = {
+  vendor_id: number;
+};
+
+export function subscriptionGetSmartBadgePrompt(request: subscriptionGetSmartBadgePromptRequest): internalApiResult {
+  return new APIPromise($doGetSingle(
+    "/subscription/smart-badge-prompt",
+    request
+  ));
+}

package/src/admin-funcs/vendorGetPaymentForm.ts

@@ -0,0 +1,6 @@
+import { APIPromise } from "../types/async.js";
+import { $doGetSingle, internalApiResult } from "./doAdmin.js";
+
+export function vendorGetPaymentForm(): internalApiResult {
+  return new APIPromise($doGetSingle("/vendors/me/payment_form", {}));
+}

package/src/admin-funcs/vendorGetSystemsRequiringSmartBadge.ts

@@ -0,0 +1,9 @@
+import { APIPromise } from "../types/async.js";
+import { $doGetSingle, internalApiResult } from "./doAdmin.js";
+
+export function vendorGetSystemsRequiringSmartBadge(vendorId: number | string): internalApiResult {
+  return new APIPromise($doGetSingle(
+      `/vendors/${vendorId}/systems-requiring-smart-badge`,
+      {}
+  ));
+}

package/src/funcs/alertsListAlerts.ts

@@ -3,7 +3,6 @@
  */
 
 import { GreenSecurityCore } from "../core.js";
-import { dlv } from "../lib/dlv.js";
 import { encodeFormQuery, queryJoin } from "../lib/encodings.js";
 import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
@@ -223,7 +222,7 @@ async function $do(
     if (!responseData) {
       return { next: () => null };
     }
-    const results = dlv(responseData, "items");
+    const results = (responseData as { items: unknown }).items;
     if (!Array.isArray(results) || !results.length) {
       return { next: () => null };
     }

package/src/funcs/companiesListCompanyCredentials.ts

@@ -3,7 +3,6 @@
  */
 
 import { GreenSecurityCore } from "../core.js";
-import { dlv } from "../lib/dlv.js";
 import { encodeFormQuery, encodeSimple, queryJoin } from "../lib/encodings.js";
 import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
@@ -234,7 +233,7 @@ async function $do(
     if (!responseData) {
       return { next: () => null };
     }
-    const results = dlv(responseData, "items");
+    const results = (responseData as { items: unknown }).items;
     if (!Array.isArray(results) || !results.length) {
       return { next: () => null };
     }

package/src/funcs/companiesListCompanyCredits.ts

@@ -3,7 +3,6 @@
  */
 
 import { GreenSecurityCore } from "../core.js";
-import { dlv } from "../lib/dlv.js";
 import { encodeFormQuery, encodeSimple, queryJoin } from "../lib/encodings.js";
 import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
@@ -230,7 +229,7 @@ async function $do(
     if (!responseData) {
       return { next: () => null };
     }
-    const results = dlv(responseData, "items");
+    const results = (responseData as { items: unknown }).items;
     if (!Array.isArray(results) || !results.length) {
       return { next: () => null };
     }

package/src/funcs/companiesListCompanyManagers.ts

@@ -3,7 +3,6 @@
  */
 
 import { GreenSecurityCore } from "../core.js";
-import { dlv } from "../lib/dlv.js";
 import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
 import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
@@ -226,7 +225,7 @@ async function $do(
     if (!responseData) {
       return { next: () => null };
     }
-    const results = dlv(responseData, "items");
+    const results = (responseData as { items: unknown }).items;
     if (!Array.isArray(results) || !results.length) {
       return { next: () => null };
     }

package/src/funcs/companiesListOrSearchCompanies.ts

@@ -3,7 +3,6 @@
  */
 
 import { GreenSecurityCore } from "../core.js";
-import { dlv } from "../lib/dlv.js";
 import { encodeFormQuery, queryJoin } from "../lib/encodings.js";
 import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
@@ -227,7 +226,7 @@ async function $do(
     if (!responseData) {
       return { next: () => null };
     }
-    const results = dlv(responseData, "items");
+    const results = (responseData as { items: unknown }).items;
     if (!Array.isArray(results) || !results.length) {
       return { next: () => null };
     }

package/src/funcs/companiesLookupCompanies.ts

@@ -3,7 +3,6 @@
  */
 
 import { GreenSecurityCore } from "../core.js";
-import { dlv } from "../lib/dlv.js";
 import { encodeFormQuery } from "../lib/encodings.js";
 import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
@@ -220,7 +219,7 @@ async function $do(
     if (!responseData) {
       return { next: () => null };
     }
-    const results = dlv(responseData, "items");
+    const results = (responseData as { items: unknown }).items;
     if (!Array.isArray(results) || !results.length) {
       return { next: () => null };
     }

package/src/funcs/eventsListFeed.ts

@@ -3,7 +3,6 @@
  */
 
 import { GreenSecurityCore } from "../core.js";
-import { dlv } from "../lib/dlv.js";
 import { encodeFormQuery } from "../lib/encodings.js";
 import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
@@ -229,7 +228,7 @@ async function $do(
     if (!responseData) {
       return { next: () => null };
     }
-    const results = dlv(responseData, "items");
+    const results = (responseData as { items: unknown }).items;
     if (!Array.isArray(results) || !results.length) {
       return { next: () => null };
     }

package/src/funcs/eventsListLocations.ts

@@ -3,7 +3,6 @@
  */
 
 import { GreenSecurityCore } from "../core.js";
-import { dlv } from "../lib/dlv.js";
 import { encodeFormQuery } from "../lib/encodings.js";
 import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
@@ -222,7 +221,7 @@ async function $do(
     if (!responseData) {
       return { next: () => null };
     }
-    const results = dlv(responseData, "items");
+    const results = (responseData as { items: unknown }).items;
     if (!Array.isArray(results) || !results.length) {
       return { next: () => null };
     }

package/src/funcs/eventsListOrSearchVendorInvitees.ts

@@ -3,7 +3,6 @@
  */
 
 import { GreenSecurityCore } from "../core.js";
-import { dlv } from "../lib/dlv.js";
 import { encodeFormQuery, queryJoin } from "../lib/encodings.js";
 import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
@@ -233,7 +232,7 @@ async function $do(
     if (!responseData) {
       return { next: () => null };
     }
-    const results = dlv(responseData, "items");
+    const results = (responseData as { items: unknown }).items;
     if (!Array.isArray(results) || !results.length) {
       return { next: () => null };
     }