@gbg/go-core 0.0.1-alpha.17 → 0.0.1-alpha.19

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(),
 );

package/src/models/operations/submit-interaction.ts

@@ -1098,34 +1098,34 @@ export type SubmitInteractionBiometric4 = {
   id?: string | undefined;
   type?: string | undefined;
   selfieImage: string;
-  anchorImage: string;
+  selfieImageEncryption?: boolean | undefined;
 };
 
 export type SubmitInteractionBiometric3 = {
   id?: string | undefined;
   type?: string | undefined;
-  selfieImage: string;
-  selfieImageEncryption?: boolean | undefined;
+  faceImage: string;
 };
 
 export type SubmitInteractionBiometric2 = {
   id?: string | undefined;
   type?: string | undefined;
-  face1Image: string;
-  face2Image: string;
+  selfieImage: string;
+  anchorImage: string;
 };
 
 export type SubmitInteractionBiometric1 = {
   id?: string | undefined;
   type?: string | undefined;
-  faceImage: string;
+  face1Image: string;
+  face2Image: string;
 };
 
 export type SubmitInteractionBiometricUnion =
-  | SubmitInteractionBiometric2
-  | SubmitInteractionBiometric4
   | SubmitInteractionBiometric1
-  | SubmitInteractionBiometric3;
+  | SubmitInteractionBiometric2
+  | SubmitInteractionBiometric3
+  | SubmitInteractionBiometric4;
 
 export type SubmitInteractionUser = {
   id: string;
@@ -1208,19 +1208,63 @@ export type SubmitInteractionConsent = {
   signatory?: string | undefined;
 };
 
+export type SubmitInteractionAccount = {
+  /**
+   * 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 SubmitInteractionSubject = {
   identity?: SubmitInteractionIdentity | undefined;
   documents?: Array<SubmitInteractionDocument> | undefined;
   biometrics?:
     | Array<
-      | SubmitInteractionBiometric2
-      | SubmitInteractionBiometric4
       | SubmitInteractionBiometric1
+      | SubmitInteractionBiometric2
       | SubmitInteractionBiometric3
+      | SubmitInteractionBiometric4
     >
     | undefined;
   sessions?: Array<SubmitInteractionSession> | undefined;
   consent?: Array<SubmitInteractionConsent> | undefined;
+  accounts?: Array<SubmitInteractionAccount> | undefined;
   uid?: string | undefined;
 };
 
@@ -3393,7 +3437,7 @@ export type SubmitInteractionBiometric4$Outbound = {
   id?: string | undefined;
   type?: string | undefined;
   selfieImage: string;
-  anchorImage: string;
+  selfieImageEncryption?: boolean | undefined;
 };
 
 /** @internal */
@@ -3404,7 +3448,7 @@ export const SubmitInteractionBiometric4$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 submitInteractionBiometric4ToJSON(
@@ -3421,8 +3465,7 @@ export function submitInteractionBiometric4ToJSON(
 export type SubmitInteractionBiometric3$Outbound = {
   id?: string | undefined;
   type?: string | undefined;
-  selfieImage: string;
-  selfieImageEncryption?: boolean | undefined;
+  faceImage: string;
 };
 
 /** @internal */
@@ -3432,8 +3475,7 @@ export const SubmitInteractionBiometric3$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 submitInteractionBiometric3ToJSON(
@@ -3450,8 +3492,8 @@ export function submitInteractionBiometric3ToJSON(
 export type SubmitInteractionBiometric2$Outbound = {
   id?: string | undefined;
   type?: string | undefined;
-  face1Image: string;
-  face2Image: string;
+  selfieImage: string;
+  anchorImage: string;
 };
 
 /** @internal */
@@ -3461,8 +3503,8 @@ export const SubmitInteractionBiometric2$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 submitInteractionBiometric2ToJSON(
@@ -3479,7 +3521,8 @@ export function submitInteractionBiometric2ToJSON(
 export type SubmitInteractionBiometric1$Outbound = {
   id?: string | undefined;
   type?: string | undefined;
-  faceImage: string;
+  face1Image: string;
+  face2Image: string;
 };
 
 /** @internal */
@@ -3489,7 +3532,8 @@ export const SubmitInteractionBiometric1$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 submitInteractionBiometric1ToJSON(
@@ -3504,20 +3548,20 @@ export function submitInteractionBiometric1ToJSON(
 
 /** @internal */
 export type SubmitInteractionBiometricUnion$Outbound =
-  | SubmitInteractionBiometric2$Outbound
-  | SubmitInteractionBiometric4$Outbound
   | SubmitInteractionBiometric1$Outbound
-  | SubmitInteractionBiometric3$Outbound;
+  | SubmitInteractionBiometric2$Outbound
+  | SubmitInteractionBiometric3$Outbound
+  | SubmitInteractionBiometric4$Outbound;
 
 /** @internal */
 export const SubmitInteractionBiometricUnion$outboundSchema: z.ZodMiniType<
   SubmitInteractionBiometricUnion$Outbound,
   SubmitInteractionBiometricUnion
 > = smartUnion([
-  z.lazy(() => SubmitInteractionBiometric2$outboundSchema),
-  z.lazy(() => SubmitInteractionBiometric4$outboundSchema),
   z.lazy(() => SubmitInteractionBiometric1$outboundSchema),
+  z.lazy(() => SubmitInteractionBiometric2$outboundSchema),
   z.lazy(() => SubmitInteractionBiometric3$outboundSchema),
+  z.lazy(() => SubmitInteractionBiometric4$outboundSchema),
 ]);
 
 export function submitInteractionBiometricUnionToJSON(
@@ -3821,20 +3865,60 @@ export function submitInteractionConsentToJSON(
   );
 }
 
+/** @internal */
+export type SubmitInteractionAccount$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 SubmitInteractionAccount$outboundSchema: z.ZodMiniType<
+  SubmitInteractionAccount$Outbound,
+  SubmitInteractionAccount
+> = 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 submitInteractionAccountToJSON(
+  submitInteractionAccount: SubmitInteractionAccount,
+): string {
+  return JSON.stringify(
+    SubmitInteractionAccount$outboundSchema.parse(submitInteractionAccount),
+  );
+}
+
 /** @internal */
 export type SubmitInteractionSubject$Outbound = {
   identity?: SubmitInteractionIdentity$Outbound | undefined;
   documents?: Array<SubmitInteractionDocument$Outbound> | undefined;
   biometrics?:
     | Array<
-      | SubmitInteractionBiometric2$Outbound
-      | SubmitInteractionBiometric4$Outbound
       | SubmitInteractionBiometric1$Outbound
+      | SubmitInteractionBiometric2$Outbound
       | SubmitInteractionBiometric3$Outbound
+      | SubmitInteractionBiometric4$Outbound
     >
     | undefined;
   sessions?: Array<SubmitInteractionSession$Outbound> | undefined;
   consent?: Array<SubmitInteractionConsent$Outbound> | undefined;
+  accounts?: Array<SubmitInteractionAccount$Outbound> | undefined;
   uid?: string | undefined;
 };
 
@@ -3849,12 +3933,12 @@ export const SubmitInteractionSubject$outboundSchema: z.ZodMiniType<
   ),
   biometrics: z.optional(
     z.array(smartUnion([
-      z.lazy(() => SubmitInteractionBiometric2$outboundSchema),
+      z.lazy(() => SubmitInteractionBiometric1$outboundSchema),
       z.lazy(() =>
-        SubmitInteractionBiometric4$outboundSchema
+        SubmitInteractionBiometric2$outboundSchema
       ),
-      z.lazy(() => SubmitInteractionBiometric1$outboundSchema),
       z.lazy(() => SubmitInteractionBiometric3$outboundSchema),
+      z.lazy(() => SubmitInteractionBiometric4$outboundSchema),
     ])),
   ),
   sessions: z.optional(
@@ -3863,6 +3947,9 @@ export const SubmitInteractionSubject$outboundSchema: z.ZodMiniType<
   consent: z.optional(
     z.array(z.lazy(() => SubmitInteractionConsent$outboundSchema)),
   ),
+  accounts: z.optional(
+    z.array(z.lazy(() => SubmitInteractionAccount$outboundSchema)),
+  ),
   uid: z.optional(z.string()),
 });