@raytio/types 7.1.0 → 7.3.0

package/dist/orgs.d.ts

@@ -0,0 +1,84 @@
+/** Types Used for Organization Related API Responses */
+/** An Organisation */
+export type Party = {
+    id: string;
+    start_date: string;
+    end_date: string;
+    active: boolean;
+    party_name: string;
+    party_description: string;
+    party_type: string;
+    metadata: PartyMetadata;
+    party_number: number;
+};
+/** An Organizations credentials */
+export type PartyMetadata = {
+    gandalf: unknown;
+    stripe: {
+        customer: unknown;
+    };
+    centrix_credentials: unknown;
+};
+/** An Organization Site */
+export type PartySite = {
+    id: string;
+    start_date: string;
+    end_date: string;
+    active: boolean;
+    party_id: string;
+    location_number: number;
+    party_site_name: string;
+    party_site_description: string | null;
+    party_site_number: string | null;
+    party_uses: string[];
+    party_use_primary: string;
+    metadata: unknown;
+};
+/** An Organization Location */
+export type Location = {
+    id: string;
+    start_date: string;
+    end_date: string;
+    active: boolean;
+    location_name: string;
+    location_description: string | null;
+    address_line_1: string | null;
+    address_line_2: string | null;
+    address_line_3: string | null;
+    address_line_4: string | null;
+    premise: string | null;
+    subpremise: string | null;
+    street_number: string | null;
+    administrative_area_level_1: string | null;
+    administrative_area_level_2: string | null;
+    administrative_area_level_3: string | null;
+    route: string | null;
+    locality: string | null;
+    postal_code: string;
+    postal_code_suffix: string | null;
+    city: string | null;
+    region: string | null;
+    country: string | null;
+    geolocation: string | null;
+    geolocation_outline: string | null;
+    metadata: unknown;
+};
+/** A Contact Point for an Organization */
+export type ContactPoint = {
+    id: string;
+    start_date: string;
+    end_date: string;
+    active: boolean;
+    to_table: string;
+    uuid: string | undefined;
+    contact_point_purpose: string;
+    contact_point_type: string;
+    e164: string | null;
+    e164_suffix: string | null;
+    e164_type: string | null;
+    url: string | null;
+    url_type: string | null;
+    email_address: string;
+    email_address_preferred_format: string;
+    metadata: unknown;
+};

package/dist/orgs.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/raytio.d.ts

@@ -1,5 +1,5 @@
-import { Encrypted } from "./crypto";
-import { Colors, CustomFonts } from "./theme";
+import type { Encrypted } from "./crypto";
+import type { Colors, CustomFonts } from "./theme";
 /** @internal see Microsoft/TypeScript#202 */
 export type StringWithIdentity<T> = string & {
     $$typeof$$: T;
@@ -12,6 +12,8 @@ export type PId = StringWithIdentity<"PId">;
 export type IId = StringWithIdentity<"IId">;
 /** An `n_id` is the ID of a {@link ProfileObject} */
 export type NId = StringWithIdentity<"NId">;
+/** ⚠️ This ID duplicates the {@link NId} and should only be used in exceptional circumstances */
+export type NId2 = StringWithIdentity<"NId2">;
 /** A `g_id` is the ID of a group */
 export type GId = StringWithIdentity<"GId">;
 /** A `u_id` is the ID of a user */
@@ -23,11 +25,35 @@ export type OId = StringWithIdentity<"OId">;
 /** A `wi_id` is the ID of a {@link Webhook} */
 export type WId = StringWithIdentity<"WId">;
 /** An `l_id` is the ID of any data stored in the KV-Store */ export type LId = StringWithIdentity<"LId">;
-export type AnyId = PId | IId | NId | GId | UId | AId | OId | WId;
+/** A `k_id` (also called a `aack_id` or a `publicKeyId`) is the ID of an AA's public key  */
+export type KId = StringWithIdentity<"KId">;
+/** A `SchemaName` is the ID of a {@link Schema} */
+export type SchemaName = StringWithIdentity<"SchemaName">;
 export type DataTypes = "string" | "number" | "boolean" | "object" | "integer" | "array" | "null";
 export type SubmissionStatus = "Submitted" | "Processing" | "Rejected" | "Expired" | "Completed" | "DataChanged" | "Received" | "Accepted";
+/**
+ * Every object in the new database has these fields. In the
+ * interest of type-safety, the `id` should be one of the
+ * well-known IDs that extend {@link StringWithIdentity} (e.g.
+ * {@link NId} or {@link AId}). If the ID is irrelevant, then
+ * use `CommonFields<never>` rather than `CommonFields<string>`.
+ * This will deliberately prevent you from utilising the `id`
+ * field until you define a special type for that ID.
+ *
+ * This is especially important with the new API where it is much
+ * easier to mix up the different types of IDs.
+ */
+export type CommonFields<IdType extends StringWithIdentity<string>, Metadata = unknown> = {
+    id: IdType;
+    /** ISO Date */
+    start_date: string;
+    /** ISO Date */
+    end_date: string;
+    active: boolean;
+    metadata: Metadata | undefined;
+};
 /** You can supply an option type argument if you know exactly what the properties will be */
-export type ProfileObject<Properties = Json> = {
+export type ProfileObject<Properties = Json> = Partial<CommonFields<NId2>> & {
     n_id: NId;
     properties: Properties;
     labels: string[];
@@ -47,22 +73,12 @@ export type ProfileObjectForUpload<Properties = Json> = {
         type?: string;
     };
     labels?: string[];
-    schema?: string;
+    schema?: SchemaName;
     n_id?: NId;
 };
-/**
- * arbitrary key-values pairs stored on a Profile Object.
- * May contain nested JSON and {@link Encrypted} properties.
- *
- * There are some limits to field names: they cannot be called
- * `__signature` nor can they include the character sequence `<=>`.
- *
- * @deprecated - use {@link Json}
- */
-export type Properties = Json;
 export type UrnNodeType = "user" | "profile_object" | "instance" | "schema" | "temp_object" | "document";
 /** e.g. "urn:user:..." */
-export type Urn = `urn:${UrnNodeType}:${AnyId}`;
+export type Urn = `urn:user:${UId}` | `urn:profile_object:${NId}` | `urn:instance:${IId}` | `urn:temp_object:${LId}` | `urn:schema:${SchemaName}` | `urn:document:${NId}`;
 export type Relationship = {
     start: Urn;
     end: Urn;
@@ -73,6 +89,9 @@ export type Relationship = {
         name?: string;
         [fieldName: string]: unknown;
     };
+    start_date?: string;
+    end_date?: string;
+    active?: boolean;
 };
 export type Lookup = {
     key: string | number;
@@ -91,8 +110,9 @@ export type AA = {
     description?: string;
     /** If a user signs up while completing this form, this message will be sent in the sign up email.  */
     aa_introduction?: string;
+    /** @deprecated see !2101 */
     picture?: Urn;
-    /** Easy to use AA logo url for pasting inot emails */
+    /** Easy to use AA logo url for pasting into emails */
     picture_url?: string;
     scopes?: string[];
     tags?: AATag[];
@@ -111,16 +131,24 @@ export type AA = {
     ruleset?: unknown;
     /** if true, only specific email addresses can submit the form */
     auth_list_enabled?: boolean;
+    /** Currently Unused Attributes */
+    start_date?: Date;
+    end_date?: Date;
+    active?: boolean;
+    key?: string;
+    logout_uri?: string[];
+    metadata?: unknown;
+    secret?: unknown;
     /** @internal */
     transitions?: unknown[];
 };
-export type Instance = {
-    /** Access application instance ID */
-    i_id: IId;
+export type InstanceWithoutData = CommonFields<IId, {
+    message?: string;
+}> & {
     /** ID of the access application this submission was made to */
-    a_id: AId;
-    /** name of the access application this submission was made to */
-    aa_name: string;
+    aa_id: AId;
+    /** ID of the public key for this AA */
+    aack_id: KId;
     /** Code that validates information has been shared */
     confirmation_code: string;
     /** reference provided by the user who shared the data */
@@ -128,33 +156,43 @@ export type Instance = {
     /** Email of user who shared the data */
     data_provider_email: string;
     thread: string;
-    /** Latest date in which the shared information was available */
-    end_date: string;
-    /** Earliest date on which the shared information was available */
-    start_date: string;
     /** The status of a submission */
     state: SubmissionStatus;
-    /** @deprecated The status of a submission */
-    _state?: SubmissionStatus;
-    /** Previous status of the shared information */
-    previous_state: SubmissionStatus;
     /** Hash of the Service Provider ID */
-    sub_service_provider_hash?: string;
+    sub_service_provider_hash: string;
     /** Service provider ID */
-    service_provider_n_id?: NId;
-    /** data associated is access application's instance */
+    service_provider_n_id: NId;
+    /** added by the client once it calculates the score */
+    score?: unknown;
+    /** Previous status of the shared information */
+    previous_state?: SubmissionStatus;
+    /** Device Id */
+    device_id?: unknown;
+    /** Source IP */
+    source_ip?: unknown;
+    /** Related Offers */
+    related_offers?: unknown;
+    /** Instance Version */
+    instance_version?: unknown;
+    /** Footer Html */
+    platform_footer_html?: unknown;
+    /** Related Service Types */
+    related_service_types?: unknown;
+};
+/**
+ * The API used to store data in this format, but it no
+ * longer does :( so `@raytio/core` reconstructs this object.
+ */
+export type Instance = InstanceWithoutData & {
     profile_objects: ProfileObject[];
     keys: {
-        [nId: NId]: {
+        [nId2: NId2]: {
             [fieldName: string]: {
                 data: string;
-                n_id: NId;
             };
         };
     };
-    relationships?: Relationship[];
-    /** added by the client once it calculates the score */
-    score?: unknown;
+    relationships: Relationship[];
 };
 /**
  * An organization.
@@ -164,15 +202,8 @@ export type Organization = {
     id: OId;
     name: string;
     email: string;
-    address: {
-        locationType: string;
-        street1: string;
-        street2: string;
-        city: string;
-        region: string;
-        country: string;
-    };
-    customer: Record<string, unknown>;
+    address: unknown;
+    customer: unknown;
 };
 /** @internal some APIs now return extra info */
 export type FullOrg = {

package/dist/schema.d.ts

@@ -1,5 +1,5 @@
-import { AA, DataTypes, Organization, Urn } from "./raytio";
-import { WizardConfig } from "./wizard";
+import type { AA, DataTypes, Organization, SchemaName, Urn } from "./raytio";
+import type { WizardConfig } from "./wizard";
 /** should be renamed since this applies to ConditionallyVerifiable */
 export type ConditionallyRequired = {
     field: string;
@@ -7,7 +7,7 @@ export type ConditionallyRequired = {
         [fieldName: string]: (string | number | boolean)[];
     };
 };
-export type SchemaFieldTag = "password" | `group:${string}` | `upload-group:${string}` | "display:stars" | "display:no_autofill" | "display:currency" | "display:cascade" | "display:survey" | "display:quoting" | "display:customModal" | `display:replace:'${string}':'${string}'` | "display:terms_conditions" | `display:main_media:${string}` | "date_component:day" | "date_component:month" | "date_component:year" | "action:client_upload" | "verify:show_if_pending" | "special:hide_select_behind_button" | "type:capture_geolocation" | "type:extract_required";
+export type SchemaFieldTag = "password" | `group:${string}` | `upload-group:${string}` | "display:stars" | "display:no_autofill" | "display:currency" | "display:cascade" | "display:survey" | "display:quoting" | "display:customModal" | `display:replace:'${string}':'${string}'` | "display:terms_conditions" | `display:main_media:${string}` | "date_component:day" | "date_component:month" | "date_component:year" | "action:client_upload" | "action:require_webauthn" | "verify:show_if_pending" | "special:hide_select_behind_button" | "type:capture_geolocation" | "type:extract_required";
 export type SchemaTag = "action:experimental_pass_object_store_id" | "action:verify" | "default_camera:rear" | "default_camera:front" | `oauth2_component:name:${string}` | `oauth2_component:redirect_url:${string}` | `time:${string}:${number}` | `link_to:${string}:${string}` | "type:service_provider" | "type:service_offer" | "type:marketplace" | "type:client_only" | "type:globally_unique_field";
 export type SchemaField = {
     /** @deprecated don't use, it's inconsistent */
@@ -53,7 +53,7 @@ export type SchemaField = {
         [subFieldName: string]: SchemaField;
     };
     /** If this field refers to a sub-object */
-    $ref?: string;
+    $ref?: SchemaName;
     /**
      * @internal
      * the client adds this for conditional properties, see #329
@@ -108,11 +108,12 @@ export type SchemaField = {
 export type ServerSchemaField = Omit<SchemaField, "$prop">;
 /** not exported. Attributes that are identical in both client schema & server schema */
 export type CommonSchemaAttributes = {
-    type?: DataTypes;
     /** these fields will always exist on schema */
-    name: string;
     title: string;
     description: string;
+    /** specifies that the description is formatted in markdown */
+    description_decorator?: "md";
+    schema_type?: SchemaType;
     /** plural version of the title */
     title_plural?: string;
     /**
@@ -158,6 +159,10 @@ export type CommonSchemaAttributes = {
             $loading_pending_ver_resubmit: {
                 title: string;
             };
+            $loading_long_verification_message: {
+                title?: string;
+                description?: string;
+            };
             [fieldNameOrGroupName: string]: ServerSchemaField & {
                 title_plural?: string;
             };
@@ -170,9 +175,9 @@ export type CommonSchemaAttributes = {
         /** if required_relationship then use will be alerted in relationship menu and won't be able to share PO unless filled out */
         required_relationship?: boolean;
         /** Specify `oneOf` XOR `anyOf`. It's a list of schema names, or `"instance"` (see #784) */
-        oneOf?: string[];
+        oneOf?: (SchemaName | "instance")[];
         /** Specify `oneOf` XOR `anyOf` It's a list of schema names. */
-        anyOf?: string[];
+        anyOf?: SchemaName[];
         /** assume TRUE if not specified */
         multiple?: boolean;
         /** these are arbitary fields on the relationship */
@@ -212,7 +217,7 @@ export type CommonSchemaAttributes = {
     onboard_properties?: {
         /** Profile Objects that should be created */
         profile_objects?: {
-            schema_name: string;
+            schema_name: SchemaName;
             properties: Record<string, unknown>;
         }[];
         /** Relationships that should be created */
@@ -248,6 +253,10 @@ export type CommonSchemaAttributes = {
  * of what the API returns.
  */
 export type Schema = CommonSchemaAttributes & {
+    /** added by the client, copied from {@link WrappedSchema} */
+    name: SchemaName;
+    /** added by client */
+    type?: DataTypes;
     /** the localized title of the `schema_group`. added by the client */
     group_title?: string;
     /** originally `string[]`, the client modifies this */
@@ -280,6 +289,8 @@ export type Schema = CommonSchemaAttributes & {
     /** added by the client. If true, this schema somehow relates to legacy service providers */
     isSpSchema?: boolean;
 };
+/** Type Classification of a Schema returned by API */
+export type SchemaType = "ss" | "ps" | "us";
 /** This is what's returned by the API */
 export type WrappedSchema = {
     active: true;
@@ -287,9 +298,10 @@ export type WrappedSchema = {
     start_date: string;
     /** ISO Date. If this tag exists, the schema is deprecated. */
     end_date: string;
-    name: string;
-    type: "ss" | "ps" | "us";
-    version: string;
+    /** Schema Name Type and Version Properties */
+    schema_name: SchemaName;
+    schema_type: SchemaType;
+    schema_version: string;
     /** whether the \`version\` is the latest version */
     version_current: boolean;
     schema: CommonSchemaAttributes & {

package/dist/verification.d.ts

@@ -1,8 +1,32 @@
-import { NId, ProfileObject } from "./raytio";
+import type { NId, ProfileObject, SchemaName } from "./raytio";
+export declare enum SafeHarbourCode {
+    /** “a match has been made on each the Full Name, Address and Date of Birth” */
+    M1 = "M1",
+    /** “a match has been made on both Full Name and Date of Birth (but not Address)” */
+    M2 = "M2",
+    /** “a match has been made on both Full Name and Address (but not Date of Birth)” */
+    N1 = "N1"
+}
 export type VerificationPayload<WithValue extends boolean> = {
     field: string;
-    schema?: string;
-    metadata?: Record<string, unknown>;
+    schema?: SchemaName;
+    metadata?: {
+        safeHarbourScore?: SafeHarbourCode;
+        status?: "pending";
+        pending_details?: {
+            /**
+             * for pending verifications - whether the verifier will complete fast enough that
+             * we can show a loading indicator. If not, the user has to come back another day.
+             */
+            pending_time: "short" | "long";
+            /**
+             * for pending verifications - whether further user interaction is required to
+             * complete the verification, or if it will complete silently in the background.
+             */
+            pending_type: "time" | "user";
+        };
+        [otherAttributes: string]: unknown;
+    };
     passed: boolean;
     request_div: string;
     /** @deprecated don't use this, it looks like the schema name but it's not */
@@ -39,6 +63,14 @@ export type Verification<WithValue extends boolean = false> = ProfileObject<{
         {
             signature: string;
             data: VerificationPayload<WithValue>;
+            /** undefined for data created before July 2023 */
+            key_id?: string;
+            /** undefined for data created before July 2023 */
+            key_urn?: string;
+            /** undefined for data created before July 2023 */
+            signing_algorithm?: "RSASSA_PSS_SHA_512";
+            /** undefined for data created before July 2023 */
+            hashing_algorithm?: "SHA512";
         }
     ];
 }>;
@@ -81,7 +113,7 @@ export type RealVer = {
      */
     verified: boolean;
     /** arbitary metadata returned by the verifier */
-    metadata?: Record<string, unknown>;
+    metadata?: VerificationPayload<false>["metadata"];
     /** nId of the verification */
     nID: NId;
     /** nId of the PO that the verification belongs to. Could be undefined */

package/dist/verification.js

@@ -1,6 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.POVerification = exports.FieldVerification = void 0;
+exports.POVerification = exports.FieldVerification = exports.SafeHarbourCode = void 0;
+// see #659
+var SafeHarbourCode;
+(function (SafeHarbourCode) {
+    /** “a match has been made on each the Full Name, Address and Date of Birth” */
+    SafeHarbourCode["M1"] = "M1";
+    /** “a match has been made on both Full Name and Date of Birth (but not Address)” */
+    SafeHarbourCode["M2"] = "M2";
+    /** “a match has been made on both Full Name and Address (but not Date of Birth)” */
+    SafeHarbourCode["N1"] = "N1";
+})(SafeHarbourCode || (exports.SafeHarbourCode = SafeHarbourCode = {}));
 /**
  * "Not Verified" means show no badge, cf. "Verified False" means the
  * verifier revealed that the data was wrong. So show a ❌
@@ -13,7 +23,7 @@ var FieldVerification;
     FieldVerification[FieldVerification["NotVerified"] = 60002] = "NotVerified";
     FieldVerification[FieldVerification["VerifiedFalse"] = 60003] = "VerifiedFalse";
     FieldVerification[FieldVerification["Expired"] = 60004] = "Expired";
-})(FieldVerification = exports.FieldVerification || (exports.FieldVerification = {}));
+})(FieldVerification || (exports.FieldVerification = FieldVerification = {}));
 // We cannot change the enum values, since ScoreRules have been generated
 // with the enum values hardcoded.
 var POVerification;
@@ -25,4 +35,4 @@ var POVerification;
     POVerification[POVerification["NotVerified"] = 70005] = "NotVerified";
     POVerification[POVerification["Expired"] = 70006] = "Expired";
     POVerification[POVerification["Loading"] = 70007] = "Loading";
-})(POVerification = exports.POVerification || (exports.POVerification = {}));
+})(POVerification || (exports.POVerification = POVerification = {}));

package/dist/wizard.d.ts

@@ -1,11 +1,11 @@
-import { AId } from "./raytio";
+import type { AId, SchemaName } from "./raytio";
 export type WizardPageTag = "action:require_chip";
 /** configuration data for a single wizard page ({@link WizardConfig}) */
 export type WizardPage = {
     /** if undefined, the schema title will be used */
     name?: string | symbol;
     filter: "oneOf" | "anyOf";
-    schemas: string[];
+    schemas: SchemaName[];
     /** the fallback description, if there isn't one for the specific situation */
     description?: string;
     description_select?: string;
@@ -81,9 +81,9 @@ export type WizardConfig = {
     /** number of days in the future */
     expiry_date?: number;
     /** if specified, a Wizard will be shown on the review page with this schema */
-    terms_schema?: string;
+    terms_schema?: SchemaName;
     /** if specified, a Wizard will be shown on the review page with this schema */
-    signature_schema?: string;
+    signature_schema?: SchemaName;
     reference?: string;
     /**
      * the callback url to redirect to once complete. Must be in the AA's
@@ -102,6 +102,8 @@ export type WizardConfig = {
     quick_onboard?: boolean;
     /** the loading message to show next to the spinner after the review screen */
     sharing_data_message?: string;
+    /** If this value is true, the form will display some data sharing information before the form (WizardPreview) */
+    display_sharing_preview?: boolean;
     /** a list of relationships that should be created after the wizard completes (see #987) */
     relationships?: {
         /** schema name */
@@ -113,4 +115,6 @@ export type WizardConfig = {
         /** relationship properties */
         properties?: Record<string, any>;
     }[];
+    /** if specified, the user must validate their WebAuthN credential before they can submit the form */
+    webauthn_type?: ("usb" | "nfc" | "ble" | "internal")[];
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raytio/types",
-  "version": "7.1.0",
+  "version": "7.3.0",
   "license": "MIT",
   "main": "index",
   "types": "index",

package/src/__tests__/raytio.typetest.ts

@@ -0,0 +1,6 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import type { Urn, UrnNodeType } from "..";
+
+// test that the definition of `Urn` only uses valid `UrnNodeType`s
+const assertTrue: Urn extends `urn:${UrnNodeType}:${string}` ? true : false =
+  true;

package/src/__tests__/{schema.ts → schema.typetest.ts}

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
-import { Schema, SchemaField, WrappedSchema } from "..";
+import type { Schema, SchemaField, WrappedSchema } from "..";
 
 /**
  * this file is not run, it is just compiled by tsc

package/src/index.ts

@@ -4,3 +4,4 @@ export * from "./schema";
 export * from "./theme";
 export * from "./verification";
 export * from "./wizard";
+export * from "./orgs";

package/src/orgs.ts

@@ -0,0 +1,86 @@
+/** Types Used for Organization Related API Responses */
+/** An Organisation */
+export type Party = {
+  id: string;
+  start_date: string;
+  end_date: string;
+  active: boolean;
+  party_name: string;
+  party_description: string;
+  party_type: string;
+  metadata: PartyMetadata;
+  party_number: number;
+};
+
+/** An Organizations credentials */
+export type PartyMetadata = {
+  gandalf: unknown;
+  stripe: { customer: unknown };
+  centrix_credentials: unknown;
+};
+
+/** An Organization Site */
+export type PartySite = {
+  id: string;
+  start_date: string;
+  end_date: string;
+  active: boolean;
+  party_id: string;
+  location_number: number;
+  party_site_name: string;
+  party_site_description: string | null;
+  party_site_number: string | null;
+  party_uses: string[];
+  party_use_primary: string;
+  metadata: unknown;
+};
+
+/** An Organization Location */
+export type Location = {
+  id: string;
+  start_date: string;
+  end_date: string;
+  active: boolean;
+  location_name: string;
+  location_description: string | null;
+  address_line_1: string | null;
+  address_line_2: string | null;
+  address_line_3: string | null;
+  address_line_4: string | null;
+  premise: string | null;
+  subpremise: string | null;
+  street_number: string | null;
+  administrative_area_level_1: string | null;
+  administrative_area_level_2: string | null;
+  administrative_area_level_3: string | null;
+  route: string | null;
+  locality: string | null;
+  postal_code: string;
+  postal_code_suffix: string | null;
+  city: string | null;
+  region: string | null;
+  country: string | null;
+  geolocation: string | null;
+  geolocation_outline: string | null;
+  metadata: unknown;
+};
+
+/** A Contact Point for an Organization */
+export type ContactPoint = {
+  id: string;
+  start_date: string;
+  end_date: string;
+  active: boolean;
+  to_table: string;
+  uuid: string | undefined;
+  contact_point_purpose: string;
+  contact_point_type: string;
+  e164: string | null;
+  e164_suffix: string | null;
+  e164_type: string | null;
+  url: string | null;
+  url_type: string | null;
+  email_address: string;
+  email_address_preferred_format: string;
+  metadata: unknown;
+};