@raytio/types v8.0.0

@raytio/types

This module contains typescript definitions for Raytio data structures, such as Schema and ProfileObject.

Usage

Install the package:

npm i -D @raytio/types

Import definitions:

import type { Schema } from "@raytio/types";

Hovering over the type in VSCode will display documentation and available properties.

Versioning

⚠️ This package does not strictly follow semver, since every change to the type definitions is a breaking change.

Documentation

Table of contents

Enumerations

• FieldVerification
• POVerification
• SafeHarbourCode

Type Aliases

• AA
• AATag
• AId
• CId
• Colors
• CommonFields
• CommonSchemaAttributes
• ConditionallyRequired
• ContactPoint
• ContentUrl
• CustomFonts
• Customer
• CustomerSite
• CustomerSiteUse
• CustomerUser
• DataTypes
• Encrypted
• GId
• GPMId
• IId
• Instance
• InstanceWithoutData
• KId
• LId
• LOCId
• Link
• Location
• Lookup
• MId
• Merchant
• MerchantApprovalStatusCode
• MerchantClassCode
• MerchantStatusCode
• MerchantTypeCode
• NId
• NId2
• OId
• Organization
• PCId
• PId
• PKId
• PLId
• PLLId
• PMId
• PRCId
• PRid
• PTId
• Party
• PartyMetadata
• PartySite
• PaymentMethod
• PaymentProcessor
• PermissionType
• PriceList
• PriceListLine
• ProfileObject
• RealVer
• Relationship
• SId
• SLId
• Schema
• SchemaField
• SchemaFieldTag
• SchemaName
• SchemaTag
• SchemaType
• ServerSchemaField
• SubmissionStatus
• Subscription
• SubscriptionLine
• TId
• UId
• Urn
• UrnNodeType
• Validation
• Verification
• VerificationPayload
• VerificationProvider
• VerificationType
• WId
• WSId
• Webhook
• WebhookStatus
• WizardConfig
• WizardPage
• WizardPageTag
• WrappedSchema

Type Aliases

AA

Ƭ AA: Object

Type declaration

AATag

Ƭ AATag: "type:client_only" | "type:share_with_new_user" | `related_service_provider:n_id:${NId}` | "ServiceProvider"

AId

Ƭ AId: StringWithIdentity<"AId">

An a_id is the ID of an AA

CId

Ƭ CId: StringWithIdentity<"CId">

A c_id is the ID of a Customer, (will eventually replace org_id)

Colors

Ƭ Colors: Object

Type declaration

CommonFields

Ƭ CommonFields<IdType, Metadata>: Object

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 StringWithIdentity (e.g. NId or 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.

Type parameters

Type declaration

CommonSchemaAttributes

Ƭ CommonSchemaAttributes: Object

not exported. Attributes that are identical in both client schema & server schema

Type declaration

ConditionallyRequired

Ƭ ConditionallyRequired: Object

should be renamed since this applies to ConditionallyVerifiable

Type declaration

ContactPoint

Ƭ ContactPoint: CommonFields<PCId> & { contact_point_purpose: string ; contact_point_type: string ; e164: string | null ; e164_suffix: string | null ; e164_type: string | null ; email_address: string ; email_address_preferred_format: string ; party_id: PRid ; url: string | null ; url_type: string | null ; uuid: string | undefined }

A Contact Point for an Organization

ContentUrl

Ƭ ContentUrl: `url:${string}`

CustomFonts

Ƭ CustomFonts: Object

Type declaration

Customer

Ƭ Customer: CommonFields<CId> & { customer_code: string ; owner_email: string ; party_description: OId ; party_id: PRid ; permission_type: PermissionType | null ; prm_parties?: Party ; user_email: string ; user_id: UId | null }

An organization/customer, directly returned by the API

CustomerSite

Ƭ CustomerSite: CommonFields<never> & { customer_site_code: string ; customer_site_status_code: string ; org_id: OId ; party_site_id: string }

CustomerSiteUse

Ƭ CustomerSiteUse: CommonFields<never> & { customer_site_id: string ; customer_site_use_name: string ; customer_site_use_purpose_code: string ; freight_term_code: string | null ; org_id: OId ; payment_term_id: string ; price_list_version_id: string | null }

CustomerUser

Ƭ CustomerUser: CommonFields<CId> & { customer_code: string ; group_name: string | null ; owner_email: string ; owner_id: UId ; party_description: OId ; party_id: PRid ; party_name: string ; permission_type: PermissionType | null ; user_email: string | null ; user_id: UId | null }

Organization Customer / User, Returned directly by the API

DataTypes

Ƭ DataTypes: "string" | "number" | "boolean" | "object" | "integer" | "array" | "null"

Encrypted

Ƭ Encrypted<_Data>: Object

Type parameters

Type declaration

GId

Ƭ GId: StringWithIdentity<"GId">

A g_id is the ID of a group

GPMId

Ƭ GPMId: StringWithIdentity<"GPMId">

A gpm_id is the ID of a Verification Type

IId

Ƭ IId: StringWithIdentity<"IId">

An i_id is the ID of an Instance

Instance

Ƭ Instance: InstanceWithoutData & { keys: { [nId2: NId2]: { [fieldName: string]: { data: string }; }; } ; profile_objects: ProfileObject[] ; relationships: Relationship[] }

The API used to store data in this format, but it no longer does :( so @raytio/core reconstructs this object.

InstanceWithoutData

Ƭ InstanceWithoutData: CommonFields<IId, { message?: string }> & { aa_id: AId ; aack_id: KId ; confirmation_code: string ; data_provider_email: string ; device_id?: unknown ; instance_version?: unknown ; platform_footer_html?: unknown ; previous_state?: SubmissionStatus ; reference: string ; related_offers?: unknown ; related_service_types?: unknown ; score?: unknown ; service_provider_n_id: NId ; source_ip?: unknown ; state: SubmissionStatus ; sub_service_provider_hash: string ; thread: string }

KId

Ƭ KId: StringWithIdentity<"KId">

A k_id (also called a aack_id or a publicKeyId) is the ID of an AA's public key

LId

Ƭ LId: StringWithIdentity<"LId">

An l_id is the ID of any data stored in the KV-Store

LOCId

Ƭ LOCId: StringWithIdentity<"LOCId">

A loc_id is the ID of a location

Link

Ƭ Link: Object

Link used for an Access Application, including all additional information

Type declaration

Location

Ƭ Location: CommonFields<LOCId> & { address_line_1: string | null ; address_line_2: string | null ; address_line_3: string | null ; address_line_4: string | null ; administrative_area_level_1: string | null ; administrative_area_level_2: string | null ; administrative_area_level_3: string | null ; city: string | null ; country: string | null ; geolocation: string | null ; geolocation_outline: string | null ; locality: string | null ; location_description: string | null ; location_name: string ; postal_code: string ; postal_code_suffix: string | null ; premise: string | null ; region: string | null ; route: string | null ; street_number: string | null ; subpremise: string | null }

An Organization Location

Lookup

Ƭ Lookup: Object

Type declaration

MId

Ƭ MId: StringWithIdentity<"MId">

A m_id is the ID of a Merchant

Merchant

Ƭ Merchant: CommonFields<MId> & { merchant_approval_status_code: MerchantApprovalStatusCode | null ; merchant_class_code: MerchantClassCode | null ; merchant_common_name: string | null ; merchant_common_name_i18n: Json | null ; merchant_description: string | null ; merchant_description_i18n: Json | null ; merchant_image_url_logo: string | null ; merchant_image_url_thumbnail: string | null ; merchant_name: string | null ; merchant_name_i18n: Json | null ; merchant_status_code: MerchantStatusCode | null ; merchant_type_code: MerchantTypeCode | null ; party_id: PRid }

MerchantApprovalStatusCode

Ƭ MerchantApprovalStatusCode: "PENDING" | "APPROVED"

MerchantClassCode

Ƭ MerchantClassCode: "CLASS_1" | "CLASS_2"

MerchantStatusCode

Ƭ MerchantStatusCode: "ACTIVE" | "INACTIVE"

MerchantTypeCode

Ƭ MerchantTypeCode: "TYPE_1" | "TYPE_2"

NId

Ƭ NId: StringWithIdentity<"NId">

An n_id is the ID of a ProfileObject

NId2

Ƭ NId2: StringWithIdentity<"NId2">

⚠️ This ID duplicates the NId and should only be used in exceptional circumstances

OId

Ƭ OId: StringWithIdentity<"OId">

An o_id is the ID of an Organization

NOTE: Will be deprecated soon. Use CId instead.

Organization

Ƭ Organization: Object

An organization. NOTE: this is different to how the schema defines an Organization. The schema is wrong (see #468)

Type declaration

PCId

Ƭ PCId: StringWithIdentity<"PCId">

A pc_id is the ID of a Party Contact Point

PId

Ƭ PId: StringWithIdentity<"PId">

A p_id is the ID of a Relationship

PKId

Ƭ PKId: StringWithIdentity<"PKId">

A pk_id is the ID of an AA's private key

PLId

Ƭ PLId: StringWithIdentity<"PLId">

A pl_id is the ID of a PriceList

PLLId

Ƭ PLLId: StringWithIdentity<"PLLId">

A pll_id is the ID of a PriceListLine/Plan

PMId

Ƭ PMId: StringWithIdentity<"PMId">

A pm_id is the ID of a PaymentMethod

PRCId

Ƭ PRCId: StringWithIdentity<"PRCId">

A prc_id is the ID of a Price

PRid

Ƭ PRid: StringWithIdentity<"PRid">

A pr_id is the ID of a Party

PTId

Ƭ PTId: StringWithIdentity<"PTId">

A pt_id is the ID of a PaymentProcessor

Party

Ƭ Party: CommonFields<PRid, PartyMetadata> & { far_customers: CommonFields<CId> & { customer_approval_status_code: string ; customer_class_code: string ; customer_status_code: string ; customer_type_code: string ; far_customers_customer_approval_status_lookup: Lookup ; far_customers_customer_class_lookup: Lookup ; far_customers_customer_status_lookup: Lookup ; far_customers_customer_type_lookup: Lookup ; far_customers_freight_terms_lookup: Lookup ; freight_term_code: string ; price_list_version_id: string | null }[] ; party_description: OId ; party_image_url_logo: string | null ; party_name: string ; party_type: string }

PartyMetadata

Ƭ PartyMetadata: Object

An Organizations credentials

Type declaration

PartySite

Ƭ PartySite: CommonFields<never> & { location_id: number ; party_id: PRid ; party_site_description: string | null ; party_site_name: string ; party_use_primary: string ; party_uses: string[] }

An Organization Site

PaymentMethod

Ƭ PaymentMethod: CommonFields<PMId> & { address_line1_check?: string | null ; address_postal_code_check?: string | null ; card_expiry_month: number ; card_expiry_year: number ; card_fingerprint?: string | null ; card_funding_method: string ; card_last_4_digits: string ; customer_id: CId ; cvc_check?: string | null ; payer_payment_method_type: string ; payment_method_available_networks: string[] | string ; payment_method_country_code: string | null ; payment_method_preferred_network?: string | null ; payment_method_scheme: string ; payment_processor_id: string ; payment_processor_payment_method_id: string ; primary_payment_method: boolean ; three_d_secure_usage?: string | null }

PaymentProcessor

Ƭ PaymentProcessor: CommonFields<PTId> & { party_id: PRid ; payment_processor_name: string ; payment_processor_system: string }

PermissionType

Ƭ PermissionType: "ADMINS" | "VIEWS" | "EDITS" | "OWNS"

PriceList

Ƭ PriceList: Object

Type declaration

PriceListLine

Ƭ PriceListLine: Object

Type declaration

ProfileObject

Ƭ ProfileObject<Properties>: Partial<CommonFields<NId2>> & { labels: string[] ; n_id: NId ; properties: Properties }

You can supply an option type argument if you know exactly what the properties will be

Type parameters

RealVer

Ƭ RealVer: Object

This is what @raytio/core exposes, which is more useable than Verification

Type declaration

Relationship

Ƭ Relationship: Object

Type declaration

SId

Ƭ SId: StringWithIdentity<"SId">

A s_id is the ID of a Subscription

SLId

Ƭ SLId: StringWithIdentity<"SLId">

A sl_id is the ID of a SubscriptionLine

Schema

Ƭ Schema: CommonSchemaAttributes & { clientLocale?: string ; database?: { primary_key: string ; table: string } ; end_date?: string ; groupNames?: Record<string, string> ; group_title?: string ; isProfileSchema?: boolean ; isSpSchema?: boolean ; name: SchemaName ; properties: { [fieldName: string]: SchemaField; } ; required?: (string | ConditionallyRequired)[] ; start_date?: string ; timing?: Record<"extract" | "live_person" | "verify_pending_delay", number> ; type?: DataTypes ; verified_fields?: (string | ConditionallyRequired)[] ; version: string ; wasExpandedByClient?: boolean }

Raytio's variant of JSON Schema, as used by the client. It is a modified version of what the API returns.

SchemaField

Ƭ SchemaField: Object

Type declaration

SchemaFieldTag

Ƭ SchemaFieldTag: "password" | `group:${string}` | `upload-group:${string}` | "display:stars" | "display:no_autofill" | "display:currency" | "display:cascade" | "display:survey" | "display:quoting" | "display:customModal" | "display:mask" | `display:replace:('${string}', '${string}')` | "display:terms_conditions" | `display:main_media:${string}` | "date_component:day" | "date_component:month" | "date_component:year" | "action:allow_copy" | "action:allow_unreplace" | "action:allow_password_compromise_check" | "action:client_upload" | "action:hash" | "action:require_webauthn" | "action:generate_pepper:" | "verify:show_if_pending" | "special:hide_select_behind_button" | "type:capture_geolocation" | "type:extract_required"

SchemaName

Ƭ SchemaName: StringWithIdentity<"SchemaName">

A SchemaName is the ID of a Schema

SchemaTag

Ƭ SchemaTag: "action:experimental_pass_object_store_id" | "action:verify" | `action:display_qr_code:${string}:${string}` | "default_camera:rear" | "default_camera:front" | `oauth2_component:name:${string}` | `oauth2_component:redirect_url:${string}` | `time:${string}:${number}` | `link_to:${string}:${string}` | "display:default_view:edit" | "type:service_provider" | "type:service_offer" | "type:marketplace" | "type:client_only" | "type:globally_unique_field"

SchemaType

Ƭ SchemaType: "ss" | "ps" | "us"

Type Classification of a Schema returned by API

ServerSchemaField

Ƭ ServerSchemaField: Omit<SchemaField, "$prop">

the only difference between the client & server's definition is that the client adds $prop

SubmissionStatus

Ƭ SubmissionStatus: "Submitted" | "Processing" | "Rejected" | "Expired" | "Completed" | "DataChanged" | "Received" | "Accepted"

Subscription

Ƭ Subscription: CommonFields<SId> & { billing_cycle_day_of_month: number | null ; billing_cycle_day_of_week: number | null ; billing_cycle_hour: number | null ; billing_cycle_minute: number | null ; billing_cycle_month: number | null ; billing_cycle_second: number | null ; cancellation_effective_date: string | null ; cancellation_final_invoice_action: string ; cancellation_request_date: string | null ; cancellation_request_reason: string | null ; current_billing_period_end: string | null ; current_billing_period_start: string ; subscribed_to_customer_id: string ; subscribed_to_customer_site_id: string | null ; subscribed_to_party_contact_point_id: string ; subscription_name: string ; subscription_name_i18n: string | null }

SubscriptionLine

Ƭ SubscriptionLine: CommonFields<SLId> & { billing_subscription_id: SId ; metadata: string | null ; price_id: PRCId ; subscribed_qty: number }

TId

Ƭ TId: StringWithIdentity<"TId">

A t_id is the ID of a transaction

UId

Ƭ UId: StringWithIdentity<"UId">

A u_id is the ID of a user

Urn

Ƭ Urn: `urn:user:${UId}` | `urn:profile_object:${NId}` | `urn:instance:${IId}` | `urn:temp_object:${LId}` | `urn:schema:${SchemaName}` | `urn:document:${NId}`

e.g. "urn:user:..."

UrnNodeType

Ƭ UrnNodeType: "user" | "profile_object" | "instance" | "schema" | "temp_object" | "document"

Validation

Ƭ Validation: Object

validation data returned by preVerify (part of the extract&map API)

Type declaration

Verification

Ƭ Verification<WithValue>: ProfileObject<{ field: string ; n_id: NId ; valid_until?: string ; verifications: [{ data: VerificationPayload<WithValue> ; hashing_algorithm?: "SHA512" ; key_id?: string ; key_urn?: string ; signature: string ; signing_algorithm?: "RSASSA_PSS_SHA_512" }] }>

Different APIs inconsistently include the value prop. If you know it exists, use Verification<true>, otherwise just Verification. Verifications from the DataContext don't have the value.

Type parameters

VerificationPayload

Ƭ VerificationPayload<WithValue>: { field: string ; metadata?: { [otherAttributes: string]: unknown; pending_details?: { pending_time: "short" | "long" ; pending_type: "time" | "user" } ; safeHarbourScore?: SafeHarbourCode ; status?: "pending" | "approved" ; validation?: { id: string ; url: string } } ; passed: boolean ; request_div: string ; schema?: SchemaName ; source: string ; source_hashed_n_id?: NId ; source_n_id?: NId ; type?: null ; v_id: string ; verification_date: string ; verification_type_id: GPMId ; verifier_div: string ; verifier_id?: NId ; verifier_service_id?: NId ; verifier_source_id?: NId } & WithValue extends true ? { value: string | number } : {}

Type parameters

VerificationProvider

Ƭ VerificationProvider: Object

These n_ids point to service provider profile objects

Type declaration

VerificationType

Ƭ VerificationType: CommonFields<GPMId> & { asset: boolean | null ; inventory_organization_number: number | null ; item_description: string ; item_description_i18n: Json | null ; item_dimension_height: number | null ; item_dimension_length: number | null ; item_dimension_uom: string | null ; item_dimension_width: number | null ; item_key: string ; item_key_01: string | null ; item_key_02: string | null ; item_key_03: string | null ; item_mass: number | null ; item_mass_uom: string | null ; item_name: string ; item_name_i18n: Json | null ; item_number: number ; item_type: string | null ; item_volume: number | null ; item_volume_uom: string | null ; org_number: number ; primary_uom: string ; purchased: boolean | null ; returnable: boolean | null ; secondary_uom: string | null ; shipped: boolean | null ; source_organization_number: number | null ; source_type: string | null ; stocked: boolean | null ; transacted: boolean | null }

WId

Ƭ WId: StringWithIdentity<"WId">

A wi_id is the ID of a Webhook

WSId

Ƭ WSId: StringWithIdentity<"WSId">

A ws_id is the ID of a transition

Webhook

Ƭ Webhook: Object

Type declaration

WebhookStatus

Ƭ WebhookStatus: "subscribed" | "pending" | "unsubscribe_failed"

WizardConfig

Ƭ WizardConfig: Object

when a form link is generated, this is what gets saved on the API. Each value can be overridden in the query parameters. If specified in the query parameters, it needs to be base64 and/or url encoded.

Type declaration

WizardPage

Ƭ WizardPage: Object

configuration data for a single wizard page (WizardConfig)

Type declaration

WizardPageTag

Ƭ WizardPageTag: "action:require_chip"

WrappedSchema

Ƭ WrappedSchema: Object

This is what's returned by the API

Type declaration