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

package/src/funcs/lookupsLookupPostalCode.ts

@@ -1,193 +0,0 @@
-/*
- * 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/models/operations/lookuppostalcode.ts

@@ -1,118 +0,0 @@
-/*
- * 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/lookupsLookupPostalCode.core.ts

@@ -1,82 +0,0 @@
-/*
- * 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

@@ -1,177 +0,0 @@
-/*
- * 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"],
-  });
-}