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

package/dist/commonjs/models/operations/submit-interaction.d.ts

@@ -306,7 +306,7 @@ export type SubmitInteractionIdentityPhone = {
 };
 export type SubmitInteractionIdentityEmail = {
     /**
-     * Email type discriminator. Canonical values: 'personal', 'work', 'home', 'other'. Three map to a domain element by exact match: 'personal' -> PersonalEmail, 'work' -> WorkEmail, 'other' -> OtherEmails (the domainElementId used to collect them). 'home' is the only canonical value with no domain element: a 'home' email is accepted and stored but cannot be retrieved through any v2 read (it matches no getter); use 'personal', 'work' or 'other' to have the email surfaced. Legacy inputs normalize at the API boundary (e.g. 'email' -> 'personal').
+     * Email type discriminator. Canonical values: 'personal', 'work', 'home', 'other', 'unknown'. Four map to a domain element by exact match: 'personal' -> PersonalEmail, 'work' -> WorkEmail, 'other' -> OtherEmails, 'unknown' -> UnknownEmail (the domainElementId used to collect them). 'home' is the only canonical value with no domain element: a 'home' email is accepted and stored but cannot be retrieved through any v2 read (it matches no getter); use 'personal', 'work', 'other' or 'unknown' to have the email surfaced. Legacy inputs normalize at the API boundary (e.g. 'email' -> 'personal').
      */
     type: string;
     /**
@@ -1304,7 +1304,7 @@ export type SubmitInteractionDocumentPhone = {
 };
 export type SubmitInteractionDocumentEmail = {
     /**
-     * Email type discriminator. Canonical values: 'personal', 'work', 'home', 'other'. Three map to a domain element by exact match: 'personal' -> PersonalEmail, 'work' -> WorkEmail, 'other' -> OtherEmails (the domainElementId used to collect them). 'home' is the only canonical value with no domain element: a 'home' email is accepted and stored but cannot be retrieved through any v2 read (it matches no getter); use 'personal', 'work' or 'other' to have the email surfaced. Legacy inputs normalize at the API boundary (e.g. 'email' -> 'personal').
+     * Email type discriminator. Canonical values: 'personal', 'work', 'home', 'other', 'unknown'. Four map to a domain element by exact match: 'personal' -> PersonalEmail, 'work' -> WorkEmail, 'other' -> OtherEmails, 'unknown' -> UnknownEmail (the domainElementId used to collect them). 'home' is the only canonical value with no domain element: a 'home' email is accepted and stored but cannot be retrieved through any v2 read (it matches no getter); use 'personal', 'work', 'other' or 'unknown' to have the email surfaced. Legacy inputs normalize at the API boundary (e.g. 'email' -> 'personal').
      */
     type: string;
     /**
@@ -1495,6 +1495,10 @@ export type SubmitInteractionDocument = {
      * Specified in year, month and day separated by -.  For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
      */
     dateOfEvent?: string | undefined;
+    /**
+     * Specified in year, month and day separated by -.  For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
+     */
+    acquisitionDate?: string | undefined;
     previousFirstName?: string | undefined;
     previousMiddleName?: string | undefined;
     previousSurname?: string | undefined;
@@ -1504,14 +1508,25 @@ export type SubmitInteractionDocument = {
     nameLine3?: string | undefined;
     nameLine4?: string | undefined;
 };
-export declare const SubmitInteractionBiometricType: {
+export declare const SubmitInteractionTypeOrphanedStoredFace: {
+    readonly OrphanedStoredFace: "orphanedStoredFace";
+};
+export type SubmitInteractionTypeOrphanedStoredFace = ClosedEnum<typeof SubmitInteractionTypeOrphanedStoredFace>;
+export type SubmitInteractionBiometricOrphanedStoredFace = {
+    id?: string | undefined;
+    type: SubmitInteractionTypeOrphanedStoredFace;
+    templateReference: string;
+    collectionReference?: string | undefined;
+};
+export declare const SubmitInteractionTypeStoredFace: {
     readonly StoredFace: "storedFace";
 };
-export type SubmitInteractionBiometricType = ClosedEnum<typeof SubmitInteractionBiometricType>;
+export type SubmitInteractionTypeStoredFace = ClosedEnum<typeof SubmitInteractionTypeStoredFace>;
 export type SubmitInteractionBiometricStoredFace = {
     id?: string | undefined;
-    type: SubmitInteractionBiometricType;
+    type: SubmitInteractionTypeStoredFace;
     templateReference: string;
+    collectionReference?: string | undefined;
 };
 export type SubmitInteractionBiometric5 = {
     id?: string | undefined;
@@ -1541,7 +1556,7 @@ export type SubmitInteractionBiometric1 = {
     face1Image: string;
     face2Image: string;
 };
-export type SubmitInteractionBiometricUnion = SubmitInteractionBiometric1 | SubmitInteractionBiometric2 | SubmitInteractionBiometricStoredFace | SubmitInteractionBiometric3 | SubmitInteractionBiometric4 | SubmitInteractionBiometric5;
+export type SubmitInteractionBiometricUnion = SubmitInteractionBiometric1 | SubmitInteractionBiometric2 | SubmitInteractionBiometricStoredFace | SubmitInteractionBiometricOrphanedStoredFace | SubmitInteractionBiometric3 | SubmitInteractionBiometric4 | SubmitInteractionBiometric5;
 export type SubmitInteractionUser = {
     id: string;
     email?: string | undefined;
@@ -1619,9 +1634,9 @@ export type SubmitInteractionAccount = {
      */
     type: string;
     /**
-     * Account number
+     * Account number in its domestic form. Optional on its own: an account must carry at least one account identifier — `accountNumber` or `iban` — and either alone is enough. Independent of `iban`; when both are supplied they are not cross-checked.
      */
-    accountNumber: string;
+    accountNumber?: string | undefined;
     /**
      * UK sort code
      */
@@ -1631,7 +1646,7 @@ export type SubmitInteractionAccount = {
      */
     routingNumber?: string | undefined;
     /**
-     * International Bank Account Number
+     * International Bank Account Number, stored exactly as supplied — not format-checked (no ISO 13616 mod-97) at this boundary. Optional on its own: an account must carry at least one account identifier — `accountNumber` or `iban` — and either alone is enough.
      */
     iban?: string | undefined;
     /**
@@ -1673,15 +1688,58 @@ export type SubmitInteractionKba = {
     questions: Array<SubmitInteractionQuestion>;
     answers: Array<SubmitInteractionAnswer>;
 };
+export declare const SubmitInteractionOffered: {
+    readonly AustraliaPassport: "australiaPassport";
+    readonly AustraliaDrivingLicense: "australiaDrivingLicense";
+    readonly AustraliaBirthCertificate: "australiaBirthCertificate";
+    readonly AustraliaCentrelink: "australiaCentrelink";
+    readonly AustraliaCitizenshipCertificate: "australiaCitizenshipCertificate";
+    readonly AustraliaVisa: "australiaVisa";
+    readonly AustraliaMedicare: "australiaMedicare";
+    readonly AustraliaImmicard: "australiaImmicard";
+    readonly AustraliaMarriageCertificate: "australiaMarriageCertificate";
+    readonly AustraliaChangeOfNameCertificate: "australiaChangeOfNameCertificate";
+    readonly AustraliaElectoralRoll: "australiaElectoralRoll";
+    readonly NewZealandPassport: "newZealandPassport";
+    readonly NewZealandDrivingLicense: "newZealandDrivingLicense";
+    readonly NewZealandBirthCertificate: "newZealandBirthCertificate";
+    readonly NewZealandCitizenshipCertificate: "newZealandCitizenshipCertificate";
+    readonly NoneOfThese: "noneOfThese";
+};
+export type SubmitInteractionOffered = ClosedEnum<typeof SubmitInteractionOffered>;
+export declare const SubmitInteractionSelected: {
+    readonly AustraliaPassport: "australiaPassport";
+    readonly AustraliaDrivingLicense: "australiaDrivingLicense";
+    readonly AustraliaBirthCertificate: "australiaBirthCertificate";
+    readonly AustraliaCentrelink: "australiaCentrelink";
+    readonly AustraliaCitizenshipCertificate: "australiaCitizenshipCertificate";
+    readonly AustraliaVisa: "australiaVisa";
+    readonly AustraliaMedicare: "australiaMedicare";
+    readonly AustraliaImmicard: "australiaImmicard";
+    readonly AustraliaMarriageCertificate: "australiaMarriageCertificate";
+    readonly AustraliaChangeOfNameCertificate: "australiaChangeOfNameCertificate";
+    readonly AustraliaElectoralRoll: "australiaElectoralRoll";
+    readonly NewZealandPassport: "newZealandPassport";
+    readonly NewZealandDrivingLicense: "newZealandDrivingLicense";
+    readonly NewZealandBirthCertificate: "newZealandBirthCertificate";
+    readonly NewZealandCitizenshipCertificate: "newZealandCitizenshipCertificate";
+    readonly NoneOfThese: "noneOfThese";
+};
+export type SubmitInteractionSelected = ClosedEnum<typeof SubmitInteractionSelected>;
+export type SubmitInteractionDocumentTypeSelection = {
+    offered?: Array<SubmitInteractionOffered> | undefined;
+    selected?: SubmitInteractionSelected | undefined;
+};
 export type SubmitInteractionSubject = {
     identity?: SubmitInteractionIdentity | undefined;
     entities?: Array<SubmitInteractionEntity> | undefined;
     documents?: Array<SubmitInteractionDocument> | undefined;
-    biometrics?: Array<SubmitInteractionBiometric1 | SubmitInteractionBiometric2 | SubmitInteractionBiometricStoredFace | SubmitInteractionBiometric3 | SubmitInteractionBiometric4 | SubmitInteractionBiometric5> | undefined;
+    biometrics?: Array<SubmitInteractionBiometric1 | SubmitInteractionBiometric2 | SubmitInteractionBiometricStoredFace | SubmitInteractionBiometricOrphanedStoredFace | SubmitInteractionBiometric3 | SubmitInteractionBiometric4 | SubmitInteractionBiometric5> | undefined;
     sessions?: Array<SubmitInteractionSession> | undefined;
     consent?: Array<SubmitInteractionConsent> | undefined;
     accounts?: Array<SubmitInteractionAccount> | undefined;
     kba?: SubmitInteractionKba | undefined;
+    documentTypeSelection?: SubmitInteractionDocumentTypeSelection | undefined;
     uid?: string | undefined;
 };
 /**
@@ -2733,6 +2791,7 @@ export type SubmitInteractionDocument$Outbound = {
     registrationYear?: string | undefined;
     partyRole?: string | undefined;
     dateOfEvent?: string | undefined;
+    acquisitionDate?: string | undefined;
     previousFirstName?: string | undefined;
     previousMiddleName?: string | undefined;
     previousSurname?: string | undefined;
@@ -2746,12 +2805,25 @@ export type SubmitInteractionDocument$Outbound = {
 export declare const SubmitInteractionDocument$outboundSchema: z.ZodMiniType<SubmitInteractionDocument$Outbound, SubmitInteractionDocument>;
 export declare function submitInteractionDocumentToJSON(submitInteractionDocument: SubmitInteractionDocument): string;
 /** @internal */
-export declare const SubmitInteractionBiometricType$outboundSchema: z.ZodMiniEnum<typeof SubmitInteractionBiometricType>;
+export declare const SubmitInteractionTypeOrphanedStoredFace$outboundSchema: z.ZodMiniEnum<typeof SubmitInteractionTypeOrphanedStoredFace>;
+/** @internal */
+export type SubmitInteractionBiometricOrphanedStoredFace$Outbound = {
+    id?: string | undefined;
+    type: string;
+    templateReference: string;
+    collectionReference?: string | undefined;
+};
+/** @internal */
+export declare const SubmitInteractionBiometricOrphanedStoredFace$outboundSchema: z.ZodMiniType<SubmitInteractionBiometricOrphanedStoredFace$Outbound, SubmitInteractionBiometricOrphanedStoredFace>;
+export declare function submitInteractionBiometricOrphanedStoredFaceToJSON(submitInteractionBiometricOrphanedStoredFace: SubmitInteractionBiometricOrphanedStoredFace): string;
+/** @internal */
+export declare const SubmitInteractionTypeStoredFace$outboundSchema: z.ZodMiniEnum<typeof SubmitInteractionTypeStoredFace>;
 /** @internal */
 export type SubmitInteractionBiometricStoredFace$Outbound = {
     id?: string | undefined;
     type: string;
     templateReference: string;
+    collectionReference?: string | undefined;
 };
 /** @internal */
 export declare const SubmitInteractionBiometricStoredFace$outboundSchema: z.ZodMiniType<SubmitInteractionBiometricStoredFace$Outbound, SubmitInteractionBiometricStoredFace>;
@@ -2805,7 +2877,7 @@ export type SubmitInteractionBiometric1$Outbound = {
 export declare const SubmitInteractionBiometric1$outboundSchema: z.ZodMiniType<SubmitInteractionBiometric1$Outbound, SubmitInteractionBiometric1>;
 export declare function submitInteractionBiometric1ToJSON(submitInteractionBiometric1: SubmitInteractionBiometric1): string;
 /** @internal */
-export type SubmitInteractionBiometricUnion$Outbound = SubmitInteractionBiometric1$Outbound | SubmitInteractionBiometric2$Outbound | SubmitInteractionBiometricStoredFace$Outbound | SubmitInteractionBiometric3$Outbound | SubmitInteractionBiometric4$Outbound | SubmitInteractionBiometric5$Outbound;
+export type SubmitInteractionBiometricUnion$Outbound = SubmitInteractionBiometric1$Outbound | SubmitInteractionBiometric2$Outbound | SubmitInteractionBiometricStoredFace$Outbound | SubmitInteractionBiometricOrphanedStoredFace$Outbound | SubmitInteractionBiometric3$Outbound | SubmitInteractionBiometric4$Outbound | SubmitInteractionBiometric5$Outbound;
 /** @internal */
 export declare const SubmitInteractionBiometricUnion$outboundSchema: z.ZodMiniType<SubmitInteractionBiometricUnion$Outbound, SubmitInteractionBiometricUnion>;
 export declare function submitInteractionBiometricUnionToJSON(submitInteractionBiometricUnion: SubmitInteractionBiometricUnion): string;
@@ -2919,7 +2991,7 @@ export declare function submitInteractionConsentToJSON(submitInteractionConsent:
 /** @internal */
 export type SubmitInteractionAccount$Outbound = {
     type: string;
-    accountNumber: string;
+    accountNumber?: string | undefined;
     sortCode?: string | undefined;
     routingNumber?: string | undefined;
     iban?: string | undefined;
@@ -2967,15 +3039,28 @@ export type SubmitInteractionKba$Outbound = {
 export declare const SubmitInteractionKba$outboundSchema: z.ZodMiniType<SubmitInteractionKba$Outbound, SubmitInteractionKba>;
 export declare function submitInteractionKbaToJSON(submitInteractionKba: SubmitInteractionKba): string;
 /** @internal */
+export declare const SubmitInteractionOffered$outboundSchema: z.ZodMiniEnum<typeof SubmitInteractionOffered>;
+/** @internal */
+export declare const SubmitInteractionSelected$outboundSchema: z.ZodMiniEnum<typeof SubmitInteractionSelected>;
+/** @internal */
+export type SubmitInteractionDocumentTypeSelection$Outbound = {
+    offered?: Array<string> | undefined;
+    selected?: string | undefined;
+};
+/** @internal */
+export declare const SubmitInteractionDocumentTypeSelection$outboundSchema: z.ZodMiniType<SubmitInteractionDocumentTypeSelection$Outbound, SubmitInteractionDocumentTypeSelection>;
+export declare function submitInteractionDocumentTypeSelectionToJSON(submitInteractionDocumentTypeSelection: SubmitInteractionDocumentTypeSelection): string;
+/** @internal */
 export type SubmitInteractionSubject$Outbound = {
     identity?: SubmitInteractionIdentity$Outbound | undefined;
     entities?: Array<SubmitInteractionEntity$Outbound> | undefined;
     documents?: Array<SubmitInteractionDocument$Outbound> | undefined;
-    biometrics?: Array<SubmitInteractionBiometric1$Outbound | SubmitInteractionBiometric2$Outbound | SubmitInteractionBiometricStoredFace$Outbound | SubmitInteractionBiometric3$Outbound | SubmitInteractionBiometric4$Outbound | SubmitInteractionBiometric5$Outbound> | undefined;
+    biometrics?: Array<SubmitInteractionBiometric1$Outbound | SubmitInteractionBiometric2$Outbound | SubmitInteractionBiometricStoredFace$Outbound | SubmitInteractionBiometricOrphanedStoredFace$Outbound | SubmitInteractionBiometric3$Outbound | SubmitInteractionBiometric4$Outbound | SubmitInteractionBiometric5$Outbound> | undefined;
     sessions?: Array<SubmitInteractionSession$Outbound> | undefined;
     consent?: Array<SubmitInteractionConsent$Outbound> | undefined;
     accounts?: Array<SubmitInteractionAccount$Outbound> | undefined;
     kba?: SubmitInteractionKba$Outbound | undefined;
+    documentTypeSelection?: SubmitInteractionDocumentTypeSelection$Outbound | undefined;
     uid?: string | undefined;
 };
 /** @internal */