@gbg/go-core 0.1.3 → 0.2.0-alpha.0

package/src/models/slim-extraction.ts

@@ -0,0 +1,236 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import * as types from "../types/primitives.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+
+export type AggregatedFieldBoundingBox = {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+};
+
+export type AggregatedFieldRegionOfInterest = {
+  boundingBox?: AggregatedFieldBoundingBox | undefined;
+  side: string;
+  spectrum?: string | undefined;
+  imageId?: string | undefined;
+};
+
+export type AggregatedField = {
+  label: string;
+  value: string;
+  source: string;
+  isNonLatin: boolean;
+  regionOfInterest?: AggregatedFieldRegionOfInterest | undefined;
+};
+
+export type DetailBoundingBox = {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+};
+
+export type DetailRegionOfInterest = {
+  boundingBox?: DetailBoundingBox | undefined;
+  side: string;
+  spectrum?: string | undefined;
+  imageId?: string | undefined;
+};
+
+export type Detail = {
+  label: string;
+  value: string;
+  source: string;
+  isNonLatin: boolean;
+  regionOfInterest?: DetailRegionOfInterest | undefined;
+};
+
+export type ExtractedField = {
+  label: string;
+  details: Array<Detail>;
+};
+
+export type SlimExtraction = {
+  aggregatedFields?: Array<AggregatedField> | undefined;
+  extractedFields?: Array<ExtractedField> | undefined;
+};
+
+/** @internal */
+export const AggregatedFieldBoundingBox$inboundSchema: z.ZodMiniType<
+  AggregatedFieldBoundingBox,
+  unknown
+> = z.object({
+  x: types.number(),
+  y: types.number(),
+  width: types.number(),
+  height: types.number(),
+});
+
+export function aggregatedFieldBoundingBoxFromJSON(
+  jsonString: string,
+): SafeParseResult<AggregatedFieldBoundingBox, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AggregatedFieldBoundingBox$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AggregatedFieldBoundingBox' from JSON`,
+  );
+}
+
+/** @internal */
+export const AggregatedFieldRegionOfInterest$inboundSchema: z.ZodMiniType<
+  AggregatedFieldRegionOfInterest,
+  unknown
+> = z.object({
+  boundingBox: types.optional(
+    z.lazy(() => AggregatedFieldBoundingBox$inboundSchema),
+  ),
+  side: types.string(),
+  spectrum: types.optional(types.string()),
+  imageId: types.optional(types.string()),
+});
+
+export function aggregatedFieldRegionOfInterestFromJSON(
+  jsonString: string,
+): SafeParseResult<AggregatedFieldRegionOfInterest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AggregatedFieldRegionOfInterest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AggregatedFieldRegionOfInterest' from JSON`,
+  );
+}
+
+/** @internal */
+export const AggregatedField$inboundSchema: z.ZodMiniType<
+  AggregatedField,
+  unknown
+> = z.object({
+  label: types.string(),
+  value: types.string(),
+  source: types.string(),
+  isNonLatin: types.boolean(),
+  regionOfInterest: types.optional(
+    z.lazy(() => AggregatedFieldRegionOfInterest$inboundSchema),
+  ),
+});
+
+export function aggregatedFieldFromJSON(
+  jsonString: string,
+): SafeParseResult<AggregatedField, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AggregatedField$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AggregatedField' from JSON`,
+  );
+}
+
+/** @internal */
+export const DetailBoundingBox$inboundSchema: z.ZodMiniType<
+  DetailBoundingBox,
+  unknown
+> = z.object({
+  x: types.number(),
+  y: types.number(),
+  width: types.number(),
+  height: types.number(),
+});
+
+export function detailBoundingBoxFromJSON(
+  jsonString: string,
+): SafeParseResult<DetailBoundingBox, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DetailBoundingBox$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DetailBoundingBox' from JSON`,
+  );
+}
+
+/** @internal */
+export const DetailRegionOfInterest$inboundSchema: z.ZodMiniType<
+  DetailRegionOfInterest,
+  unknown
+> = z.object({
+  boundingBox: types.optional(z.lazy(() => DetailBoundingBox$inboundSchema)),
+  side: types.string(),
+  spectrum: types.optional(types.string()),
+  imageId: types.optional(types.string()),
+});
+
+export function detailRegionOfInterestFromJSON(
+  jsonString: string,
+): SafeParseResult<DetailRegionOfInterest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DetailRegionOfInterest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DetailRegionOfInterest' from JSON`,
+  );
+}
+
+/** @internal */
+export const Detail$inboundSchema: z.ZodMiniType<Detail, unknown> = z.object({
+  label: types.string(),
+  value: types.string(),
+  source: types.string(),
+  isNonLatin: types.boolean(),
+  regionOfInterest: types.optional(
+    z.lazy(() => DetailRegionOfInterest$inboundSchema),
+  ),
+});
+
+export function detailFromJSON(
+  jsonString: string,
+): SafeParseResult<Detail, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Detail$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Detail' from JSON`,
+  );
+}
+
+/** @internal */
+export const ExtractedField$inboundSchema: z.ZodMiniType<
+  ExtractedField,
+  unknown
+> = z.object({
+  label: types.string(),
+  details: z.array(z.lazy(() => Detail$inboundSchema)),
+});
+
+export function extractedFieldFromJSON(
+  jsonString: string,
+): SafeParseResult<ExtractedField, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ExtractedField$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ExtractedField' from JSON`,
+  );
+}
+
+/** @internal */
+export const SlimExtraction$inboundSchema: z.ZodMiniType<
+  SlimExtraction,
+  unknown
+> = z.object({
+  aggregatedFields: types.optional(
+    z.array(z.lazy(() => AggregatedField$inboundSchema)),
+  ),
+  extractedFields: types.optional(
+    z.array(z.lazy(() => ExtractedField$inboundSchema)),
+  ),
+});
+
+export function slimExtractionFromJSON(
+  jsonString: string,
+): SafeParseResult<SlimExtraction, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SlimExtraction$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SlimExtraction' from JSON`,
+  );
+}

package/src/models/slim-identity.ts

@@ -0,0 +1,348 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import * as types from "../types/primitives.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+
+export type CurrentAddressLocation = {
+  latitude?: string | undefined;
+  longitude?: string | undefined;
+  geoAccuracy?: string | undefined;
+  /**
+   * A What3words designation associated with this location with '.' separator.
+   */
+  what3words?: string | undefined;
+};
+
+export type CurrentAddress = {
+  /**
+   * Unformatted line based address
+   */
+  lines?: Array<string> | undefined;
+  /**
+   * The address as a single line
+   */
+  addressString?: string | undefined;
+  /**
+   * The number identifying the property's delivery point on its street — "128", "30A", "8-12". Not the street name (thoroughfare), the unit (subBuilding), or a building or property name (building). Empty for a property identified only by a name.
+   */
+  premise?: string | undefined;
+  /**
+   * The name of the building, complex, or named property — "Landmark House", "The Shard". Never the street number, in any country; that is premise. A property identified only by a name populates this field with premise left empty.
+   */
+  building?: string | undefined;
+  /**
+   * The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
+   */
+  subBuilding?: string | undefined;
+  /**
+   * This field holds the most common street or block data element within a country. For instance, USA Street
+   */
+  thoroughfare?: string | undefined;
+  /**
+   * The name of a dependent street or block, such as a street within a complex.
+   */
+  dependentThoroughfare?: string | undefined;
+  /**
+   * This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
+   */
+  locality?: string | undefined;
+  /**
+   * This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
+   */
+  dependentLocality?: string | undefined;
+  /**
+   * This is an even smaller area within a dependent locality, often used in very detailed addresses.
+   */
+  doubleDependentLocality?: string | undefined;
+  /**
+   * This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US
+   */
+  postalCode?: string | undefined;
+  /**
+   * This field contains the post box number associated with a particular delivery point, should one exist.
+   */
+  postBox?: string | undefined;
+  /**
+   * Country the address is in. It must be a valid ISO2 or ISO3 country code
+   */
+  country?: string | undefined;
+  superAdministrativeArea?: string | undefined;
+  administrativeArea?: string | undefined;
+  subAdministrativeArea?: string | undefined;
+  organization?: string | undefined;
+  location?: CurrentAddressLocation | undefined;
+};
+
+export type PlaceOfBirthLocation = {
+  latitude?: string | undefined;
+  longitude?: string | undefined;
+  geoAccuracy?: string | undefined;
+  /**
+   * A What3words designation associated with this location with '.' separator.
+   */
+  what3words?: string | undefined;
+};
+
+export type PlaceOfBirth = {
+  /**
+   * Unformatted line based address
+   */
+  lines?: Array<string> | undefined;
+  /**
+   * The address as a single line
+   */
+  addressString?: string | undefined;
+  /**
+   * The number identifying the property's delivery point on its street — "128", "30A", "8-12". Not the street name (thoroughfare), the unit (subBuilding), or a building or property name (building). Empty for a property identified only by a name.
+   */
+  premise?: string | undefined;
+  /**
+   * The name of the building, complex, or named property — "Landmark House", "The Shard". Never the street number, in any country; that is premise. A property identified only by a name populates this field with premise left empty.
+   */
+  building?: string | undefined;
+  /**
+   * The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
+   */
+  subBuilding?: string | undefined;
+  /**
+   * This field holds the most common street or block data element within a country. For instance, USA Street
+   */
+  thoroughfare?: string | undefined;
+  /**
+   * The name of a dependent street or block, such as a street within a complex.
+   */
+  dependentThoroughfare?: string | undefined;
+  /**
+   * This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
+   */
+  locality?: string | undefined;
+  /**
+   * This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
+   */
+  dependentLocality?: string | undefined;
+  /**
+   * This is an even smaller area within a dependent locality, often used in very detailed addresses.
+   */
+  doubleDependentLocality?: string | undefined;
+  /**
+   * This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US
+   */
+  postalCode?: string | undefined;
+  /**
+   * This field contains the post box number associated with a particular delivery point, should one exist.
+   */
+  postBox?: string | undefined;
+  /**
+   * Country the address is in. It must be a valid ISO2 or ISO3 country code
+   */
+  country?: string | undefined;
+  superAdministrativeArea?: string | undefined;
+  administrativeArea?: string | undefined;
+  subAdministrativeArea?: string | undefined;
+  organization?: string | undefined;
+  location?: PlaceOfBirthLocation | undefined;
+};
+
+export type IdNumber = {
+  /**
+   * The type of phone number, such as landline, mobile, fax, unknown etc
+   */
+  type: string;
+  /**
+   * ID number eg, National Insurance Number in UK, Social Securtiy Number in US
+   */
+  idNumber: string;
+  /**
+   * Country the address is in. It must be a valid ISO2 or ISO3 country code
+   */
+  country?: string | undefined;
+};
+
+export type SlimIdentity = {
+  /**
+   * Title of an individual such as Mr, Mrs, Dr, Sir
+   */
+  title?: string | undefined;
+  /**
+   * A person's name used by their collegues and friends to address them
+   */
+  firstName?: string | undefined;
+  /**
+   * Any other registered names used by the individual, not aliases
+   */
+  middleNames?: Array<string> | undefined;
+  /**
+   * Any family names for the individual
+   */
+  lastNames?: Array<string> | undefined;
+  /**
+   * Any family names for the individual
+   */
+  lastNamesAtBirth?: Array<string> | undefined;
+  /**
+   * Specified in year, month and day separated by -.  For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
+   */
+  dateOfBirth?: string | undefined;
+  gender?: string | undefined;
+  currentAddress?: CurrentAddress | undefined;
+  placeOfBirth?: PlaceOfBirth | undefined;
+  idNumbers?: Array<IdNumber> | undefined;
+};
+
+/** @internal */
+export const CurrentAddressLocation$inboundSchema: z.ZodMiniType<
+  CurrentAddressLocation,
+  unknown
+> = z.object({
+  latitude: types.optional(types.string()),
+  longitude: types.optional(types.string()),
+  geoAccuracy: types.optional(types.string()),
+  what3words: types.optional(types.string()),
+});
+
+export function currentAddressLocationFromJSON(
+  jsonString: string,
+): SafeParseResult<CurrentAddressLocation, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CurrentAddressLocation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CurrentAddressLocation' from JSON`,
+  );
+}
+
+/** @internal */
+export const CurrentAddress$inboundSchema: z.ZodMiniType<
+  CurrentAddress,
+  unknown
+> = z.object({
+  lines: types.optional(z.array(types.string())),
+  addressString: types.optional(types.string()),
+  premise: types.optional(types.string()),
+  building: types.optional(types.string()),
+  subBuilding: types.optional(types.string()),
+  thoroughfare: types.optional(types.string()),
+  dependentThoroughfare: types.optional(types.string()),
+  locality: types.optional(types.string()),
+  dependentLocality: types.optional(types.string()),
+  doubleDependentLocality: types.optional(types.string()),
+  postalCode: types.optional(types.string()),
+  postBox: types.optional(types.string()),
+  country: types.optional(types.string()),
+  superAdministrativeArea: types.optional(types.string()),
+  administrativeArea: types.optional(types.string()),
+  subAdministrativeArea: types.optional(types.string()),
+  organization: types.optional(types.string()),
+  location: types.optional(z.lazy(() => CurrentAddressLocation$inboundSchema)),
+});
+
+export function currentAddressFromJSON(
+  jsonString: string,
+): SafeParseResult<CurrentAddress, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CurrentAddress$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CurrentAddress' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlaceOfBirthLocation$inboundSchema: z.ZodMiniType<
+  PlaceOfBirthLocation,
+  unknown
+> = z.object({
+  latitude: types.optional(types.string()),
+  longitude: types.optional(types.string()),
+  geoAccuracy: types.optional(types.string()),
+  what3words: types.optional(types.string()),
+});
+
+export function placeOfBirthLocationFromJSON(
+  jsonString: string,
+): SafeParseResult<PlaceOfBirthLocation, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlaceOfBirthLocation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlaceOfBirthLocation' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlaceOfBirth$inboundSchema: z.ZodMiniType<PlaceOfBirth, unknown> =
+  z.object({
+    lines: types.optional(z.array(types.string())),
+    addressString: types.optional(types.string()),
+    premise: types.optional(types.string()),
+    building: types.optional(types.string()),
+    subBuilding: types.optional(types.string()),
+    thoroughfare: types.optional(types.string()),
+    dependentThoroughfare: types.optional(types.string()),
+    locality: types.optional(types.string()),
+    dependentLocality: types.optional(types.string()),
+    doubleDependentLocality: types.optional(types.string()),
+    postalCode: types.optional(types.string()),
+    postBox: types.optional(types.string()),
+    country: types.optional(types.string()),
+    superAdministrativeArea: types.optional(types.string()),
+    administrativeArea: types.optional(types.string()),
+    subAdministrativeArea: types.optional(types.string()),
+    organization: types.optional(types.string()),
+    location: types.optional(z.lazy(() => PlaceOfBirthLocation$inboundSchema)),
+  });
+
+export function placeOfBirthFromJSON(
+  jsonString: string,
+): SafeParseResult<PlaceOfBirth, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlaceOfBirth$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlaceOfBirth' from JSON`,
+  );
+}
+
+/** @internal */
+export const IdNumber$inboundSchema: z.ZodMiniType<IdNumber, unknown> = z
+  .object({
+    type: types.string(),
+    idNumber: types.string(),
+    country: types.optional(types.string()),
+  });
+
+export function idNumberFromJSON(
+  jsonString: string,
+): SafeParseResult<IdNumber, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => IdNumber$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'IdNumber' from JSON`,
+  );
+}
+
+/** @internal */
+export const SlimIdentity$inboundSchema: z.ZodMiniType<SlimIdentity, unknown> =
+  z.object({
+    title: types.optional(types.string()),
+    firstName: types.optional(types.string()),
+    middleNames: types.optional(z.array(types.string())),
+    lastNames: types.optional(z.array(types.string())),
+    lastNamesAtBirth: types.optional(z.array(types.string())),
+    dateOfBirth: types.optional(types.string()),
+    gender: types.optional(types.string()),
+    currentAddress: types.optional(z.lazy(() => CurrentAddress$inboundSchema)),
+    placeOfBirth: types.optional(z.lazy(() => PlaceOfBirth$inboundSchema)),
+    idNumbers: types.optional(z.array(z.lazy(() => IdNumber$inboundSchema))),
+  });
+
+export function slimIdentityFromJSON(
+  jsonString: string,
+): SafeParseResult<SlimIdentity, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SlimIdentity$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SlimIdentity' from JSON`,
+  );
+}