@greensecurity/javascript-sdk 0.45.0-beta.10 → 0.45.0-beta.11

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@greensecurity/javascript-sdk",
-  "version": "0.45.0-beta.10",
+  "version": "0.45.0-beta.11",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

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

package/src/__tests__/lookups.test.ts

@@ -27,3 +27,27 @@ test("Lookups List Lookup Systems", async () => {
     systems: [],
   });
 });
+
+test("Lookups Lookup Postal Code", async () => {
+  const testHttpClient = createTestHTTPClient("lookupPostalCode");
+
+  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.lookups.lookupPostalCode({
+    postalCode: "12383-0520",
+    state: "Rhode Island",
+    country: "Belgium",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    status: "mismatch",
+    expectedStates: [],
+    error: "<value>",
+  });
+});

package/src/__tests__/vendors.test.ts

@@ -121,7 +121,7 @@ test("Vendors List Vendor Credits", async () => {
       page: 1,
       useUrlParams: false,
     },
-    creditBalance: 6121.86,
+    creditBalance: 7634.4,
   });
 });
 

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

@@ -39,27 +39,31 @@ test("Zones List Or Search Security Zones", async () => {
         facility: {
           contacts: {
             contact: {
-              status: "Active",
+              status: "Inactive",
               department: 123,
             },
             adminContact: {
-              status: "Deleted",
+              status: "Active",
               department: 123,
             },
             techContact: {
-              status: "Deleted",
+              status: "Inactive",
               department: 123,
             },
             greenSecurityCsm: {
-              status: "Active",
+              status: "Deleted",
               department: 123,
             },
             accountManager: {
-              status: "Active",
+              status: "Deleted",
               department: 123,
             },
           },
-          vendorGuestPolicy: null,
+          vendorGuestPolicy: {
+            enabled: true,
+            vendorGuestLimitAndOr: "and",
+            vendorGuestRequireEmail: true,
+          },
         },
       },
       {
@@ -81,9 +85,8 @@ test("Zones Security Zone Checkin", async () => {
   });
 
   const result = await greenSecurity.zones.securityZoneCheckin({
-    longitude: 8727.22,
-    latitude: 2068.79,
-    zoneId: 536569,
+    qrCode: "<value>",
+    zoneId: 118821,
   });
   expect(result).toBeDefined();
   expect(result).toEqual({});

package/src/admin-funcs/dismissCommunication.ts

@@ -0,0 +1,20 @@
+import { APIPromise } from "../types/async.js";
+import { $doPost, internalApiResult } from "./doAdmin.js";
+
+// Records that the caller dismissed a communication (GSSD-7336).
+//
+// Internal for the same reason as listCommunications: it only means anything to our own portal.
+//
+// The durable half of a two-layer dismissal — the client suppresses locally straight away so a
+// banner does not flash back while this is in flight, and this row is what makes the timed
+// rules ("after a week", "after a month") hold on a second device. Whether a past dismissal
+// still suppresses anything is decided server-side on the next list call.
+//
+// The server re-checks the caller's audience before writing, so dismissing a communication that
+// was never aimed at you answers 404 rather than creating a row.
+export function dismissCommunication(communicationId: number): internalApiResult {
+  return new APIPromise($doPost(
+    `/communications/${communicationId}/dismiss`,
+    {},
+  ));
+}

package/src/admin-funcs/listCommunications.ts

@@ -0,0 +1,29 @@
+import { APIPromise } from "../types/async.js";
+import { $doGetSingle, hashToQueryString, internalApiResult } from "./doAdmin.js";
+
+// The banners, pop-ups and in-app notifications aimed at the signed-in user (GSSD-7336).
+//
+// Internal rather than part of the public spec: "the adverts for whoever is holding this token"
+// is only meaningful to our own portal, and a third-party SDK consumer has no use for it. See
+// the public/app-only split in AGENTS.md.
+//
+// The response is already filtered and ordered by the server — audience matched per caller,
+// page matched, anything still suppressed by a dismissal removed, and sorted by priority — so a
+// caller renders the list as it arrives.
+//
+// pageKey narrows to the communications configured for one page. Omitting it returns every
+// communication for the user, which is what a caller that does its own page matching wants.
+export function listCommunications(
+  pageKey?: string | null,
+  itemsPerPage: number = 100,
+): internalApiResult {
+  const query: Record<string, string | number> = { items_per_page: itemsPerPage };
+  if (pageKey) {
+    query["page_key"] = pageKey;
+  }
+
+  return new APIPromise($doGetSingle(
+    `/communications?${hashToQueryString(query)}`,
+    {},
+  ));
+}

package/src/funcs/lookupsLookupPostalCode.ts

@@ -0,0 +1,193 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { GreenSecurityError } from "../models/errors/greensecurityerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Check a postal code against a state and country
+ *
+ * @remarks
+ * Cross-checks a postal code against a state/province and country, the same check
+ * every write path that stores a US or Canadian address enforces server-side (e.g.
+ * `PUT /users/{id}`, `PUT /vendors/{vendor_id_or_me}`). Useful for validating an
+ * address before submitting it elsewhere.
+ *
+ * `status` is one of:
+ * - `ok` — the postal code belongs to the given state/province.
+ * - `invalid` — the postal code is not shaped like a real one for the given country.
+ * - `mismatch` — the postal code is well-formed but belongs to a different state or
+ *   province. `expected_states` names the state(s) it actually maps to.
+ * - `unknown` — nothing to check against (an unsupported country, or a postal code
+ *   absent from the US ZIP dataset). Treated as acceptable by every write path that
+ *   uses this check.
+ *
+ * Only the US and Canada have a real code-to-subdivision map; every other country
+ * always returns `unknown`.
+ *
+ * If set, this operation will use {@link Security.bearerJwt} from the global security.
+ */
+export function lookupsLookupPostalCode(
+  client: GreenSecurityCore,
+  request: operations.LookupPostalCodeRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.LookupPostalCodeLookupPostalCodeOk,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.LookupPostalCodeRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.LookupPostalCodeLookupPostalCodeOk,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.LookupPostalCodeRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/lookups/postal-code")();
+
+  const query = encodeFormQuery({
+    "country": payload.country,
+    "postal_code": payload.postal_code,
+    "state": payload.state,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput, [1]);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "lookupPostalCode",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.LookupPostalCodeLookupPostalCodeOk,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.LookupPostalCodeLookupPostalCodeOk$inboundSchema),
+    M.jsonErr([400, 401, 422], errors.ApiErrorResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail([500, "5XX"]),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/usersUpdateUser.ts

@@ -37,6 +37,12 @@ import { Result } from "../types/fp.js";
  * Only submitted fields are applied — unrecognised fields are silently ignored.
  * Changing `email` automatically resets `bounced_email` to `false`.
  *
+ * Submitting `zip`, `state`, or `country` cross-checks the postal code against the
+ * resulting state/country (using the existing value for any of the three left out
+ * of the request). A code that is not shaped like a real postal code, or that
+ * provably belongs to a different state, is rejected with `422` naming the correct
+ * state.
+ *
  * Each subkey of `email_preferences` is independently optional; sending
  * `{ "email_preferences": { "send_weekly_summary_email": true } }` flips
  * only that flag and leaves the others unchanged.

package/src/funcs/vendorsCreateVendor.ts

@@ -36,6 +36,10 @@ import { Result } from "../types/fp.js";
  * All other callers must provide `company_id`. The caller must have access to the
  * specified company (verified via scoped access policy) and the `vendors:add` permission.
  *
+ * `zip` is cross-checked against `state`: a code that is not shaped like a real postal
+ * code, or that provably belongs to a different state, is rejected with `422` naming
+ * the correct state.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function vendorsCreateVendor(

package/src/funcs/vendorsUpdateVendorDetails.ts

@@ -38,7 +38,15 @@ import * as types$ from "../types/primitives.js";
  * From `location` this endpoint reads only `timezone`, `address1`, `address2`,
  * `city`, `state`, `zip`, `phone`, `mobile_phone` and `fax`. The `address` and
  * `country` properties of the shared `UserLocation` schema are ignored here and
- * updating them is not supported.
+ * updating them is not supported. `state` accepts a US state or a Canadian
+ * province — the vendor's country, set only at registration, is not editable
+ * through this endpoint.
+ *
+ * Submitting `location.zip` or `location.state` cross-checks the postal code
+ * against the resulting state (using the vendor's existing value for whichever
+ * of the two is left out of the request). A code that is not shaped like a real
+ * postal code, or that provably belongs to a different state, is rejected with
+ * `422` naming the correct state.
  *
  * For `title`, the `supervisor` fields, and every `location` field except
  * `timezone`, the value sent is the value stored: omit a field to leave it

package/src/index.extras.ts

@@ -44,6 +44,9 @@ import { vendorGetPaymentForm } from "./admin-funcs/vendorGetPaymentForm.js";
 import { vendorGetSystemsRequiringSmartBadge } from "./admin-funcs/vendorGetSystemsRequiringSmartBadge.js";
 import { vendorGetCompanyCredentialsSummary } from "./admin-funcs/vendorGetCompanyCredentialsSummary.js";
 
+import { listCommunications } from "./admin-funcs/listCommunications.js";
+import { dismissCommunication } from "./admin-funcs/dismissCommunication.js";
+
 export const __internal = {
   getInternalCore,
   initializeInternalCore,
@@ -102,6 +105,11 @@ export const __internal = {
     notifyUploaded: notifyVendorCredentialFileUploaded
   },
 
+  communications: {
+    list: listCommunications,
+    dismiss: dismissCommunication
+  },
+
   companyManager: {
     getPaymentForm: companyManagerGetPaymentForm,
   },

package/src/lib/config.ts

@@ -79,9 +79,9 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "0.44.0",
+  openapiDocVersion: "0.45.0",
   sdkVersion: "0.45.0-beta.10",
   genVersion: "2.934.1",
   userAgent:
-    "speakeasy-sdk/typescript 0.45.0-beta.10 2.934.1 0.44.0 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.45.0-beta.10 2.934.1 0.45.0 @greensecurity/javascript-sdk",
 } as const;

package/src/models/operations/createvendorcompany.ts

@@ -28,7 +28,13 @@ export type CreateVendorCompanyRequestBody = {
    */
   state: components.State | null;
   /**
-   * The vendor company zip
+   * The vendor company zip. Cross-checked against `state` (always
+   *
+   * @remarks
+   * treated as a US address on this endpoint) — a code that is not
+   * shaped like a real US ZIP, or that provably belongs to a
+   * different state, is rejected with `400` naming the correct
+   * state.
    */
   zip: string;
   /**

package/src/models/operations/index.ts

@@ -131,6 +131,7 @@ export * from "./listvendorscrubpackages.js";
 export * from "./listvendorscrubpurchases.js";
 export * from "./listvendortypes.js";
 export * from "./lookupcompanies.js";
+export * from "./lookuppostalcode.js";
 export * from "./magiclink.js";
 export * from "./makepayment.js";
 export * from "./password.js";

package/src/models/operations/lookuppostalcode.ts

@@ -0,0 +1,118 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type LookupPostalCodeRequest = {
+  /**
+   * The zip / postal code to check.
+   */
+  postalCode: string;
+  /**
+   * The state or province, as a code or full name, entered alongside the postal code.
+   */
+  state: string;
+  /**
+   * The country entered alongside the postal code (e.g. US, CA).
+   */
+  country: string;
+};
+
+export const LookupPostalCodeStatus = {
+  Ok: "ok",
+  Invalid: "invalid",
+  Mismatch: "mismatch",
+  Unknown: "unknown",
+} as const;
+export type LookupPostalCodeStatus = OpenEnum<typeof LookupPostalCodeStatus>;
+
+/**
+ * The request was successful, and the server has returned the check result in the response body.
+ */
+export type LookupPostalCodeLookupPostalCodeOk = {
+  status: LookupPostalCodeStatus;
+  /**
+   * The state(s)/province(s) the postal code actually belongs to. Populated whenever the
+   *
+   * @remarks
+   * postal code is well-formed and a state/province was checked against it — so this is
+   * non-empty for `ok` (it names the state that matched) as well as for `mismatch`, and
+   * empty for `invalid` and `unknown`.
+   */
+  expectedStates: Array<string>;
+  /**
+   * A human-readable explanation of the problem. `null` unless `status` is `invalid` or `mismatch`.
+   */
+  error: string | null;
+};
+
+/** @internal */
+export type LookupPostalCodeRequest$Outbound = {
+  postal_code: string;
+  state: string;
+  country: string;
+};
+
+/** @internal */
+export const LookupPostalCodeRequest$outboundSchema: z.ZodType<
+  LookupPostalCodeRequest$Outbound,
+  z.ZodTypeDef,
+  LookupPostalCodeRequest
+> = z.object({
+  postalCode: z.string(),
+  state: z.string(),
+  country: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    postalCode: "postal_code",
+  });
+});
+
+export function lookupPostalCodeRequestToJSON(
+  lookupPostalCodeRequest: LookupPostalCodeRequest,
+): string {
+  return JSON.stringify(
+    LookupPostalCodeRequest$outboundSchema.parse(lookupPostalCodeRequest),
+  );
+}
+
+/** @internal */
+export const LookupPostalCodeStatus$inboundSchema: z.ZodType<
+  LookupPostalCodeStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(LookupPostalCodeStatus);
+
+/** @internal */
+export const LookupPostalCodeLookupPostalCodeOk$inboundSchema: z.ZodType<
+  LookupPostalCodeLookupPostalCodeOk,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status: LookupPostalCodeStatus$inboundSchema,
+  expected_states: z.array(types.string()),
+  error: types.nullable(types.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "expected_states": "expectedStates",
+  });
+});
+
+export function lookupPostalCodeLookupPostalCodeOkFromJSON(
+  jsonString: string,
+): SafeParseResult<LookupPostalCodeLookupPostalCodeOk, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      LookupPostalCodeLookupPostalCodeOk$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LookupPostalCodeLookupPostalCodeOk' from JSON`,
+  );
+}

package/src/react-query/index.ts

@@ -43,6 +43,7 @@ export * from "./invoicesListInvoices.js";
 export * from "./invoicesMakePayment.js";
 export * from "./invoicesUpdateInvoice.js";
 export * from "./lookupsListLookupSystems.js";
+export * from "./lookupsLookupPostalCode.js";
 export * from "./medicalProductsCreateDistributor.js";
 export * from "./medicalProductsCreateManufacturer.js";
 export * from "./medicalProductsCreateMedicalProduct.js";

package/src/react-query/lookupsLookupPostalCode.core.ts

@@ -0,0 +1,82 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { lookupsLookupPostalCode } from "../funcs/lookupsLookupPostalCode.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+export type LookupsLookupPostalCodeQueryData =
+  operations.LookupPostalCodeLookupPostalCodeOk;
+
+export function prefetchLookupsLookupPostalCode(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.LookupPostalCodeRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildLookupsLookupPostalCodeQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildLookupsLookupPostalCodeQuery(
+  client$: GreenSecurityCore,
+  request: operations.LookupPostalCodeRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<LookupsLookupPostalCodeQueryData>;
+} {
+  return {
+    queryKey: queryKeyLookupsLookupPostalCode({
+      postalCode: request.postalCode,
+      state: request.state,
+      country: request.country,
+    }),
+    queryFn: async function lookupsLookupPostalCodeQueryFn(
+      ctx,
+    ): Promise<LookupsLookupPostalCodeQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(lookupsLookupPostalCode(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyLookupsLookupPostalCode(
+  parameters: { postalCode: string; state: string; country: string },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "lookups",
+    "lookupPostalCode",
+    parameters,
+  ];
+}