/*
 * 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 {
  CustomerIdentificationResult,
  CustomerIdentificationResult$inboundSchema,
  CustomerIdentificationResult$Outbound,
  CustomerIdentificationResult$outboundSchema,
} from "./customeridentificationresult.js";
import {
  IdentityIdentification,
  IdentityIdentification$inboundSchema,
  IdentityIdentification$Outbound,
  IdentityIdentification$outboundSchema,
} from "./identityidentification.js";

export enum CheckTypes {
  CheckTypeUnspecified = "CHECK_TYPE_UNSPECIFIED",
  Database = "DATABASE",
  Documentary = "DOCUMENTARY",
}
export type CheckTypesOpen = OpenEnum<typeof CheckTypes>;

/**
 * **Field Dependencies:**
 *
 * @remarks
 *
 * A `birth_date` is required when the `check_types` is DATABASE
 *
 * Required if `check_types` is `DATABASE`.
 *
 * Otherwise, must be empty.
 */
export type CustomerIdentificationBirthDate = {
  /**
   * Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
   */
  day?: number | undefined;
  /**
   * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
   */
  month?: number | undefined;
  /**
   * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
   */
  year?: number | undefined;
};

/**
 * **Field Dependencies:**
 *
 * @remarks
 *
 * A US `legal_address` is required when the `check_types` is `DATABASE`
 *
 * Required if `check_types` is `DATABASE`.
 *
 * Otherwise, must be empty.
 */
export type CustomerIdentificationLegalAddress = {
  /**
   * Unstructured address lines describing the lower levels of an address.
   *
   * @remarks
   *
   *  Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language.
   *
   *  The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved.
   *
   *  Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
   */
  addressLines?: Array<string> | undefined;
  /**
   * Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
   */
  administrativeArea?: string | undefined;
  /**
   * Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations.
   *
   * @remarks
   *
   *  If this value is not known, it should be omitted (rather than specifying a possibly incorrect default).
   *
   *  Examples: "zh-Hant", "ja", "ja-Latn", "en".
   */
  languageCode?: string | undefined;
  /**
   * Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
   */
  locality?: string | undefined;
  /**
   * Optional. The name of the organization at the address.
   */
  organization?: string | undefined;
  /**
   * Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
   */
  postalCode?: string | undefined;
  /**
   * Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
   */
  recipients?: Array<string> | undefined;
  /**
   * Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
   */
  regionCode?: string | undefined;
  /**
   * The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision.
   *
   * @remarks
   *
   *  All new revisions **must** be backward compatible with old revisions.
   */
  revision?: number | undefined;
  /**
   * Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
   */
  sortingCode?: string | undefined;
  /**
   * Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
   */
  sublocality?: string | undefined;
};

/**
 * **Field Dependencies:**
 *
 * @remarks
 *
 * An identity is required when the `check_types` is DATABASE
 *
 * Required if `check_types` is `DATABASE`.
 *
 * Otherwise, must be empty.
 */
export type Identity = {
  /**
   * **Field Dependencies:**
   *
   * @remarks
   *
   * A `birth_date` is required when the `check_types` is DATABASE
   *
   * Required if `check_types` is `DATABASE`.
   *
   * Otherwise, must be empty.
   */
  birthDate?: CustomerIdentificationBirthDate | null | undefined;
  /**
   * The countries where a natural person retains citizenship; This is used for tax (treaty) and country block list considerations Two character region code, complies with https://cldr.unicode.org/index Example values: "US", "CA"
   */
  citizenshipRegionCodes?: Array<string> | undefined;
  /**
   * Email addresses
   */
  emailAddresses?: Array<string> | undefined;
  /**
   * **Field Dependencies:**
   *
   * @remarks
   *
   * A `family_name` is required when the `check_types` is DATABASE
   *
   * Required if `check_types` is `DATABASE`.
   *
   * Otherwise, must be empty.
   */
  familyName?: string | undefined;
  /**
   * **Field Dependencies:**
   *
   * @remarks
   *
   * A `given_name` is required when the `check_types` is DATABASE
   *
   * Required if `check_types` is `DATABASE`.
   *
   * Otherwise, must be empty.
   */
  givenName?: string | undefined;
  /**
   * **Field Dependencies:**
   *
   * @remarks
   *
   * A identification is required with a US `region_code` when the `check_types` is DATABASE
   *
   * Required if `check_types` is `DATABASE`.
   *
   * Otherwise, must be empty.
   */
  identifications?: Array<IdentityIdentification> | undefined;
  /**
   * **Field Dependencies:**
   *
   * @remarks
   *
   * A US `legal_address` is required when the `check_types` is `DATABASE`
   *
   * Required if `check_types` is `DATABASE`.
   *
   * Otherwise, must be empty.
   */
  legalAddress?: CustomerIdentificationLegalAddress | null | undefined;
  /**
   * Middle names
   */
  middleNames?: Array<string> | undefined;
  /**
   * Phone numbers
   */
  phoneNumbers?: Array<string> | undefined;
};

/**
 * CustomerIdentification includes the details of a customer identification check
 */
export type CustomerIdentification = {
  /**
   * The types of checks being requested Must either be DATABASE or DOCUMENTARY else will return INVALID_ARGUMENT
   */
  checkTypes?: Array<CheckTypesOpen> | undefined;
  /**
   * **Field Dependencies:**
   *
   * @remarks
   *
   * An identity is required when the `check_types` is DATABASE
   *
   * Required if `check_types` is `DATABASE`.
   *
   * Otherwise, must be empty.
   */
  identity?: Identity | null | undefined;
  /**
   * required format: correspondents/{correspondent_id}/customerIdentifications/{customer_identification_id}
   */
  name?: string | undefined;
  /**
   * The results of the identity verification check(s)
   */
  results?: Array<CustomerIdentificationResult> | undefined;
};

/** @internal */
export const CheckTypes$inboundSchema: z.ZodType<
  CheckTypesOpen,
  z.ZodTypeDef,
  unknown
> = z
  .union([
    z.nativeEnum(CheckTypes),
    z.string().transform(catchUnrecognizedEnum),
  ]);

/** @internal */
export const CheckTypes$outboundSchema: z.ZodType<
  CheckTypesOpen,
  z.ZodTypeDef,
  CheckTypesOpen
> = z.union([
  z.nativeEnum(CheckTypes),
  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 CheckTypes$ {
  /** @deprecated use `CheckTypes$inboundSchema` instead. */
  export const inboundSchema = CheckTypes$inboundSchema;
  /** @deprecated use `CheckTypes$outboundSchema` instead. */
  export const outboundSchema = CheckTypes$outboundSchema;
}

/** @internal */
export const CustomerIdentificationBirthDate$inboundSchema: z.ZodType<
  CustomerIdentificationBirthDate,
  z.ZodTypeDef,
  unknown
> = z.object({
  day: z.number().int().optional(),
  month: z.number().int().optional(),
  year: z.number().int().optional(),
});

/** @internal */
export type CustomerIdentificationBirthDate$Outbound = {
  day?: number | undefined;
  month?: number | undefined;
  year?: number | undefined;
};

/** @internal */
export const CustomerIdentificationBirthDate$outboundSchema: z.ZodType<
  CustomerIdentificationBirthDate$Outbound,
  z.ZodTypeDef,
  CustomerIdentificationBirthDate
> = z.object({
  day: z.number().int().optional(),
  month: z.number().int().optional(),
  year: z.number().int().optional(),
});

/**
 * @internal
 * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
 */
export namespace CustomerIdentificationBirthDate$ {
  /** @deprecated use `CustomerIdentificationBirthDate$inboundSchema` instead. */
  export const inboundSchema = CustomerIdentificationBirthDate$inboundSchema;
  /** @deprecated use `CustomerIdentificationBirthDate$outboundSchema` instead. */
  export const outboundSchema = CustomerIdentificationBirthDate$outboundSchema;
  /** @deprecated use `CustomerIdentificationBirthDate$Outbound` instead. */
  export type Outbound = CustomerIdentificationBirthDate$Outbound;
}

export function customerIdentificationBirthDateToJSON(
  customerIdentificationBirthDate: CustomerIdentificationBirthDate,
): string {
  return JSON.stringify(
    CustomerIdentificationBirthDate$outboundSchema.parse(
      customerIdentificationBirthDate,
    ),
  );
}

export function customerIdentificationBirthDateFromJSON(
  jsonString: string,
): SafeParseResult<CustomerIdentificationBirthDate, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => CustomerIdentificationBirthDate$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'CustomerIdentificationBirthDate' from JSON`,
  );
}

/** @internal */
export const CustomerIdentificationLegalAddress$inboundSchema: z.ZodType<
  CustomerIdentificationLegalAddress,
  z.ZodTypeDef,
  unknown
> = z.object({
  address_lines: z.array(z.string()).optional(),
  administrative_area: z.string().optional(),
  language_code: z.string().optional(),
  locality: z.string().optional(),
  organization: z.string().optional(),
  postal_code: z.string().optional(),
  recipients: z.array(z.string()).optional(),
  region_code: z.string().optional(),
  revision: z.number().int().optional(),
  sorting_code: z.string().optional(),
  sublocality: z.string().optional(),
}).transform((v) => {
  return remap$(v, {
    "address_lines": "addressLines",
    "administrative_area": "administrativeArea",
    "language_code": "languageCode",
    "postal_code": "postalCode",
    "region_code": "regionCode",
    "sorting_code": "sortingCode",
  });
});

/** @internal */
export type CustomerIdentificationLegalAddress$Outbound = {
  address_lines?: Array<string> | undefined;
  administrative_area?: string | undefined;
  language_code?: string | undefined;
  locality?: string | undefined;
  organization?: string | undefined;
  postal_code?: string | undefined;
  recipients?: Array<string> | undefined;
  region_code?: string | undefined;
  revision?: number | undefined;
  sorting_code?: string | undefined;
  sublocality?: string | undefined;
};

/** @internal */
export const CustomerIdentificationLegalAddress$outboundSchema: z.ZodType<
  CustomerIdentificationLegalAddress$Outbound,
  z.ZodTypeDef,
  CustomerIdentificationLegalAddress
> = z.object({
  addressLines: z.array(z.string()).optional(),
  administrativeArea: z.string().optional(),
  languageCode: z.string().optional(),
  locality: z.string().optional(),
  organization: z.string().optional(),
  postalCode: z.string().optional(),
  recipients: z.array(z.string()).optional(),
  regionCode: z.string().optional(),
  revision: z.number().int().optional(),
  sortingCode: z.string().optional(),
  sublocality: z.string().optional(),
}).transform((v) => {
  return remap$(v, {
    addressLines: "address_lines",
    administrativeArea: "administrative_area",
    languageCode: "language_code",
    postalCode: "postal_code",
    regionCode: "region_code",
    sortingCode: "sorting_code",
  });
});

/**
 * @internal
 * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
 */
export namespace CustomerIdentificationLegalAddress$ {
  /** @deprecated use `CustomerIdentificationLegalAddress$inboundSchema` instead. */
  export const inboundSchema = CustomerIdentificationLegalAddress$inboundSchema;
  /** @deprecated use `CustomerIdentificationLegalAddress$outboundSchema` instead. */
  export const outboundSchema =
    CustomerIdentificationLegalAddress$outboundSchema;
  /** @deprecated use `CustomerIdentificationLegalAddress$Outbound` instead. */
  export type Outbound = CustomerIdentificationLegalAddress$Outbound;
}

export function customerIdentificationLegalAddressToJSON(
  customerIdentificationLegalAddress: CustomerIdentificationLegalAddress,
): string {
  return JSON.stringify(
    CustomerIdentificationLegalAddress$outboundSchema.parse(
      customerIdentificationLegalAddress,
    ),
  );
}

export function customerIdentificationLegalAddressFromJSON(
  jsonString: string,
): SafeParseResult<CustomerIdentificationLegalAddress, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) =>
      CustomerIdentificationLegalAddress$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'CustomerIdentificationLegalAddress' from JSON`,
  );
}

/** @internal */
export const Identity$inboundSchema: z.ZodType<
  Identity,
  z.ZodTypeDef,
  unknown
> = z.object({
  birth_date: z.nullable(
    z.lazy(() => CustomerIdentificationBirthDate$inboundSchema),
  ).optional(),
  citizenship_region_codes: z.array(z.string()).optional(),
  email_addresses: z.array(z.string()).optional(),
  family_name: z.string().optional(),
  given_name: z.string().optional(),
  identifications: z.array(IdentityIdentification$inboundSchema).optional(),
  legal_address: z.nullable(
    z.lazy(() => CustomerIdentificationLegalAddress$inboundSchema),
  ).optional(),
  middle_names: z.array(z.string()).optional(),
  phone_numbers: z.array(z.string()).optional(),
}).transform((v) => {
  return remap$(v, {
    "birth_date": "birthDate",
    "citizenship_region_codes": "citizenshipRegionCodes",
    "email_addresses": "emailAddresses",
    "family_name": "familyName",
    "given_name": "givenName",
    "legal_address": "legalAddress",
    "middle_names": "middleNames",
    "phone_numbers": "phoneNumbers",
  });
});

/** @internal */
export type Identity$Outbound = {
  birth_date?: CustomerIdentificationBirthDate$Outbound | null | undefined;
  citizenship_region_codes?: Array<string> | undefined;
  email_addresses?: Array<string> | undefined;
  family_name?: string | undefined;
  given_name?: string | undefined;
  identifications?: Array<IdentityIdentification$Outbound> | undefined;
  legal_address?:
    | CustomerIdentificationLegalAddress$Outbound
    | null
    | undefined;
  middle_names?: Array<string> | undefined;
  phone_numbers?: Array<string> | undefined;
};

/** @internal */
export const Identity$outboundSchema: z.ZodType<
  Identity$Outbound,
  z.ZodTypeDef,
  Identity
> = z.object({
  birthDate: z.nullable(
    z.lazy(() => CustomerIdentificationBirthDate$outboundSchema),
  ).optional(),
  citizenshipRegionCodes: z.array(z.string()).optional(),
  emailAddresses: z.array(z.string()).optional(),
  familyName: z.string().optional(),
  givenName: z.string().optional(),
  identifications: z.array(IdentityIdentification$outboundSchema).optional(),
  legalAddress: z.nullable(
    z.lazy(() => CustomerIdentificationLegalAddress$outboundSchema),
  ).optional(),
  middleNames: z.array(z.string()).optional(),
  phoneNumbers: z.array(z.string()).optional(),
}).transform((v) => {
  return remap$(v, {
    birthDate: "birth_date",
    citizenshipRegionCodes: "citizenship_region_codes",
    emailAddresses: "email_addresses",
    familyName: "family_name",
    givenName: "given_name",
    legalAddress: "legal_address",
    middleNames: "middle_names",
    phoneNumbers: "phone_numbers",
  });
});

/**
 * @internal
 * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
 */
export namespace Identity$ {
  /** @deprecated use `Identity$inboundSchema` instead. */
  export const inboundSchema = Identity$inboundSchema;
  /** @deprecated use `Identity$outboundSchema` instead. */
  export const outboundSchema = Identity$outboundSchema;
  /** @deprecated use `Identity$Outbound` instead. */
  export type Outbound = Identity$Outbound;
}

export function identityToJSON(identity: Identity): string {
  return JSON.stringify(Identity$outboundSchema.parse(identity));
}

export function identityFromJSON(
  jsonString: string,
): SafeParseResult<Identity, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => Identity$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'Identity' from JSON`,
  );
}

/** @internal */
export const CustomerIdentification$inboundSchema: z.ZodType<
  CustomerIdentification,
  z.ZodTypeDef,
  unknown
> = z.object({
  check_types: z.array(CheckTypes$inboundSchema).optional(),
  identity: z.nullable(z.lazy(() => Identity$inboundSchema)).optional(),
  name: z.string().optional(),
  results: z.array(CustomerIdentificationResult$inboundSchema).optional(),
}).transform((v) => {
  return remap$(v, {
    "check_types": "checkTypes",
  });
});

/** @internal */
export type CustomerIdentification$Outbound = {
  check_types?: Array<string> | undefined;
  identity?: Identity$Outbound | null | undefined;
  name?: string | undefined;
  results?: Array<CustomerIdentificationResult$Outbound> | undefined;
};

/** @internal */
export const CustomerIdentification$outboundSchema: z.ZodType<
  CustomerIdentification$Outbound,
  z.ZodTypeDef,
  CustomerIdentification
> = z.object({
  checkTypes: z.array(CheckTypes$outboundSchema).optional(),
  identity: z.nullable(z.lazy(() => Identity$outboundSchema)).optional(),
  name: z.string().optional(),
  results: z.array(CustomerIdentificationResult$outboundSchema).optional(),
}).transform((v) => {
  return remap$(v, {
    checkTypes: "check_types",
  });
});

/**
 * @internal
 * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
 */
export namespace CustomerIdentification$ {
  /** @deprecated use `CustomerIdentification$inboundSchema` instead. */
  export const inboundSchema = CustomerIdentification$inboundSchema;
  /** @deprecated use `CustomerIdentification$outboundSchema` instead. */
  export const outboundSchema = CustomerIdentification$outboundSchema;
  /** @deprecated use `CustomerIdentification$Outbound` instead. */
  export type Outbound = CustomerIdentification$Outbound;
}

export function customerIdentificationToJSON(
  customerIdentification: CustomerIdentification,
): string {
  return JSON.stringify(
    CustomerIdentification$outboundSchema.parse(customerIdentification),
  );
}

export function customerIdentificationFromJSON(
  jsonString: string,
): SafeParseResult<CustomerIdentification, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => CustomerIdentification$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'CustomerIdentification' from JSON`,
  );
}