@unified-api/typescript-sdk 2.73.17 → 2.73.19

package/src/sdk/models/shared/verificationaddress.ts

@@ -0,0 +1,107 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type VerificationAddress = {
+  address1?: string | undefined;
+  address2?: string | undefined;
+  city?: string | undefined;
+  country?: string | undefined;
+  countryCode?: string | undefined;
+  postalCode?: string | undefined;
+  region?: string | undefined;
+  regionCode?: string | undefined;
+};
+
+/** @internal */
+export const VerificationAddress$inboundSchema: z.ZodType<
+  VerificationAddress,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  address1: z.string().optional(),
+  address2: z.string().optional(),
+  city: z.string().optional(),
+  country: z.string().optional(),
+  country_code: z.string().optional(),
+  postal_code: z.string().optional(),
+  region: z.string().optional(),
+  region_code: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "country_code": "countryCode",
+    "postal_code": "postalCode",
+    "region_code": "regionCode",
+  });
+});
+
+/** @internal */
+export type VerificationAddress$Outbound = {
+  address1?: string | undefined;
+  address2?: string | undefined;
+  city?: string | undefined;
+  country?: string | undefined;
+  country_code?: string | undefined;
+  postal_code?: string | undefined;
+  region?: string | undefined;
+  region_code?: string | undefined;
+};
+
+/** @internal */
+export const VerificationAddress$outboundSchema: z.ZodType<
+  VerificationAddress$Outbound,
+  z.ZodTypeDef,
+  VerificationAddress
+> = z.object({
+  address1: z.string().optional(),
+  address2: z.string().optional(),
+  city: z.string().optional(),
+  country: z.string().optional(),
+  countryCode: z.string().optional(),
+  postalCode: z.string().optional(),
+  region: z.string().optional(),
+  regionCode: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    countryCode: "country_code",
+    postalCode: "postal_code",
+    regionCode: "region_code",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace VerificationAddress$ {
+  /** @deprecated use `VerificationAddress$inboundSchema` instead. */
+  export const inboundSchema = VerificationAddress$inboundSchema;
+  /** @deprecated use `VerificationAddress$outboundSchema` instead. */
+  export const outboundSchema = VerificationAddress$outboundSchema;
+  /** @deprecated use `VerificationAddress$Outbound` instead. */
+  export type Outbound = VerificationAddress$Outbound;
+}
+
+export function verificationAddressToJSON(
+  verificationAddress: VerificationAddress,
+): string {
+  return JSON.stringify(
+    VerificationAddress$outboundSchema.parse(verificationAddress),
+  );
+}
+
+export function verificationAddressFromJSON(
+  jsonString: string,
+): SafeParseResult<VerificationAddress, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VerificationAddress$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VerificationAddress' from JSON`,
+  );
+}

package/src/sdk/models/shared/verificationpackage.ts

@@ -0,0 +1,231 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import {
+  catchUnrecognizedEnum,
+  OpenEnum,
+  Unrecognized,
+} from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  VerificationParameter,
+  VerificationParameter$inboundSchema,
+  VerificationParameter$Outbound,
+  VerificationParameter$outboundSchema,
+} from "./verificationparameter.js";
+import {
+  VerificationTime,
+  VerificationTime$inboundSchema,
+  VerificationTime$Outbound,
+  VerificationTime$outboundSchema,
+} from "./verificationtime.js";
+
+export const VerificationPackageType = {
+  IdentityVerification: "IDENTITY_VERIFICATION",
+  Screening: "SCREENING",
+  BackgroundCheck: "BACKGROUND_CHECK",
+  EmploymentVerification: "EMPLOYMENT_VERIFICATION",
+  EducationVerification: "EDUCATION_VERIFICATION",
+  CreditCheck: "CREDIT_CHECK",
+  FraudPrevention: "FRAUD_PREVENTION",
+  Other: "OTHER",
+} as const;
+export type VerificationPackageType = OpenEnum<typeof VerificationPackageType>;
+
+export type VerificationPackage = {
+  aliases?: Array<string> | undefined;
+  /**
+   * average processing time in minutes
+   */
+  averageProcessingTimes?: Array<VerificationTime> | undefined;
+  costAmount?: number | undefined;
+  createdAt?: Date | undefined;
+  currency?: string | undefined;
+  description?: string | undefined;
+  hasRedirectUrl?: boolean | undefined;
+  hasTargetUrl?: boolean | undefined;
+  id: string;
+  infoUrl?: string | undefined;
+  maxScore?: number | undefined;
+  name: string;
+  needsIpAddress?: boolean | undefined;
+  /**
+   * Questions that need to be answered for this verification
+   */
+  parameters?: Array<VerificationParameter> | undefined;
+  raw?: { [k: string]: any } | undefined;
+  /**
+   * Category (Verification, Validation, Background Check)
+   */
+  tags?: Array<string> | undefined;
+  type: VerificationPackageType;
+  updatedAt?: Date | undefined;
+};
+
+/** @internal */
+export const VerificationPackageType$inboundSchema: z.ZodType<
+  VerificationPackageType,
+  z.ZodTypeDef,
+  unknown
+> = z
+  .union([
+    z.nativeEnum(VerificationPackageType),
+    z.string().transform(catchUnrecognizedEnum),
+  ]);
+
+/** @internal */
+export const VerificationPackageType$outboundSchema: z.ZodType<
+  VerificationPackageType,
+  z.ZodTypeDef,
+  VerificationPackageType
+> = z.union([
+  z.nativeEnum(VerificationPackageType),
+  z.string().and(z.custom<Unrecognized<string>>()),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace VerificationPackageType$ {
+  /** @deprecated use `VerificationPackageType$inboundSchema` instead. */
+  export const inboundSchema = VerificationPackageType$inboundSchema;
+  /** @deprecated use `VerificationPackageType$outboundSchema` instead. */
+  export const outboundSchema = VerificationPackageType$outboundSchema;
+}
+
+/** @internal */
+export const VerificationPackage$inboundSchema: z.ZodType<
+  VerificationPackage,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  aliases: z.array(z.string()).optional(),
+  average_processing_times: z.array(VerificationTime$inboundSchema).optional(),
+  cost_amount: z.number().optional(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  currency: z.string().optional(),
+  description: z.string().optional(),
+  has_redirect_url: z.boolean().optional(),
+  has_target_url: z.boolean().optional(),
+  id: z.string(),
+  info_url: z.string().optional(),
+  max_score: z.number().optional(),
+  name: z.string(),
+  needs_ip_address: z.boolean().optional(),
+  parameters: z.array(VerificationParameter$inboundSchema).optional(),
+  raw: z.record(z.any()).optional(),
+  tags: z.array(z.string()).optional(),
+  type: VerificationPackageType$inboundSchema,
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "average_processing_times": "averageProcessingTimes",
+    "cost_amount": "costAmount",
+    "created_at": "createdAt",
+    "has_redirect_url": "hasRedirectUrl",
+    "has_target_url": "hasTargetUrl",
+    "info_url": "infoUrl",
+    "max_score": "maxScore",
+    "needs_ip_address": "needsIpAddress",
+    "updated_at": "updatedAt",
+  });
+});
+
+/** @internal */
+export type VerificationPackage$Outbound = {
+  aliases?: Array<string> | undefined;
+  average_processing_times?: Array<VerificationTime$Outbound> | undefined;
+  cost_amount?: number | undefined;
+  created_at?: string | undefined;
+  currency?: string | undefined;
+  description?: string | undefined;
+  has_redirect_url?: boolean | undefined;
+  has_target_url?: boolean | undefined;
+  id: string;
+  info_url?: string | undefined;
+  max_score?: number | undefined;
+  name: string;
+  needs_ip_address?: boolean | undefined;
+  parameters?: Array<VerificationParameter$Outbound> | undefined;
+  raw?: { [k: string]: any } | undefined;
+  tags?: Array<string> | undefined;
+  type: string;
+  updated_at?: string | undefined;
+};
+
+/** @internal */
+export const VerificationPackage$outboundSchema: z.ZodType<
+  VerificationPackage$Outbound,
+  z.ZodTypeDef,
+  VerificationPackage
+> = z.object({
+  aliases: z.array(z.string()).optional(),
+  averageProcessingTimes: z.array(VerificationTime$outboundSchema).optional(),
+  costAmount: z.number().optional(),
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  currency: z.string().optional(),
+  description: z.string().optional(),
+  hasRedirectUrl: z.boolean().optional(),
+  hasTargetUrl: z.boolean().optional(),
+  id: z.string(),
+  infoUrl: z.string().optional(),
+  maxScore: z.number().optional(),
+  name: z.string(),
+  needsIpAddress: z.boolean().optional(),
+  parameters: z.array(VerificationParameter$outboundSchema).optional(),
+  raw: z.record(z.any()).optional(),
+  tags: z.array(z.string()).optional(),
+  type: VerificationPackageType$outboundSchema,
+  updatedAt: z.date().transform(v => v.toISOString()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    averageProcessingTimes: "average_processing_times",
+    costAmount: "cost_amount",
+    createdAt: "created_at",
+    hasRedirectUrl: "has_redirect_url",
+    hasTargetUrl: "has_target_url",
+    infoUrl: "info_url",
+    maxScore: "max_score",
+    needsIpAddress: "needs_ip_address",
+    updatedAt: "updated_at",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace VerificationPackage$ {
+  /** @deprecated use `VerificationPackage$inboundSchema` instead. */
+  export const inboundSchema = VerificationPackage$inboundSchema;
+  /** @deprecated use `VerificationPackage$outboundSchema` instead. */
+  export const outboundSchema = VerificationPackage$outboundSchema;
+  /** @deprecated use `VerificationPackage$Outbound` instead. */
+  export type Outbound = VerificationPackage$Outbound;
+}
+
+export function verificationPackageToJSON(
+  verificationPackage: VerificationPackage,
+): string {
+  return JSON.stringify(
+    VerificationPackage$outboundSchema.parse(verificationPackage),
+  );
+}
+
+export function verificationPackageFromJSON(
+  jsonString: string,
+): SafeParseResult<VerificationPackage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VerificationPackage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VerificationPackage' from JSON`,
+  );
+}

package/src/sdk/models/shared/verificationparameter.ts

@@ -0,0 +1,167 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import {
+  catchUnrecognizedEnum,
+  OpenEnum,
+  Unrecognized,
+} from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export const VerificationParameterType = {
+  Text: "TEXT",
+  Number: "NUMBER",
+  MultipleChoice: "MULTIPLE_CHOICE",
+  MultipleSelect: "MULTIPLE_SELECT",
+  Date: "DATE",
+  File: "FILE",
+} as const;
+export type VerificationParameterType = OpenEnum<
+  typeof VerificationParameterType
+>;
+
+export type VerificationParameter = {
+  /**
+   * valid file mime types
+   */
+  fileTypes?: Array<string> | undefined;
+  id?: string | undefined;
+  isRequired?: boolean | undefined;
+  name: string;
+  /**
+   * options for MULTIPLE_CHOICE and MULTIPLE_SELECT
+   */
+  options?: Array<string> | undefined;
+  publicQuestion?: string | undefined;
+  type?: VerificationParameterType | undefined;
+  /**
+   * {country}-{stateprovince/territory} or just {country} 2-digit ISO codes
+   */
+  validRegions?: Array<string> | undefined;
+};
+
+/** @internal */
+export const VerificationParameterType$inboundSchema: z.ZodType<
+  VerificationParameterType,
+  z.ZodTypeDef,
+  unknown
+> = z
+  .union([
+    z.nativeEnum(VerificationParameterType),
+    z.string().transform(catchUnrecognizedEnum),
+  ]);
+
+/** @internal */
+export const VerificationParameterType$outboundSchema: z.ZodType<
+  VerificationParameterType,
+  z.ZodTypeDef,
+  VerificationParameterType
+> = z.union([
+  z.nativeEnum(VerificationParameterType),
+  z.string().and(z.custom<Unrecognized<string>>()),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace VerificationParameterType$ {
+  /** @deprecated use `VerificationParameterType$inboundSchema` instead. */
+  export const inboundSchema = VerificationParameterType$inboundSchema;
+  /** @deprecated use `VerificationParameterType$outboundSchema` instead. */
+  export const outboundSchema = VerificationParameterType$outboundSchema;
+}
+
+/** @internal */
+export const VerificationParameter$inboundSchema: z.ZodType<
+  VerificationParameter,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  file_types: z.array(z.string()).optional(),
+  id: z.string().optional(),
+  is_required: z.boolean().optional(),
+  name: z.string(),
+  options: z.array(z.string()).optional(),
+  public_question: z.string().optional(),
+  type: VerificationParameterType$inboundSchema.optional(),
+  valid_regions: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "file_types": "fileTypes",
+    "is_required": "isRequired",
+    "public_question": "publicQuestion",
+    "valid_regions": "validRegions",
+  });
+});
+
+/** @internal */
+export type VerificationParameter$Outbound = {
+  file_types?: Array<string> | undefined;
+  id?: string | undefined;
+  is_required?: boolean | undefined;
+  name: string;
+  options?: Array<string> | undefined;
+  public_question?: string | undefined;
+  type?: string | undefined;
+  valid_regions?: Array<string> | undefined;
+};
+
+/** @internal */
+export const VerificationParameter$outboundSchema: z.ZodType<
+  VerificationParameter$Outbound,
+  z.ZodTypeDef,
+  VerificationParameter
+> = z.object({
+  fileTypes: z.array(z.string()).optional(),
+  id: z.string().optional(),
+  isRequired: z.boolean().optional(),
+  name: z.string(),
+  options: z.array(z.string()).optional(),
+  publicQuestion: z.string().optional(),
+  type: VerificationParameterType$outboundSchema.optional(),
+  validRegions: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    fileTypes: "file_types",
+    isRequired: "is_required",
+    publicQuestion: "public_question",
+    validRegions: "valid_regions",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace VerificationParameter$ {
+  /** @deprecated use `VerificationParameter$inboundSchema` instead. */
+  export const inboundSchema = VerificationParameter$inboundSchema;
+  /** @deprecated use `VerificationParameter$outboundSchema` instead. */
+  export const outboundSchema = VerificationParameter$outboundSchema;
+  /** @deprecated use `VerificationParameter$Outbound` instead. */
+  export type Outbound = VerificationParameter$Outbound;
+}
+
+export function verificationParameterToJSON(
+  verificationParameter: VerificationParameter,
+): string {
+  return JSON.stringify(
+    VerificationParameter$outboundSchema.parse(verificationParameter),
+  );
+}
+
+export function verificationParameterFromJSON(
+  jsonString: string,
+): SafeParseResult<VerificationParameter, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VerificationParameter$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VerificationParameter' from JSON`,
+  );
+}

package/src/sdk/models/shared/verificationparameterinput.ts

@@ -0,0 +1,74 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type VerificationParameterInput = {
+  id?: string | undefined;
+  inputs?: Array<string> | undefined;
+  name?: string | undefined;
+};
+
+/** @internal */
+export const VerificationParameterInput$inboundSchema: z.ZodType<
+  VerificationParameterInput,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  inputs: z.array(z.string()).optional(),
+  name: z.string().optional(),
+});
+
+/** @internal */
+export type VerificationParameterInput$Outbound = {
+  id?: string | undefined;
+  inputs?: Array<string> | undefined;
+  name?: string | undefined;
+};
+
+/** @internal */
+export const VerificationParameterInput$outboundSchema: z.ZodType<
+  VerificationParameterInput$Outbound,
+  z.ZodTypeDef,
+  VerificationParameterInput
+> = z.object({
+  id: z.string().optional(),
+  inputs: z.array(z.string()).optional(),
+  name: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace VerificationParameterInput$ {
+  /** @deprecated use `VerificationParameterInput$inboundSchema` instead. */
+  export const inboundSchema = VerificationParameterInput$inboundSchema;
+  /** @deprecated use `VerificationParameterInput$outboundSchema` instead. */
+  export const outboundSchema = VerificationParameterInput$outboundSchema;
+  /** @deprecated use `VerificationParameterInput$Outbound` instead. */
+  export type Outbound = VerificationParameterInput$Outbound;
+}
+
+export function verificationParameterInputToJSON(
+  verificationParameterInput: VerificationParameterInput,
+): string {
+  return JSON.stringify(
+    VerificationParameterInput$outboundSchema.parse(verificationParameterInput),
+  );
+}
+
+export function verificationParameterInputFromJSON(
+  jsonString: string,
+): SafeParseResult<VerificationParameterInput, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VerificationParameterInput$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VerificationParameterInput' from JSON`,
+  );
+}