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

package/src/models/slim-identity.ts

@@ -0,0 +1,347 @@
+/*
+ * 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 { 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: z.optional(z.string()),
+  longitude: z.optional(z.string()),
+  geoAccuracy: z.optional(z.string()),
+  what3words: z.optional(z.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: z.optional(z.array(z.string())),
+  addressString: z.optional(z.string()),
+  premise: z.optional(z.string()),
+  building: z.optional(z.string()),
+  subBuilding: z.optional(z.string()),
+  thoroughfare: z.optional(z.string()),
+  dependentThoroughfare: z.optional(z.string()),
+  locality: z.optional(z.string()),
+  dependentLocality: z.optional(z.string()),
+  doubleDependentLocality: z.optional(z.string()),
+  postalCode: z.optional(z.string()),
+  postBox: z.optional(z.string()),
+  country: z.optional(z.string()),
+  superAdministrativeArea: z.optional(z.string()),
+  administrativeArea: z.optional(z.string()),
+  subAdministrativeArea: z.optional(z.string()),
+  organization: z.optional(z.string()),
+  location: z.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: z.optional(z.string()),
+  longitude: z.optional(z.string()),
+  geoAccuracy: z.optional(z.string()),
+  what3words: z.optional(z.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: z.optional(z.array(z.string())),
+    addressString: z.optional(z.string()),
+    premise: z.optional(z.string()),
+    building: z.optional(z.string()),
+    subBuilding: z.optional(z.string()),
+    thoroughfare: z.optional(z.string()),
+    dependentThoroughfare: z.optional(z.string()),
+    locality: z.optional(z.string()),
+    dependentLocality: z.optional(z.string()),
+    doubleDependentLocality: z.optional(z.string()),
+    postalCode: z.optional(z.string()),
+    postBox: z.optional(z.string()),
+    country: z.optional(z.string()),
+    superAdministrativeArea: z.optional(z.string()),
+    administrativeArea: z.optional(z.string()),
+    subAdministrativeArea: z.optional(z.string()),
+    organization: z.optional(z.string()),
+    location: z.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: z.string(),
+    idNumber: z.string(),
+    country: z.optional(z.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: z.optional(z.string()),
+    firstName: z.optional(z.string()),
+    middleNames: z.optional(z.array(z.string())),
+    lastNames: z.optional(z.array(z.string())),
+    lastNamesAtBirth: z.optional(z.array(z.string())),
+    dateOfBirth: z.optional(z.string()),
+    gender: z.optional(z.string()),
+    currentAddress: z.optional(z.lazy(() => CurrentAddress$inboundSchema)),
+    placeOfBirth: z.optional(z.lazy(() => PlaceOfBirth$inboundSchema)),
+    idNumbers: z.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`,
+  );
+}

package/src/models/slim-interaction-fetch-response.ts

@@ -0,0 +1,124 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+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 { SDKValidationError } from "./errors/sdk-validation-error.js";
+import {
+  OutstandingGroup,
+  OutstandingGroup$inboundSchema,
+} from "./outstanding-group.js";
+import { SlimResult, SlimResult$inboundSchema } from "./slim-result.js";
+
+export const SlimInteractionFetchResponseStatus = {
+  InProgress: "InProgress",
+  Completed: "Completed",
+  Failed: "Failed",
+  Paused: "Paused",
+} as const;
+export type SlimInteractionFetchResponseStatus = OpenEnum<
+  typeof SlimInteractionFetchResponseStatus
+>;
+
+export type SlimInteractionFetchResponseJourney = {
+  status: SlimInteractionFetchResponseStatus;
+};
+
+export type SlimInteractionFetchResponseJoinedDevice = {
+  connected: boolean;
+};
+
+export type SlimInteractionFetchResponse = {
+  view: "slim";
+  instanceId: string;
+  interactionId?: string | undefined;
+  journey: SlimInteractionFetchResponseJourney;
+  interaction?: { [k: string]: any } | undefined;
+  processing?: boolean | undefined;
+  outstanding?: Array<string> | undefined;
+  outstandingGroups?: Array<OutstandingGroup> | undefined;
+  instructions?: Array<string> | undefined;
+  result?: SlimResult | undefined;
+  joinedDevice?: SlimInteractionFetchResponseJoinedDevice | undefined;
+};
+
+/** @internal */
+export const SlimInteractionFetchResponseStatus$inboundSchema: z.ZodMiniType<
+  SlimInteractionFetchResponseStatus,
+  unknown
+> = openEnums.inboundSchema(SlimInteractionFetchResponseStatus);
+
+/** @internal */
+export const SlimInteractionFetchResponseJourney$inboundSchema: z.ZodMiniType<
+  SlimInteractionFetchResponseJourney,
+  unknown
+> = z.object({
+  status: SlimInteractionFetchResponseStatus$inboundSchema,
+});
+
+export function slimInteractionFetchResponseJourneyFromJSON(
+  jsonString: string,
+): SafeParseResult<SlimInteractionFetchResponseJourney, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SlimInteractionFetchResponseJourney$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SlimInteractionFetchResponseJourney' from JSON`,
+  );
+}
+
+/** @internal */
+export const SlimInteractionFetchResponseJoinedDevice$inboundSchema:
+  z.ZodMiniType<SlimInteractionFetchResponseJoinedDevice, unknown> = z.object({
+    connected: z.boolean(),
+  });
+
+export function slimInteractionFetchResponseJoinedDeviceFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  SlimInteractionFetchResponseJoinedDevice,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SlimInteractionFetchResponseJoinedDevice$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'SlimInteractionFetchResponseJoinedDevice' from JSON`,
+  );
+}
+
+/** @internal */
+export const SlimInteractionFetchResponse$inboundSchema: z.ZodMiniType<
+  SlimInteractionFetchResponse,
+  unknown
+> = z.object({
+  view: z.literal("slim"),
+  instanceId: z.string(),
+  interactionId: z.optional(z.string()),
+  journey: z.lazy(() => SlimInteractionFetchResponseJourney$inboundSchema),
+  interaction: z.optional(z.record(z.string(), z.any())),
+  processing: z.optional(z.boolean()),
+  outstanding: z.optional(z.array(z.string())),
+  outstandingGroups: z.optional(z.array(OutstandingGroup$inboundSchema)),
+  instructions: z.optional(z.array(z.string())),
+  result: z.optional(SlimResult$inboundSchema),
+  joinedDevice: z.optional(
+    z.lazy(() => SlimInteractionFetchResponseJoinedDevice$inboundSchema),
+  ),
+});
+
+export function slimInteractionFetchResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SlimInteractionFetchResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SlimInteractionFetchResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SlimInteractionFetchResponse' from JSON`,
+  );
+}

package/src/models/slim-journey.ts

@@ -0,0 +1,36 @@
+/*
+ * 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 { SDKValidationError } from "./errors/sdk-validation-error.js";
+
+export type SlimJourney = {
+  id?: string | undefined;
+  name?: string | undefined;
+  version?: string | undefined;
+  startedAt?: string | undefined;
+  endedAt?: string | undefined;
+};
+
+/** @internal */
+export const SlimJourney$inboundSchema: z.ZodMiniType<SlimJourney, unknown> = z
+  .object({
+    id: z.optional(z.string()),
+    name: z.optional(z.string()),
+    version: z.optional(z.string()),
+    startedAt: z.optional(z.string()),
+    endedAt: z.optional(z.string()),
+  });
+
+export function slimJourneyFromJSON(
+  jsonString: string,
+): SafeParseResult<SlimJourney, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SlimJourney$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SlimJourney' from JSON`,
+  );
+}

package/src/models/slim-module-step-error.ts

@@ -0,0 +1,99 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+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 { SDKValidationError } from "./errors/sdk-validation-error.js";
+
+export const SlimModuleStepErrorLocation = {
+  Path: "Path",
+  Authorization: "Authorization",
+  Header: "Header",
+  QueryString: "Query String",
+  Request: "Request",
+  Body: "Body",
+  Service: "Service",
+  Flow: "Flow",
+} as const;
+export type SlimModuleStepErrorLocation = OpenEnum<
+  typeof SlimModuleStepErrorLocation
+>;
+
+export type Cause = {
+  /**
+   * The module's own error code, as emitted (e.g. `5012`, `BD10003`). Present only when the module emitted a structured code; look it up in the module or GBG Errors Catalog documentation.
+   */
+  code?: string | undefined;
+  /**
+   * The upstream service's trace id for the failed request (e.g. SIP's `gbg-correlation-id`), taken from the same error as `code`.
+   */
+  correlationId?: string | undefined;
+  /**
+   * The module the failed step ran. On an interaction fetch, which carries no step history, `cause` has only `moduleId`/`variantId`; the module code and correlation id are on the state fetch.
+   */
+  moduleId?: string | undefined;
+  /**
+   * The module variant (configuration) the step ran.
+   */
+  variantId?: string | undefined;
+};
+
+export type SlimModuleStepError = {
+  code: string;
+  name: string;
+  problem: string;
+  action: string;
+  location?: SlimModuleStepErrorLocation | undefined;
+  cause?: Cause | undefined;
+};
+
+/** @internal */
+export const SlimModuleStepErrorLocation$inboundSchema: z.ZodMiniType<
+  SlimModuleStepErrorLocation,
+  unknown
+> = openEnums.inboundSchema(SlimModuleStepErrorLocation);
+
+/** @internal */
+export const Cause$inboundSchema: z.ZodMiniType<Cause, unknown> = z.object({
+  code: z.optional(z.string()),
+  correlationId: z.optional(z.string()),
+  moduleId: z.optional(z.string()),
+  variantId: z.optional(z.string()),
+});
+
+export function causeFromJSON(
+  jsonString: string,
+): SafeParseResult<Cause, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Cause$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Cause' from JSON`,
+  );
+}
+
+/** @internal */
+export const SlimModuleStepError$inboundSchema: z.ZodMiniType<
+  SlimModuleStepError,
+  unknown
+> = z.object({
+  code: z.string(),
+  name: z.string(),
+  problem: z.string(),
+  action: z.string(),
+  location: z.optional(SlimModuleStepErrorLocation$inboundSchema),
+  cause: z.optional(z.lazy(() => Cause$inboundSchema)),
+});
+
+export function slimModuleStepErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<SlimModuleStepError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SlimModuleStepError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SlimModuleStepError' from JSON`,
+  );
+}