@greensecurity/javascript-sdk 0.45.0-beta.12 → 0.45.0-beta.14

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/companiesListCompanyManagerContacts.core.ts

@@ -0,0 +1,78 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { companiesListCompanyManagerContacts } from "../funcs/companiesListCompanyManagerContacts.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 CompaniesListCompanyManagerContactsQueryData =
+  operations.ListCompanyManagerContactsListCompanyManagerContactsOk;
+
+export function prefetchCompaniesListCompanyManagerContacts(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListCompanyManagerContactsRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildCompaniesListCompanyManagerContactsQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildCompaniesListCompanyManagerContactsQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListCompanyManagerContactsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<CompaniesListCompanyManagerContactsQueryData>;
+} {
+  return {
+    queryKey: queryKeyCompaniesListCompanyManagerContacts(request.companyId),
+    queryFn: async function companiesListCompanyManagerContactsQueryFn(
+      ctx,
+    ): Promise<CompaniesListCompanyManagerContactsQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(companiesListCompanyManagerContacts(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyCompaniesListCompanyManagerContacts(
+  companyId: number,
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "companies",
+    "listCompanyManagerContacts",
+    companyId,
+  ];
+}

package/src/react-query/companiesListCompanyManagerContacts.ts

@@ -0,0 +1,150 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+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 { useGreenSecurityContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+import {
+  buildCompaniesListCompanyManagerContactsQuery,
+  CompaniesListCompanyManagerContactsQueryData,
+  prefetchCompaniesListCompanyManagerContacts,
+  queryKeyCompaniesListCompanyManagerContacts,
+} from "./companiesListCompanyManagerContacts.core.js";
+export {
+  buildCompaniesListCompanyManagerContactsQuery,
+  type CompaniesListCompanyManagerContactsQueryData,
+  prefetchCompaniesListCompanyManagerContacts,
+  queryKeyCompaniesListCompanyManagerContacts,
+};
+
+export type CompaniesListCompanyManagerContactsQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * List the contact details of a company's managers
+ *
+ * @remarks
+ * List the active managers of a company who have an email address, so someone who belongs to that company can contact them. Readable by a vendor of the company, a manager of the company, or an admin; every other caller receives a 404. Carries only the fields needed to address a message, not the full company manager or user record. Distinct from `/companies/{company_id}/managers`, which is the administration listing and is gated on the `company_managers` view permission.
+ */
+export function useCompaniesListCompanyManagerContacts(
+  request: operations.ListCompanyManagerContactsRequest,
+  options?: QueryHookOptions<
+    CompaniesListCompanyManagerContactsQueryData,
+    CompaniesListCompanyManagerContactsQueryError
+  >,
+): UseQueryResult<
+  CompaniesListCompanyManagerContactsQueryData,
+  CompaniesListCompanyManagerContactsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildCompaniesListCompanyManagerContactsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List the contact details of a company's managers
+ *
+ * @remarks
+ * List the active managers of a company who have an email address, so someone who belongs to that company can contact them. Readable by a vendor of the company, a manager of the company, or an admin; every other caller receives a 404. Carries only the fields needed to address a message, not the full company manager or user record. Distinct from `/companies/{company_id}/managers`, which is the administration listing and is gated on the `company_managers` view permission.
+ */
+export function useCompaniesListCompanyManagerContactsSuspense(
+  request: operations.ListCompanyManagerContactsRequest,
+  options?: SuspenseQueryHookOptions<
+    CompaniesListCompanyManagerContactsQueryData,
+    CompaniesListCompanyManagerContactsQueryError
+  >,
+): UseSuspenseQueryResult<
+  CompaniesListCompanyManagerContactsQueryData,
+  CompaniesListCompanyManagerContactsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildCompaniesListCompanyManagerContactsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setCompaniesListCompanyManagerContactsData(
+  client: QueryClient,
+  queryKeyBase: [companyId: number],
+  data: CompaniesListCompanyManagerContactsQueryData,
+): CompaniesListCompanyManagerContactsQueryData | undefined {
+  const key = queryKeyCompaniesListCompanyManagerContacts(...queryKeyBase);
+
+  return client.setQueryData<CompaniesListCompanyManagerContactsQueryData>(
+    key,
+    data,
+  );
+}
+
+export function invalidateCompaniesListCompanyManagerContacts(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[companyId: number]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "companies",
+      "listCompanyManagerContacts",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllCompaniesListCompanyManagerContacts(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "companies",
+      "listCompanyManagerContacts",
+    ],
+  });
+}

package/src/react-query/index.ts

@@ -11,6 +11,7 @@ export * from "./companiesAddCompanyManager.js";
 export * from "./companiesGetCompany.js";
 export * from "./companiesListCompanyCredentials.js";
 export * from "./companiesListCompanyCredits.js";
+export * from "./companiesListCompanyManagerContacts.js";
 export * from "./companiesListCompanyManagers.js";
 export * from "./companiesListOrSearchCompanies.js";
 export * from "./companiesLookupCompanies.js";
@@ -43,6 +44,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,
+  ];
+}

package/src/react-query/lookupsLookupPostalCode.ts

@@ -0,0 +1,177 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+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 { useGreenSecurityContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+import {
+  buildLookupsLookupPostalCodeQuery,
+  LookupsLookupPostalCodeQueryData,
+  prefetchLookupsLookupPostalCode,
+  queryKeyLookupsLookupPostalCode,
+} from "./lookupsLookupPostalCode.core.js";
+export {
+  buildLookupsLookupPostalCodeQuery,
+  type LookupsLookupPostalCodeQueryData,
+  prefetchLookupsLookupPostalCode,
+  queryKeyLookupsLookupPostalCode,
+};
+
+export type LookupsLookupPostalCodeQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * 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`.
+ */
+export function useLookupsLookupPostalCode(
+  request: operations.LookupPostalCodeRequest,
+  options?: QueryHookOptions<
+    LookupsLookupPostalCodeQueryData,
+    LookupsLookupPostalCodeQueryError
+  >,
+): UseQueryResult<
+  LookupsLookupPostalCodeQueryData,
+  LookupsLookupPostalCodeQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildLookupsLookupPostalCodeQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * 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`.
+ */
+export function useLookupsLookupPostalCodeSuspense(
+  request: operations.LookupPostalCodeRequest,
+  options?: SuspenseQueryHookOptions<
+    LookupsLookupPostalCodeQueryData,
+    LookupsLookupPostalCodeQueryError
+  >,
+): UseSuspenseQueryResult<
+  LookupsLookupPostalCodeQueryData,
+  LookupsLookupPostalCodeQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildLookupsLookupPostalCodeQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setLookupsLookupPostalCodeData(
+  client: QueryClient,
+  queryKeyBase: [
+    parameters: { postalCode: string; state: string; country: string },
+  ],
+  data: LookupsLookupPostalCodeQueryData,
+): LookupsLookupPostalCodeQueryData | undefined {
+  const key = queryKeyLookupsLookupPostalCode(...queryKeyBase);
+
+  return client.setQueryData<LookupsLookupPostalCodeQueryData>(key, data);
+}
+
+export function invalidateLookupsLookupPostalCode(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: { postalCode: string; state: string; country: string }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "lookups",
+      "lookupPostalCode",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllLookupsLookupPostalCode(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@greensecurity/javascript-sdk", "lookups", "lookupPostalCode"],
+  });
+}

package/src/react-query/usersUpdateUser.ts

@@ -56,6 +56,12 @@ export type UsersUpdateUserMutationError =
  * 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/react-query/vendorsCreateVendor.ts

@@ -55,6 +55,10 @@ export type VendorsCreateVendorMutationError =
  * `company_id` is optional for company managers — it defaults to their own company.
  * 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.
  */
 export function useVendorsCreateVendorMutation(
   options?: MutationHookOptions<

package/src/react-query/vendorsUpdateVendorDetails.ts

@@ -56,7 +56,15 @@ export type VendorsUpdateVendorDetailsMutationError =
  * 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