@gbg/go-core 0.0.1-alpha.16 → 0.0.1-alpha.18

package/src/models/operations/get-journey-state.ts

@@ -1094,34 +1094,34 @@ export type GetJourneyStateBiometric4 = {
   id?: string | undefined;
   type?: string | undefined;
   selfieImage: string;
-  anchorImage: string;
+  selfieImageEncryption?: boolean | undefined;
 };
 
 export type GetJourneyStateBiometric3 = {
   id?: string | undefined;
   type?: string | undefined;
-  selfieImage: string;
-  selfieImageEncryption?: boolean | undefined;
+  faceImage: string;
 };
 
 export type GetJourneyStateBiometric2 = {
   id?: string | undefined;
   type?: string | undefined;
-  face1Image: string;
-  face2Image: string;
+  selfieImage: string;
+  anchorImage: string;
 };
 
 export type GetJourneyStateBiometric1 = {
   id?: string | undefined;
   type?: string | undefined;
-  faceImage: string;
+  face1Image: string;
+  face2Image: string;
 };
 
 export type GetJourneyStateBiometricUnion =
-  | GetJourneyStateBiometric2
-  | GetJourneyStateBiometric4
   | GetJourneyStateBiometric1
-  | GetJourneyStateBiometric3;
+  | GetJourneyStateBiometric2
+  | GetJourneyStateBiometric3
+  | GetJourneyStateBiometric4;
 
 export type GetJourneyStateUser = {
   id: string;
@@ -1204,19 +1204,63 @@ export type GetJourneyStateConsent = {
   signatory?: string | undefined;
 };
 
+export type GetJourneyStateAccount = {
+  /**
+   * The type of account, e.g. Bank Account, Building Society
+   */
+  type: string;
+  /**
+   * Account number
+   */
+  accountNumber: string;
+  /**
+   * UK sort code
+   */
+  sortCode?: string | undefined;
+  /**
+   * US ABA routing number
+   */
+  routingNumber?: string | undefined;
+  /**
+   * International Bank Account Number
+   */
+  iban?: string | undefined;
+  /**
+   * BIC/SWIFT code
+   */
+  bic?: string | undefined;
+  /**
+   * Name on the account
+   */
+  accountHolderName?: string | undefined;
+  /**
+   * Name of the financial institution
+   */
+  bankName?: string | undefined;
+  /**
+   * Country the address is in. It must be a valid ISO2 or ISO3 country code
+   */
+  country?: string | undefined;
+  /**
+   * Account classification, e.g. current, savings
+   */
+  accountType?: string | undefined;
+};
+
 export type GetJourneyStateSubject = {
   identity?: GetJourneyStateIdentity | undefined;
   documents?: Array<GetJourneyStateDocument> | undefined;
   biometrics?:
     | Array<
-      | GetJourneyStateBiometric2
-      | GetJourneyStateBiometric4
       | GetJourneyStateBiometric1
+      | GetJourneyStateBiometric2
       | GetJourneyStateBiometric3
+      | GetJourneyStateBiometric4
     >
     | undefined;
   sessions?: Array<GetJourneyStateSession> | undefined;
   consent?: Array<GetJourneyStateConsent> | undefined;
+  accounts?: Array<GetJourneyStateAccount> | undefined;
   uid?: string | undefined;
 };
 
@@ -1233,7 +1277,7 @@ export type GetJourneyStateResponse = {
    */
   instanceId: string;
   status: GetJourneyStateStatus;
-  metaData?: MetaData | undefined;
+  metaData: MetaData;
   context?: GetJourneyStateContext | undefined;
   data?: { [k: string]: any } | undefined;
 };
@@ -2753,7 +2797,7 @@ export const GetJourneyStateBiometric4$inboundSchema: z.ZodMiniType<
   id: types.optional(types.string()),
   type: types.optional(types.string()),
   selfieImage: types.string(),
-  anchorImage: types.string(),
+  selfieImageEncryption: types.optional(types.boolean()),
 });
 
 export function getJourneyStateBiometric4FromJSON(
@@ -2773,8 +2817,7 @@ export const GetJourneyStateBiometric3$inboundSchema: z.ZodMiniType<
 > = z.object({
   id: types.optional(types.string()),
   type: types.optional(types.string()),
-  selfieImage: types.string(),
-  selfieImageEncryption: types.optional(types.boolean()),
+  faceImage: types.string(),
 });
 
 export function getJourneyStateBiometric3FromJSON(
@@ -2794,8 +2837,8 @@ export const GetJourneyStateBiometric2$inboundSchema: z.ZodMiniType<
 > = z.object({
   id: types.optional(types.string()),
   type: types.optional(types.string()),
-  face1Image: types.string(),
-  face2Image: types.string(),
+  selfieImage: types.string(),
+  anchorImage: types.string(),
 });
 
 export function getJourneyStateBiometric2FromJSON(
@@ -2815,7 +2858,8 @@ export const GetJourneyStateBiometric1$inboundSchema: z.ZodMiniType<
 > = z.object({
   id: types.optional(types.string()),
   type: types.optional(types.string()),
-  faceImage: types.string(),
+  face1Image: types.string(),
+  face2Image: types.string(),
 });
 
 export function getJourneyStateBiometric1FromJSON(
@@ -2833,10 +2877,10 @@ export const GetJourneyStateBiometricUnion$inboundSchema: z.ZodMiniType<
   GetJourneyStateBiometricUnion,
   unknown
 > = smartUnion([
-  z.lazy(() => GetJourneyStateBiometric2$inboundSchema),
-  z.lazy(() => GetJourneyStateBiometric4$inboundSchema),
   z.lazy(() => GetJourneyStateBiometric1$inboundSchema),
+  z.lazy(() => GetJourneyStateBiometric2$inboundSchema),
   z.lazy(() => GetJourneyStateBiometric3$inboundSchema),
+  z.lazy(() => GetJourneyStateBiometric4$inboundSchema),
 ]);
 
 export function getJourneyStateBiometricUnionFromJSON(
@@ -3073,6 +3117,33 @@ export function getJourneyStateConsentFromJSON(
   );
 }
 
+/** @internal */
+export const GetJourneyStateAccount$inboundSchema: z.ZodMiniType<
+  GetJourneyStateAccount,
+  unknown
+> = z.object({
+  type: types.string(),
+  accountNumber: types.string(),
+  sortCode: types.optional(types.string()),
+  routingNumber: types.optional(types.string()),
+  iban: types.optional(types.string()),
+  bic: types.optional(types.string()),
+  accountHolderName: types.optional(types.string()),
+  bankName: types.optional(types.string()),
+  country: types.optional(types.string()),
+  accountType: types.optional(types.string()),
+});
+
+export function getJourneyStateAccountFromJSON(
+  jsonString: string,
+): SafeParseResult<GetJourneyStateAccount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetJourneyStateAccount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetJourneyStateAccount' from JSON`,
+  );
+}
+
 /** @internal */
 export const GetJourneyStateSubject$inboundSchema: z.ZodMiniType<
   GetJourneyStateSubject,
@@ -3084,12 +3155,12 @@ export const GetJourneyStateSubject$inboundSchema: z.ZodMiniType<
   ),
   biometrics: types.optional(
     z.array(smartUnion([
-      z.lazy(() => GetJourneyStateBiometric2$inboundSchema),
+      z.lazy(() => GetJourneyStateBiometric1$inboundSchema),
       z.lazy(() =>
-        GetJourneyStateBiometric4$inboundSchema
+        GetJourneyStateBiometric2$inboundSchema
       ),
-      z.lazy(() => GetJourneyStateBiometric1$inboundSchema),
       z.lazy(() => GetJourneyStateBiometric3$inboundSchema),
+      z.lazy(() => GetJourneyStateBiometric4$inboundSchema),
     ])),
   ),
   sessions: types.optional(
@@ -3098,6 +3169,9 @@ export const GetJourneyStateSubject$inboundSchema: z.ZodMiniType<
   consent: types.optional(
     z.array(z.lazy(() => GetJourneyStateConsent$inboundSchema)),
   ),
+  accounts: types.optional(
+    z.array(z.lazy(() => GetJourneyStateAccount$inboundSchema)),
+  ),
   uid: types.optional(types.string()),
 });
 
@@ -3136,7 +3210,7 @@ export const GetJourneyStateResponse$inboundSchema: z.ZodMiniType<
 > = z.object({
   instanceId: types.string(),
   status: GetJourneyStateStatus$inboundSchema,
-  metaData: types.optional(z.lazy(() => MetaData$inboundSchema)),
+  metaData: z.lazy(() => MetaData$inboundSchema),
   context: types.optional(z.lazy(() => GetJourneyStateContext$inboundSchema)),
   data: types.optional(z.record(z.string(), z.any())),
 });

package/src/models/operations/start-journey.ts

@@ -10,6 +10,25 @@ import * as types from "../../types/primitives.js";
 import { smartUnion } from "../../types/smart-union.js";
 import { SDKValidationError } from "../errors/sdk-validation-error.js";
 
+/**
+ * The method by which the End User will consume the journey.
+ */
+export const Delivery = {
+  Page: "page",
+  Api: "api",
+} as const;
+/**
+ * The method by which the End User will consume the journey.
+ */
+export type Delivery = ClosedEnum<typeof Delivery>;
+
+export type Config = {
+  /**
+   * The method by which the End User will consume the journey.
+   */
+  delivery: Delivery;
+};
+
 export type StartJourneyIdentityAlias = {
   /**
    * Title of an individual such as Mr, Mrs, Dr, Sir
@@ -1071,34 +1090,34 @@ export type StartJourneyBiometric4 = {
   id?: string | undefined;
   type?: string | undefined;
   selfieImage: string;
-  anchorImage: string;
+  selfieImageEncryption?: boolean | undefined;
 };
 
 export type StartJourneyBiometric3 = {
   id?: string | undefined;
   type?: string | undefined;
-  selfieImage: string;
-  selfieImageEncryption?: boolean | undefined;
+  faceImage: string;
 };
 
 export type StartJourneyBiometric2 = {
   id?: string | undefined;
   type?: string | undefined;
-  face1Image: string;
-  face2Image: string;
+  selfieImage: string;
+  anchorImage: string;
 };
 
 export type StartJourneyBiometric1 = {
   id?: string | undefined;
   type?: string | undefined;
-  faceImage: string;
+  face1Image: string;
+  face2Image: string;
 };
 
 export type StartJourneyBiometricUnion =
-  | StartJourneyBiometric2
-  | StartJourneyBiometric4
   | StartJourneyBiometric1
-  | StartJourneyBiometric3;
+  | StartJourneyBiometric2
+  | StartJourneyBiometric3
+  | StartJourneyBiometric4;
 
 export type StartJourneyUser = {
   id: string;
@@ -1181,23 +1200,68 @@ export type StartJourneyConsent = {
   signatory?: string | undefined;
 };
 
+export type StartJourneyAccount = {
+  /**
+   * The type of account, e.g. Bank Account, Building Society
+   */
+  type: string;
+  /**
+   * Account number
+   */
+  accountNumber: string;
+  /**
+   * UK sort code
+   */
+  sortCode?: string | undefined;
+  /**
+   * US ABA routing number
+   */
+  routingNumber?: string | undefined;
+  /**
+   * International Bank Account Number
+   */
+  iban?: string | undefined;
+  /**
+   * BIC/SWIFT code
+   */
+  bic?: string | undefined;
+  /**
+   * Name on the account
+   */
+  accountHolderName?: string | undefined;
+  /**
+   * Name of the financial institution
+   */
+  bankName?: string | undefined;
+  /**
+   * Country the address is in. It must be a valid ISO2 or ISO3 country code
+   */
+  country?: string | undefined;
+  /**
+   * Account classification, e.g. current, savings
+   */
+  accountType?: string | undefined;
+};
+
 export type StartJourneySubject = {
   identity?: StartJourneyIdentity | undefined;
   documents?: Array<StartJourneyDocument> | undefined;
   biometrics?:
     | Array<
-      | StartJourneyBiometric2
-      | StartJourneyBiometric4
       | StartJourneyBiometric1
+      | StartJourneyBiometric2
       | StartJourneyBiometric3
+      | StartJourneyBiometric4
     >
     | undefined;
   sessions?: Array<StartJourneySession> | undefined;
   consent?: Array<StartJourneyConsent> | undefined;
+  accounts?: Array<StartJourneyAccount> | undefined;
   uid?: string | undefined;
 };
 
 export type StartJourneyContext = {
+  config: Config;
   subject: StartJourneySubject;
 };
 
@@ -1229,10 +1293,6 @@ export type StartJourneyResponseBody1 = {
    * Journey Instance Id, a unique identifier for a started journey instance.
    */
   instanceId: string;
-  /**
-   * URL to access the journey UI for no code journey implementations.
-   */
-  instanceUrl?: string | undefined;
   [additionalProperties: string]: unknown;
 };
 
@@ -1240,6 +1300,26 @@ export type StartJourneyResponse =
   | StartJourneyResponseBody1
   | StartJourneyResponseBody2;
 
+/** @internal */
+export const Delivery$outboundSchema: z.ZodMiniEnum<typeof Delivery> = z.enum(
+  Delivery,
+);
+
+/** @internal */
+export type Config$Outbound = {
+  delivery: string;
+};
+
+/** @internal */
+export const Config$outboundSchema: z.ZodMiniType<Config$Outbound, Config> = z
+  .object({
+    delivery: Delivery$outboundSchema,
+  });
+
+export function configToJSON(config: Config): string {
+  return JSON.stringify(Config$outboundSchema.parse(config));
+}
+
 /** @internal */
 export type StartJourneyIdentityAlias$Outbound = {
   title?: string | undefined;
@@ -3215,7 +3295,7 @@ export type StartJourneyBiometric4$Outbound = {
   id?: string | undefined;
   type?: string | undefined;
   selfieImage: string;
-  anchorImage: string;
+  selfieImageEncryption?: boolean | undefined;
 };
 
 /** @internal */
@@ -3226,7 +3306,7 @@ export const StartJourneyBiometric4$outboundSchema: z.ZodMiniType<
   id: z.optional(z.string()),
   type: z.optional(z.string()),
   selfieImage: z.string(),
-  anchorImage: z.string(),
+  selfieImageEncryption: z.optional(z.boolean()),
 });
 
 export function startJourneyBiometric4ToJSON(
@@ -3241,8 +3321,7 @@ export function startJourneyBiometric4ToJSON(
 export type StartJourneyBiometric3$Outbound = {
   id?: string | undefined;
   type?: string | undefined;
-  selfieImage: string;
-  selfieImageEncryption?: boolean | undefined;
+  faceImage: string;
 };
 
 /** @internal */
@@ -3252,8 +3331,7 @@ export const StartJourneyBiometric3$outboundSchema: z.ZodMiniType<
 > = z.object({
   id: z.optional(z.string()),
   type: z.optional(z.string()),
-  selfieImage: z.string(),
-  selfieImageEncryption: z.optional(z.boolean()),
+  faceImage: z.string(),
 });
 
 export function startJourneyBiometric3ToJSON(
@@ -3268,8 +3346,8 @@ export function startJourneyBiometric3ToJSON(
 export type StartJourneyBiometric2$Outbound = {
   id?: string | undefined;
   type?: string | undefined;
-  face1Image: string;
-  face2Image: string;
+  selfieImage: string;
+  anchorImage: string;
 };
 
 /** @internal */
@@ -3279,8 +3357,8 @@ export const StartJourneyBiometric2$outboundSchema: z.ZodMiniType<
 > = z.object({
   id: z.optional(z.string()),
   type: z.optional(z.string()),
-  face1Image: z.string(),
-  face2Image: z.string(),
+  selfieImage: z.string(),
+  anchorImage: z.string(),
 });
 
 export function startJourneyBiometric2ToJSON(
@@ -3295,7 +3373,8 @@ export function startJourneyBiometric2ToJSON(
 export type StartJourneyBiometric1$Outbound = {
   id?: string | undefined;
   type?: string | undefined;
-  faceImage: string;
+  face1Image: string;
+  face2Image: string;
 };
 
 /** @internal */
@@ -3305,7 +3384,8 @@ export const StartJourneyBiometric1$outboundSchema: z.ZodMiniType<
 > = z.object({
   id: z.optional(z.string()),
   type: z.optional(z.string()),
-  faceImage: z.string(),
+  face1Image: z.string(),
+  face2Image: z.string(),
 });
 
 export function startJourneyBiometric1ToJSON(
@@ -3318,20 +3398,20 @@ export function startJourneyBiometric1ToJSON(
 
 /** @internal */
 export type StartJourneyBiometricUnion$Outbound =
-  | StartJourneyBiometric2$Outbound
-  | StartJourneyBiometric4$Outbound
   | StartJourneyBiometric1$Outbound
-  | StartJourneyBiometric3$Outbound;
+  | StartJourneyBiometric2$Outbound
+  | StartJourneyBiometric3$Outbound
+  | StartJourneyBiometric4$Outbound;
 
 /** @internal */
 export const StartJourneyBiometricUnion$outboundSchema: z.ZodMiniType<
   StartJourneyBiometricUnion$Outbound,
   StartJourneyBiometricUnion
 > = smartUnion([
-  z.lazy(() => StartJourneyBiometric2$outboundSchema),
-  z.lazy(() => StartJourneyBiometric4$outboundSchema),
   z.lazy(() => StartJourneyBiometric1$outboundSchema),
+  z.lazy(() => StartJourneyBiometric2$outboundSchema),
   z.lazy(() => StartJourneyBiometric3$outboundSchema),
+  z.lazy(() => StartJourneyBiometric4$outboundSchema),
 ]);
 
 export function startJourneyBiometricUnionToJSON(
@@ -3623,20 +3703,60 @@ export function startJourneyConsentToJSON(
   );
 }
 
+/** @internal */
+export type StartJourneyAccount$Outbound = {
+  type: string;
+  accountNumber: string;
+  sortCode?: string | undefined;
+  routingNumber?: string | undefined;
+  iban?: string | undefined;
+  bic?: string | undefined;
+  accountHolderName?: string | undefined;
+  bankName?: string | undefined;
+  country?: string | undefined;
+  accountType?: string | undefined;
+};
+
+/** @internal */
+export const StartJourneyAccount$outboundSchema: z.ZodMiniType<
+  StartJourneyAccount$Outbound,
+  StartJourneyAccount
+> = z.object({
+  type: z.string(),
+  accountNumber: z.string(),
+  sortCode: z.optional(z.string()),
+  routingNumber: z.optional(z.string()),
+  iban: z.optional(z.string()),
+  bic: z.optional(z.string()),
+  accountHolderName: z.optional(z.string()),
+  bankName: z.optional(z.string()),
+  country: z.optional(z.string()),
+  accountType: z.optional(z.string()),
+});
+
+export function startJourneyAccountToJSON(
+  startJourneyAccount: StartJourneyAccount,
+): string {
+  return JSON.stringify(
+    StartJourneyAccount$outboundSchema.parse(startJourneyAccount),
+  );
+}
+
 /** @internal */
 export type StartJourneySubject$Outbound = {
   identity?: StartJourneyIdentity$Outbound | undefined;
   documents?: Array<StartJourneyDocument$Outbound> | undefined;
   biometrics?:
     | Array<
-      | StartJourneyBiometric2$Outbound
-      | StartJourneyBiometric4$Outbound
       | StartJourneyBiometric1$Outbound
+      | StartJourneyBiometric2$Outbound
       | StartJourneyBiometric3$Outbound
+      | StartJourneyBiometric4$Outbound
     >
     | undefined;
   sessions?: Array<StartJourneySession$Outbound> | undefined;
   consent?: Array<StartJourneyConsent$Outbound> | undefined;
+  accounts?: Array<StartJourneyAccount$Outbound> | undefined;
   uid?: string | undefined;
 };
 
@@ -3651,12 +3771,12 @@ export const StartJourneySubject$outboundSchema: z.ZodMiniType<
   ),
   biometrics: z.optional(
     z.array(smartUnion([
-      z.lazy(() => StartJourneyBiometric2$outboundSchema),
+      z.lazy(() => StartJourneyBiometric1$outboundSchema),
       z.lazy(() =>
-        StartJourneyBiometric4$outboundSchema
+        StartJourneyBiometric2$outboundSchema
       ),
-      z.lazy(() => StartJourneyBiometric1$outboundSchema),
       z.lazy(() => StartJourneyBiometric3$outboundSchema),
+      z.lazy(() => StartJourneyBiometric4$outboundSchema),
     ])),
   ),
   sessions: z.optional(
@@ -3665,6 +3785,9 @@ export const StartJourneySubject$outboundSchema: z.ZodMiniType<
   consent: z.optional(
     z.array(z.lazy(() => StartJourneyConsent$outboundSchema)),
   ),
+  accounts: z.optional(
+    z.array(z.lazy(() => StartJourneyAccount$outboundSchema)),
+  ),
   uid: z.optional(z.string()),
 });
 
@@ -3678,6 +3801,7 @@ export function startJourneySubjectToJSON(
 
 /** @internal */
 export type StartJourneyContext$Outbound = {
+  config: Config$Outbound;
   subject: StartJourneySubject$Outbound;
 };
 
@@ -3686,6 +3810,7 @@ export const StartJourneyContext$outboundSchema: z.ZodMiniType<
   StartJourneyContext$Outbound,
   StartJourneyContext
 > = z.object({
+  config: z.lazy(() => Config$outboundSchema),
   subject: z.lazy(() => StartJourneySubject$outboundSchema),
 });
 
@@ -3750,7 +3875,6 @@ export const StartJourneyResponseBody1$inboundSchema: z.ZodMiniType<
 > = z.catchall(
   z.object({
     instanceId: types.string(),
-    instanceUrl: types.optional(types.string()),
   }),
   z.any(),
 );