npm package: @raytio/types
Description: This module contains typescript definitions for Raytio data structures, such as `Schema` and `ProfileObject`.
Latest version: 8.0.0

# @raytio/types

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

## Usage

Install the package:

```sh
npm i -D @raytio/types
```

Import definitions:

```ts
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](enums/FieldVerification.md)
- [POVerification](enums/POVerification.md)
- [SafeHarbourCode](enums/SafeHarbourCode.md)

### Type Aliases

- [AA](#aa)
- [AATag](#aatag)
- [AId](#aid)
- [CId](#cid)
- [Colors](#colors)
- [CommonFields](#commonfields)
- [CommonSchemaAttributes](#commonschemaattributes)
- [ConditionallyRequired](#conditionallyrequired)
- [ContactPoint](#contactpoint)
- [ContentUrl](#contenturl)
- [CustomFonts](#customfonts)
- [Customer](#customer)
- [CustomerSite](#customersite)
- [CustomerSiteUse](#customersiteuse)
- [CustomerUser](#customeruser)
- [DataTypes](#datatypes)
- [Encrypted](#encrypted)
- [GId](#gid)
- [GPMId](#gpmid)
- [IId](#iid)
- [Instance](#instance)
- [InstanceWithoutData](#instancewithoutdata)
- [KId](#kid)
- [LId](#lid)
- [LOCId](#locid)
- [Link](#link)
- [Location](#location)
- [Lookup](#lookup)
- [MId](#mid)
- [Merchant](#merchant)
- [MerchantApprovalStatusCode](#merchantapprovalstatuscode)
- [MerchantClassCode](#merchantclasscode)
- [MerchantStatusCode](#merchantstatuscode)
- [MerchantTypeCode](#merchanttypecode)
- [NId](#nid)
- [NId2](#nid2)
- [OId](#oid)
- [Organization](#organization)
- [PCId](#pcid)
- [PId](#pid)
- [PKId](#pkid)
- [PLId](#plid)
- [PLLId](#pllid)
- [PMId](#pmid)
- [PRCId](#prcid)
- [PRid](#prid)
- [PTId](#ptid)
- [Party](#party)
- [PartyMetadata](#partymetadata)
- [PartySite](#partysite)
- [PaymentMethod](#paymentmethod)
- [PaymentProcessor](#paymentprocessor)
- [PermissionType](#permissiontype)
- [PriceList](#pricelist)
- [PriceListLine](#pricelistline)
- [ProfileObject](#profileobject)
- [RealVer](#realver)
- [Relationship](#relationship)
- [SId](#sid)
- [SLId](#slid)
- [Schema](#schema)
- [SchemaField](#schemafield)
- [SchemaFieldTag](#schemafieldtag)
- [SchemaName](#schemaname)
- [SchemaTag](#schematag)
- [SchemaType](#schematype)
- [ServerSchemaField](#serverschemafield)
- [SubmissionStatus](#submissionstatus)
- [Subscription](#subscription)
- [SubscriptionLine](#subscriptionline)
- [TId](#tid)
- [UId](#uid)
- [Urn](#urn)
- [UrnNodeType](#urnnodetype)
- [Validation](#validation)
- [Verification](#verification)
- [VerificationPayload](#verificationpayload)
- [VerificationProvider](#verificationprovider)
- [VerificationType](#verificationtype)
- [WId](#wid)
- [WSId](#wsid)
- [Webhook](#webhook)
- [WebhookStatus](#webhookstatus)
- [WizardConfig](#wizardconfig)
- [WizardPage](#wizardpage)
- [WizardPageTag](#wizardpagetag)
- [WrappedSchema](#wrappedschema)

## Type Aliases

### AA

Ƭ **AA**: `Object`

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `a_id` | [`AId`](#aid) | - |
| `aa_help?` | `string` | markdown or string help information including [phoneNumber \|\| email] |
| `aa_introduction?` | `string` | If a user signs up while completing this form, this message will be sent in the sign up email. |
| `active?` | `boolean` | - |
| `auth_list_enabled?` | `boolean` | if true, only specific email addresses can submit the form |
| `callback_uri?` | `string`[] | - |
| `customer_id` | [`CId`](#cid) | - |
| `description?` | `string` | - |
| `end_date?` | `Date` | - |
| `key?` | `string` | - |
| `logout_uri?` | `string`[] | - |
| `metadata?` | `unknown` | - |
| `name` | `string` | - |
| `org_id?` | [`OId`](#oid) | the id of the associated organization |
| `picture?` | [`Urn`](#urn) | **`Deprecated`** see !2101 |
| `picture_url?` | `string` | Easy to use AA logo url for pasting into emails |
| `ruleset?` | `unknown` | configuration for the submission rules |
| `scopes?` | `string`[] | - |
| `secret?` | `unknown` | - |
| `service_provider_n_id?` | [`NId`](#nid) | the n_id of the associated service provider |
| `start_date?` | `Date` | Currently Unused Attributes |
| `tags?` | [`AATag`](#aatag)[] | - |
| `theme?` | { `colors?`: [`Colors`](#colors) ; `font?`: [`CustomFonts`](#customfonts)  } | - |
| `theme.colors?` | [`Colors`](#colors) | - |
| `theme.font?` | [`CustomFonts`](#customfonts) | - |

___

### 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](#aa)

___

### CId

Ƭ **CId**: `StringWithIdentity`<``"CId"``\>

A `c_id` is the ID of a [Customer](#customer), (will eventually replace org_id)

___

### Colors

Ƭ **Colors**: `Object`

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `blank` | `string` | - |
| `climaterolText` | `string` | - |
| `climaterolUi` | `string` | - |
| `errorRed` | `string` | - |
| `feelingHugged` | `string` | - |
| `loadingYellow` | `string` | - |
| `poolblueText` | `string` | - |
| `poolblueUi` | `string` | - |
| `raytioOrangeHover` | `string` | - |
| `raytioOrangeShade` | `string` | ✨ |
| `raytioOrangeText` | `string` | - |
| `raytioOrangeUi` | `string` | - |
| `sariShade` | `string` | - |
| `silverShell` | `string` | - |
| `sirPinklyText` | `string` | - |
| `sirPinklyUi` | `string` | - |
| `successGreen` | `string` | - |
| `textFull` | `string` | - |
| `textLight` | `string` | - |
| `textMedium` | `string` | - |
| `violaPerpetuoText` | `string` | - |
| `violaPerpetuoUi` | `string` | - |

___

### 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](#nid) or [AId](#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

| Name | Type |
| :------ | :------ |
| `IdType` | extends `StringWithIdentity`<`string`\> |
| `Metadata` | `unknown` |

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `active` | `boolean` | - |
| `end_date` | `string` | ISO Date |
| `id` | `IdType` | - |
| `metadata` | `Metadata` \| `undefined` | - |
| `resource_group?` | `string` | - |
| `resource_name?` | `string` | - |
| `resource_url?` | `string` | - |
| `row_version?` | `number` | - |
| `start_date` | `string` | ISO Date |
| `tenant_id?` | `string` | - |

___

### CommonSchemaAttributes

Ƭ **CommonSchemaAttributes**: `Object`

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

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `description` | `string` | - |
| `description_decorator?` | ``"md"`` | specifies that the description is formatted in markdown |
| `display?` | { `compact_table?`: `boolean` ; `expand?`: { `fields`: `string`[] ; `label`: `string`  }[] ; `head_main?`: { `fields`: `string`[] ; `format?`: `string`  } ; `head_sub?`: { `fields`: `string`[] ; `format?`: `string`  } ; `tabular?`: { `fields`: `string`[]  }  } | - |
| `display.compact_table?` | `boolean` | determines if profile pages should display using compacted 'MiniPO' view or deafult view |
| `display.expand?` | { `fields`: `string`[] ; `label`: `string`  }[] | list of fields that should not be shown by default, unless you expand a collpase section which has a name from the label property. Array because there could be multiple expand groups |
| `display.head_main?` | { `fields`: `string`[] ; `format?`: `string`  } | list of fields to be considered the header/name of the PO fields joined with a space unless `format` format string is supplied |
| `display.head_main.fields` | `string`[] | - |
| `display.head_main.format?` | `string` | - |
| `display.head_sub?` | { `fields`: `string`[] ; `format?`: `string`  } | list of fields to be considered the subheader of the PO fields joined with a space unless `format` format string is supplied |
| `display.head_sub.fields` | `string`[] | - |
| `display.head_sub.format?` | `string` | - |
| `display.tabular?` | { `fields`: `string`[]  } | By default, the admin dashboard shows columns for all fields in listed in `head_main`. In rare cases you can use this property to specify a different set of fields to show to admins by default. |
| `display.tabular.fields` | `string`[] | - |
| `i18n?` | { `[locale: string]`: { `[fieldNameOrGroupName: string]`: [`ServerSchemaField`](#serverschemafield) & { `title_plural?`: `string`  }; `$loading_create_sub_obj`: { `title`: `string`  } ; `$loading_delete_pending_ver`: { `title`: `string`  } ; `$loading_extract`: { `title`: `string`  } ; `$loading_link_to_person`: { `title`: `string`  } ; `$loading_long_verification_message`: { `description?`: `string` ; `title?`: `string`  } ; `$loading_pending_ver_resubmit`: { `title`: `string`  } ; `$loading_permission`: { `title`: `string`  } ; `$loading_save`: { `title`: `string`  } ; `$loading_update`: { `title`: `string`  } ; `$loading_upload`: { `title`: `string`  } ; `$loading_verify`: { `title`: `string`  } ; `$schema`: { `description?`: `string` ; `title`: `string` ; `title_plural?`: `string`  }  };  } | - |
| `onboard_properties?` | { `organizations?`: { `access_applications?`: { `links?`: { `description`: `string` ; `wizardConfig`: `Omit`<[`WizardConfig`](#wizardconfig), ``"a_id"``\>  }[] ; `properties`: `Omit`<[`AA`](#aa), ``"org_id"``\>  }[] ; `properties`: [`Organization`](#organization)  }[] ; `profile_objects?`: { `properties`: `Record`<`string`, `unknown`\> ; `schema_name`: [`SchemaName`](#schemaname)  }[] ; `relationships?`: { `from`: `string` ; `properties?`: `Record`<`string`, `string`\> ; `to`: `string` ; `type`: `string`  }[] ; `return_to?`: `string`  } | only the schema used for the onboarding wizard have this property |
| `onboard_properties.organizations?` | { `access_applications?`: { `links?`: { `description`: `string` ; `wizardConfig`: `Omit`<[`WizardConfig`](#wizardconfig), ``"a_id"``\>  }[] ; `properties`: `Omit`<[`AA`](#aa), ``"org_id"``\>  }[] ; `properties`: [`Organization`](#organization)  }[] | Organizations that should be created. NOTE: if multiple are specified, when the wizard completes, the _first one_ will be selected |
| `onboard_properties.profile_objects?` | { `properties`: `Record`<`string`, `unknown`\> ; `schema_name`: [`SchemaName`](#schemaname)  }[] | Profile Objects that should be created |
| `onboard_properties.relationships?` | { `from`: `string` ; `properties?`: `Record`<`string`, `string`\> ; `to`: `string` ; `type`: `string`  }[] | Relationships that should be created |
| `onboard_properties.return_to?` | `string` | The relative path in the client to redirect to once finished. May include variables |
| `relationships?` | { `anyOf?`: [`SchemaName`](#schemaname)[] ; `direction`: ``"from"`` ; `multiple?`: `boolean` ; `oneOf?`: ([`SchemaName`](#schemaname) \| ``"instance"``)[] ; `properties?`: { `[fieldName: string]`: [`SchemaField`](#schemafield);  } ; `relationship_name`: `string` ; `required?`: `string`[] ; `required_relationship?`: `boolean` ; `type`: `string`  }[] | - |
| `schema_group?` | `string` | the group that a schema belongs to, such as "passports". This is useful for forms that accept different types of similar documents. |
| `schema_type?` | [`SchemaType`](#schematype) | - |
| `tags?` | [`SchemaTag`](#schematag)[] | - |
| `title` | `string` | these fields will always exist on schema |
| `title_plural?` | `string` | plural version of the title |

___

### ConditionallyRequired

Ƭ **ConditionallyRequired**: `Object`

should be renamed since this applies to ConditionallyVerifiable

#### Type declaration

| Name | Type |
| :------ | :------ |
| `field` | `string` |
| `if` | { `[fieldName: string]`: (`string` \| `number` \| `boolean`)[];  } |

___

### ContactPoint

Ƭ **ContactPoint**: [`CommonFields`](#commonfields)<[`PCId`](#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`](#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

| Name | Type |
| :------ | :------ |
| `body?` | `string` |
| `header?` | `string` |

___

### Customer

Ƭ **Customer**: [`CommonFields`](#commonfields)<[`CId`](#cid)\> & { `customer_code`: `string` ; `owner_email`: `string` ; `party_description`: [`OId`](#oid) ; `party_id`: [`PRid`](#prid) ; `permission_type`: [`PermissionType`](#permissiontype) \| ``null`` ; `prm_parties?`: [`Party`](#party) ; `user_email`: `string` ; `user_id`: [`UId`](#uid) \| ``null``  }

An organization/customer, directly returned by the API

___

### CustomerSite

Ƭ **CustomerSite**: [`CommonFields`](#commonfields)<`never`\> & { `customer_site_code`: `string` ; `customer_site_status_code`: `string` ; `org_id`: [`OId`](#oid) ; `party_site_id`: `string`  }

___

### CustomerSiteUse

Ƭ **CustomerSiteUse**: [`CommonFields`](#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`](#oid) ; `payment_term_id`: `string` ; `price_list_version_id`: `string` \| ``null``  }

___

### CustomerUser

Ƭ **CustomerUser**: [`CommonFields`](#commonfields)<[`CId`](#cid)\> & { `customer_code`: `string` ; `group_name`: `string` \| ``null`` ; `owner_email`: `string` ; `owner_id`: [`UId`](#uid) ; `party_description`: [`OId`](#oid) ; `party_id`: [`PRid`](#prid) ; `party_name`: `string` ; `permission_type`: [`PermissionType`](#permissiontype) \| ``null`` ; `user_email`: `string` \| ``null`` ; `user_id`: [`UId`](#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

| Name | Type |
| :------ | :------ |
| `_Data` | `string` |

#### Type declaration

| Name | Type |
| :------ | :------ |
| `encrypted_data` | { `algorithm`: `AesKeyAlgorithm` ; `data`: `string` ; `iv`: `string`  } |
| `encrypted_data.algorithm` | `AesKeyAlgorithm` |
| `encrypted_data.data` | `string` |
| `encrypted_data.iv` | `string` |
| `encrypted_key` | { `encrypted_key`: `string`  } |
| `encrypted_key.encrypted_key` | `string` |

___

### 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

Ƭ **Instance**: [`InstanceWithoutData`](#instancewithoutdata) & { `keys`: { `[nId2: NId2]`: { `[fieldName: string]`: { `data`: `string`  };  };  } ; `profile_objects`: [`ProfileObject`](#profileobject)[] ; `relationships`: [`Relationship`](#relationship)[]  }

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

___

### InstanceWithoutData

Ƭ **InstanceWithoutData**: [`CommonFields`](#commonfields)<[`IId`](#iid), { `message?`: `string`  }\> & { `aa_id`: [`AId`](#aid) ; `aack_id`: [`KId`](#kid) ; `confirmation_code`: `string` ; `data_provider_email`: `string` ; `device_id?`: `unknown` ; `instance_version?`: `unknown` ; `platform_footer_html?`: `unknown` ; `previous_state?`: [`SubmissionStatus`](#submissionstatus) ; `reference`: `string` ; `related_offers?`: `unknown` ; `related_service_types?`: `unknown` ; `score?`: `unknown` ; `service_provider_n_id`: [`NId`](#nid) ; `source_ip?`: `unknown` ; `state`: [`SubmissionStatus`](#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

| Name | Type |
| :------ | :------ |
| `a_id` | [`AId`](#aid) |
| `code` | [`LId`](#lid) |
| `details?` | [`AA`](#aa) |
| `id` | [`NId`](#nid) |
| `isDefault?` | `boolean` |
| `name` | `string` |
| `subtitle` | `string` |
| `url` | `string` |

___

### Location

Ƭ **Location**: [`CommonFields`](#commonfields)<[`LOCId`](#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

| Name | Type | Description |
| :------ | :------ | :------ |
| `children?` | [`Lookup`](#lookup)[] | - |
| `description?` | `string` | - |
| `key` | `string` \| `number` | - |
| `label?` | `string` \| `number` | Used in Antd Cascader |
| `requires_2FA?` | `boolean` | used in AkahuDynamicSection only |
| `value` | `string` \| `number` | - |

___

### MId

Ƭ **MId**: `StringWithIdentity`<``"MId"``\>

A `m_id` is the ID of a Merchant

___

### Merchant

Ƭ **Merchant**: [`CommonFields`](#commonfields)<[`MId`](#mid)\> & { `merchant_approval_status_code`: [`MerchantApprovalStatusCode`](#merchantapprovalstatuscode) \| ``null`` ; `merchant_class_code`: [`MerchantClassCode`](#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`](#merchantstatuscode) \| ``null`` ; `merchant_type_code`: [`MerchantTypeCode`](#merchanttypecode) \| ``null`` ; `party_id`: [`PRid`](#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](#profileobject)

___

### NId2

Ƭ **NId2**: `StringWithIdentity`<``"NId2"``\>

⚠️ This ID duplicates the [NId](#nid) and should only be used in exceptional circumstances

___

### OId

Ƭ **OId**: `StringWithIdentity`<``"OId"``\>

An `o_id` is the ID of an [Organization](#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

| Name | Type |
| :------ | :------ |
| `address?` | `unknown` |
| `contact_point?` | `Pick`<[`ContactPoint`](#contactpoint), ``"email_address"`` \| ``"id"``\> |
| `customerUsers` | [`CustomerUser`](#customeruser)[] |
| `id` | [`CId`](#cid) |
| `name` | `string` |
| `orgId` | [`OId`](#oid) |

___

### 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](#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](#party)

___

### PTId

Ƭ **PTId**: `StringWithIdentity`<``"PTId"``\>

A `pt_id` is the ID of a PaymentProcessor

___

### Party

Ƭ **Party**: [`CommonFields`](#commonfields)<[`PRid`](#prid), [`PartyMetadata`](#partymetadata)\> & { `far_customers`: [`CommonFields`](#commonfields)<[`CId`](#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`](#lookup) ; `far_customers_customer_class_lookup`: [`Lookup`](#lookup) ; `far_customers_customer_status_lookup`: [`Lookup`](#lookup) ; `far_customers_customer_type_lookup`: [`Lookup`](#lookup) ; `far_customers_freight_terms_lookup`: [`Lookup`](#lookup) ; `freight_term_code`: `string` ; `price_list_version_id`: `string` \| ``null``  }[] ; `party_description`: [`OId`](#oid) ; `party_image_url_logo`: `string` \| ``null`` ; `party_name`: `string` ; `party_type`: `string`  }

___

### PartyMetadata

Ƭ **PartyMetadata**: `Object`

An Organizations credentials

#### Type declaration

| Name | Type |
| :------ | :------ |
| `centrix_credentials` | `unknown` |
| `gandalf` | `unknown` |
| `stripe` | { `customer`: `unknown`  } |
| `stripe.customer` | `unknown` |

___

### PartySite

Ƭ **PartySite**: [`CommonFields`](#commonfields)<`never`\> & { `location_id`: `number` ; `party_id`: [`PRid`](#prid) ; `party_site_description`: `string` \| ``null`` ; `party_site_name`: `string` ; `party_use_primary`: `string` ; `party_uses`: `string`[]  }

An Organization Site

___

### PaymentMethod

Ƭ **PaymentMethod**: [`CommonFields`](#commonfields)<[`PMId`](#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`](#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`](#commonfields)<[`PTId`](#ptid)\> & { `party_id`: [`PRid`](#prid) ; `payment_processor_name`: `string` ; `payment_processor_system`: `string`  }

___

### PermissionType

Ƭ **PermissionType**: ``"ADMINS"`` \| ``"VIEWS"`` \| ``"EDITS"`` \| ``"OWNS"``

___

### PriceList

Ƭ **PriceList**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `id` | [`PLId`](#plid) |
| `pcm_price_list_versions?` | [{ `id`: `string` ; `pcm_price_list_lines`: [`PriceListLine`](#pricelistline)[] ; `price_list_version_name`: `string`  }] |
| `price_list_currency` | `string` |
| `price_list_description?` | `string` |
| `price_list_description_i18n?` | `string` |
| `price_list_name` | `string` |
| `price_list_name_i18n?` | `string` |
| `price_list_type` | `string` |

___

### PriceListLine

Ƭ **PriceListLine**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `id` | [`PLLId`](#pllid) |
| `pcm_prices` | { `amount`: `number` ; `billing_recurrence`: `string` ; `gpm_items`: { `id`: `string` ; `item_description`: `string` ; `item_description_i18n`: `string` \| ``null`` ; `item_key`: `string` ; `item_name`: `string` ; `item_name_i18n`: `string` \| ``null`` ; `primary_uom`: `string`  } ; `id`: [`PRCId`](#prcid) ; `price_currency`: `string` ; `recurring_billing_interval`: `string` \| ``null`` ; `recurring_billing_interval_count`: `number` ; `recurring_billing_scheme`: `string` ; `recurring_billing_usage_type`: `string`  } |
| `pcm_prices.amount` | `number` |
| `pcm_prices.billing_recurrence` | `string` |
| `pcm_prices.gpm_items` | { `id`: `string` ; `item_description`: `string` ; `item_description_i18n`: `string` \| ``null`` ; `item_key`: `string` ; `item_name`: `string` ; `item_name_i18n`: `string` \| ``null`` ; `primary_uom`: `string`  } |
| `pcm_prices.gpm_items.id` | `string` |
| `pcm_prices.gpm_items.item_description` | `string` |
| `pcm_prices.gpm_items.item_description_i18n` | `string` \| ``null`` |
| `pcm_prices.gpm_items.item_key` | `string` |
| `pcm_prices.gpm_items.item_name` | `string` |
| `pcm_prices.gpm_items.item_name_i18n` | `string` \| ``null`` |
| `pcm_prices.gpm_items.primary_uom` | `string` |
| `pcm_prices.id` | [`PRCId`](#prcid) |
| `pcm_prices.price_currency` | `string` |
| `pcm_prices.recurring_billing_interval` | `string` \| ``null`` |
| `pcm_prices.recurring_billing_interval_count` | `number` |
| `pcm_prices.recurring_billing_scheme` | `string` |
| `pcm_prices.recurring_billing_usage_type` | `string` |

___

### ProfileObject

Ƭ **ProfileObject**<`Properties`\>: `Partial`<[`CommonFields`](#commonfields)<[`NId2`](#nid2)\>\> & { `labels`: `string`[] ; `n_id`: [`NId`](#nid) ; `properties`: `Properties`  }

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

#### Type parameters

| Name | Type |
| :------ | :------ |
| `Properties` | `Json` |

___

### RealVer

Ƭ **RealVer**: `Object`

This is what @raytio/core exposes, which is more useable than [Verification](#verification)

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `belongsToNId?` | [`NId`](#nid) | nId of the PO that the verification belongs to. Could be undefined |
| `expired` | `Date` \| ``false`` | If the verification has expired, it's the date that it expired on. Otherwise it's `false` |
| `fieldName` | `string` | - |
| `metadata?` | [`VerificationPayload`](#verificationpayload)<``false``\>[``"metadata"``] | arbitary metadata returned by the verifier |
| `nID` | [`NId`](#nid) | nId of the verification |
| `provider` | [`VerificationProvider`](#verificationprovider) | - |
| `signature` | `string` | - |
| `value` | `unknown` | - |
| `verified` | `boolean` | whether the `fieldName`/`value` pair is verified, as confirmed by the API. This should be the single source of truth. |
| `xId` | `string` | this will be a unique id to group verifications from the same PO. Doesn't work yet |

___

### Relationship

Ƭ **Relationship**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `active?` | `boolean` |
| `end` | [`Urn`](#urn) |
| `end_date?` | `string` |
| `p_id` | [`PId`](#pid) |
| `properties?` | { `[fieldName: string]`: `unknown`; `name?`: `string` ; `p_id`: [`PId`](#pid)  } |
| `properties.name?` | `string` |
| `properties.p_id` | [`PId`](#pid) |
| `start` | [`Urn`](#urn) |
| `start_date?` | `string` |
| `type` | `string` |

___

### 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`](#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`](#schemaname) ; `properties`: { `[fieldName: string]`: [`SchemaField`](#schemafield);  } ; `required?`: (`string` \| [`ConditionallyRequired`](#conditionallyrequired))[] ; `start_date?`: `string` ; `timing?`: `Record`<``"extract"`` \| ``"live_person"`` \| ``"verify_pending_delay"``, `number`\> ; `type?`: [`DataTypes`](#datatypes) ; `verified_fields?`: (`string` \| [`ConditionallyRequired`](#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

| Name | Type | Description |
| :------ | :------ | :------ |
| `$id?` | `string` | **`Deprecated`** don't use, it's inconsistent |
| `$ref?` | [`SchemaName`](#schemaname) | If this field refers to a sub-object |
| `add_row_btn_label?` | `string` | if this field is a table input, this determines the text to show on the "Add Row" btn |
| `allOf?` | [{ `$ref`: `string`  }, [`ServerSchemaField`](#serverschemafield)] | - |
| `content?` | `string` | only checkbox uses this prop |
| `contentEncoding?` | ``"base64"`` | - |
| `contentMediaType?` | `string` | - |
| `content_source?` | `string` | determines where an image is sourced from |
| `default?` | `unknown` | the default value |
| `default_signature_name?` | `string` | used on fields that are a signature file picker, see !849 also used to determine if the MediaPicker should be shown inline |
| `description?` | `string` | - |
| `description_decorator?` | ``"md"`` | specifies that the description is formatted in markdown |
| `encrypt?` | `boolean` | whether the field should be encrypted |
| `encrypt_require?` | `boolean` | if true, the user must have encryption enabled to save this data, see #1324 |
| `enum?` | (`string` \| `number` \| `boolean`)[] | - |
| `examples?` | `unknown`[] | - |
| `foreign_key_of?` | [`SchemaName`](#schemaname) | if this field is a foreign key, i.e. it is a primary key of a different schema, then that other's schema name should be listed here. e.g. ```json { "name": "ss_AA", "properties": { "org_id": { "foreign_key_of": "ss_Org" } } } ``` |
| `format?` | ``"date"`` \| ``"date-time"`` \| ``"uri"`` | - |
| `hash_inputs?` | `string` | the input string for a platform_unique_id |
| `image_silhouette?` | `string` | If this schema requires a photo of a document, you can specify a URL to a silhouette image which will be overlaid on top of the camera. For best results, the image should have a transparent background + minimal white foreground |
| `items?` | { `properties`: { `[subFieldName: string]`: [`SchemaField`](#schemafield);  } ; `type`: [`DataTypes`](#datatypes)  } | `items` is used for nested arrays, (while `properties` is used for nested objects) |
| `items.properties` | { `[subFieldName: string]`: [`SchemaField`](#schemafield);  } | - |
| `items.type` | [`DataTypes`](#datatypes) | - |
| `lookup?` | `string` | URL to a JSON file in the `Lookup` format |
| `maxLength?` | `number` | **`Deprecated`** raytio's usage not documented |
| `maximum?` | `number` | for number inputs, the maximum allowed value |
| `minLength?` | `number` | **`Deprecated`** raytio's usage not documented |
| `minimum?` | `number` | for number inputs, the minimum allowed value |
| `override?` | { `permissions`: { `default`: `string`  }  } | - |
| `override.permissions` | { `default`: `string`  } | - |
| `override.permissions.default` | `string` | ideally this could be typed as `keyof typeof GROUPS` but the schemas aren't consistent and we have to assume it could be invalid. |
| `pattern?` | `string` | - |
| `patternMessage?` | `string` | if a `pattern` is specified, this is the error message |
| `priority?` | `number` | - |
| `properties?` | { `[subFieldName: string]`: [`SchemaField`](#schemafield);  } | `properties` is used for nested objects, (while `items` is used for nested arrays) |
| `readOnly?` | `boolean` | readOnly means the Wizard won't show this field |
| `step?` | `number` | for number inputs, the step size used in the input or slider |
| `table_empty_message?` | `string` | if this field is a table input, this determines the text to show if the table is empty |
| `tags?` | [`SchemaFieldTag`](#schemafieldtag)[] | - |
| `title?` | `string` | - |
| `title_plural?` | `string` | - |
| `type?` | [`DataTypes`](#datatypes) | - |

___

### 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](#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`](#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`](#commonfields)<[`SId`](#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`](#commonfields)<[`SLId`](#slid)\> & { `billing_subscription_id`: [`SId`](#sid) ; `metadata`: `string` \| ``null`` ; `price_id`: [`PRCId`](#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

| Name | Type |
| :------ | :------ |
| `breakdown` | { `[category: string]`: { `code?`: `number` ; `passed`: `boolean` ; `reason?`: `string` ; `severity?`: ``"low"`` \| ``"medium"`` \| ``"high"``  };  } |
| `score` | `number` |
| `warning?` | `string`[] |

___

### Verification

Ƭ **Verification**<`WithValue`\>: [`ProfileObject`](#profileobject)<{ `field`: `string` ; `n_id`: [`NId`](#nid) ; `valid_until?`: `string` ; `verifications`: [{ `data`: [`VerificationPayload`](#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

| Name | Type |
| :------ | :------ |
| `WithValue` | extends `boolean` = ``false`` |

___

### VerificationPayload

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

#### Type parameters

| Name | Type |
| :------ | :------ |
| `WithValue` | extends `boolean` |

___

### VerificationProvider

Ƭ **VerificationProvider**: `Object`

These `n_id`s point to service provider profile objects

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `dataSourceNId?` | [`NId`](#nid) | - |
| `date?` | `Date` | the date which the verification was verified on, or last re-verified on |
| `serviceProviderNId?` | [`NId`](#nid) | - |
| `verificationTypeId?` | [`GPMId`](#gpmid) | - |
| `verifierNId?` | [`NId`](#nid) | - |

___

### VerificationType

Ƭ **VerificationType**: [`CommonFields`](#commonfields)<[`GPMId`](#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](#webhook)

___

### WSId

Ƭ **WSId**: `StringWithIdentity`<``"WSId"``\>

A `ws_id` is the ID of a transition

___

### Webhook

Ƭ **Webhook**: `Object`

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `date_created` | `string` | ISO Date |
| `date_updated` | `string` | ISO Date |
| `provider_signature_check_enabled` | `boolean` | - |
| `provider_signature_credentials` | `unknown` | - |
| `provider_subscription_credentials` | `unknown` | - |
| `provider_webhook_id` | [`NId`](#nid) | n_id of "the webhook provider which can be set up against a service provider" |
| `provider_webhook_subscription_id` | [`NId`](#nid) | not sure what this is |
| `status` | [`WebhookStatus`](#webhookstatus) | - |
| `subscribe_log?` | { `date`: `string` ; `response_payload`: `Json` ; `response_status_code`: `number`  }[] | - |
| `webhook_action` | { `webhook_action_type`: `string`  }[] | - |
| `webhook_field_mapping_schema` | { `[key: string]`: `string`;  } | - |
| `webhook_filter_schema` | { `field_name`: `string` ; `field_value`: `string` ; `operator`: `string`  } | - |
| `webhook_filter_schema.field_name` | `string` | - |
| `webhook_filter_schema.field_value` | `string` | - |
| `webhook_filter_schema.operator` | `string` | - |
| `webhook_filter_source` | `string` | - |
| `webhook_processing_rules` | `unknown` | - |
| `wi_id` | [`WId`](#wid) | - |

___

### 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

| Name | Type | Description |
| :------ | :------ | :------ |
| `a_id` | [`AId`](#aid) | - |
| `display_sharing_preview?` | `boolean` | If this value is true, the form will display some data sharing information before the form (WizardPreview) |
| `emails?` | `string`[] | if specified, the email addresses that a submission should be sent to |
| `expiry_date?` | `number` | number of days in the future |
| `pages` | [`WizardPage`](#wizardpage)[] | - |
| `quick_onboard?` | `boolean` | whether the passwordless-signup process should be used if the user visits this form, and they are not logged in. If false, the standard sign-up process will be used |
| `reference?` | `string` | - |
| `relationships?` | { `from`: `string` ; `properties?`: `Record`<`string`, `any`\> ; `to`: `string` ; `type`: `string`  }[] | a list of relationships that should be created after the wizard completes (see #987) |
| `return_to?` | `string` | the callback url to redirect to once complete. Must be in the AA's list of authorized callback urls |
| `review_text?` | `string` | the text on the WizardReview page |
| `sharing_data_message?` | `string` | the loading message to show next to the spinner after the review screen |
| `signature_schema?` | [`SchemaName`](#schemaname) | if specified, a Wizard will be shown on the review page with this schema |
| `skip_share?` | `boolean` | **`Deprecated`** added in !244 but never used |
| `submit_text?` | `string` | the submit button label |
| `terms_schema?` | [`SchemaName`](#schemaname) | if specified, a Wizard will be shown on the review page with this schema |
| `update_reference?` | `boolean` | whether the user can change the reference, if there is one in the QP |
| `webauthn_type?` | (``"usb"`` \| ``"nfc"`` \| ``"ble"`` \| ``"internal"``)[] | if specified, the user must validate their WebAuthN credential before they can submit the form |

___

### WizardPage

Ƭ **WizardPage**: `Object`

configuration data for a single wizard page ([WizardConfig](#wizardconfig))

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `allow_upload?` | `boolean` | do not allow uploading in ImageDynamicSection if this is explictly false |
| `branching_rule_name?` | `string` | If specified, this is is a "Conditional Wizard Page", which is only shown if the rule passed. This field contains the ID (not name) of the rule. |
| `create_new_text?` | `string` | custom text to display on the Create New button |
| `description?` | `string` | the fallback description, if there isn't one for the specific situation |
| `description_create?` | `string` | - |
| `description_select?` | `string` | - |
| `description_update?` | `string` | - |
| `display_field_description?` | `boolean` | whether the field descriptions should be shown |
| `display_field_title?` | `boolean` | whether the field titles should be shown |
| `display_mode?` | ``"light"`` \| ``"dark"`` \| ``"default"`` | can you force the colour theme to change for just one page (#1066, #1074). At the moment this on pages that use WebcamImageCapture |
| `display_schema_description?` | `boolean` | whether the schema description should be shown |
| `extract_threshold?` | `number` | for ImageDynamicSection, the minimum score to be treated as a pass |
| `extract_threshold_fail_action?` | ``"capture"`` \| ``"capture_review"`` \| ``"recapture_or_next_step"`` \| ``"review"`` \| ``"next_step"`` | for ImageDynamicSection, the action to take if pre-verify fails |
| `extract_threshold_null_action?` | [`WizardPage`](#wizardpage)[``"extract_threshold_fail_action"``] | for ImageDynamicSection, the action to take if the API returns no `validation: {}` object |
| `extract_threshold_pass_action?` | ``"review"`` \| ``"next_step"`` | for ImageDynamicSection, the action to take if pre-verify passes |
| `field_list?` | `string`[] | if supplied, only the fields that are listed should be shared (#520, #1024) |
| `filter` | ``"oneOf"`` \| ``"anyOf"`` | - |
| `multiple?` | `boolean` | if true mulitple POs can be shared |
| `name?` | `string` \| `symbol` | if undefined, the schema title will be used |
| `optional?` | `boolean` | if true this page can be skipped. The PageResult wil be undefined |
| `optional_fields?` | `string`[] | a list of fields that should not be required, even if the schema says they're required |
| `profile?` | `boolean` | if explictly == false, then it's an AO (not a PO), in which case there can only be one schema |
| `reverify_header?` | `string` | custom text & header that's displayed on reverfication modal for expired PO |
| `reverify_text?` | `string` | - |
| `schemas` | [`SchemaName`](#schemaname)[] | - |
| `selection_hierarchy_json?` | `string` | a URL to a preset for configuing NestedSchemaSelect. DeepConfig |
| `service_provider_link?` | `boolean` | see #463 |
| `share?` | ``"profile"`` \| ``"verification"`` \| ``"both"`` | the information to share. undefined implies both. |
| `tags?` | [`WizardPageTag`](#wizardpagetag)[] | - |
| `verify_data?` | `boolean` | if `false`, ProfileObjects created while completing the form will not be verified. if `true`, you can only select ProfileObjects that are partially or fully verified. `undefined` implies `true`. **`Default`** ```ts true ``` |

___

### WizardPageTag

Ƭ **WizardPageTag**: ``"action:require_chip"``

___

### WrappedSchema

Ƭ **WrappedSchema**: `Object`

This is what's returned by the API

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `active` | ``true`` | - |
| `end_date` | `string` | ISO Date. If this tag exists, the schema is deprecated. |
| `schema` | [`CommonSchemaAttributes`](#commonschemaattributes) & { `$id?`: `string` ; `$schema?`: `string` ; `allOf?`: { `$ref?`: `string` ; `if?`: `Partial`<[`WrappedSchema`](#wrappedschema)[``"schema"``]\> ; `then?`: `Partial`<[`WrappedSchema`](#wrappedschema)[``"schema"``]\>  }[] ; `definitions?`: `Record`<`string`, { `$ref`: [`Urn`](#urn)  }\> ; `properties`: { `[fieldName: string]`: [`ServerSchemaField`](#serverschemafield);  } ; `required?`: `string`[] ; `verified_fields?`: `string`[]  } | - |
| `schema_name` | [`SchemaName`](#schemaname) | Schema Name Type and Version Properties |
| `schema_type` | [`SchemaType`](#schematype) | - |
| `schema_version` | `string` | - |
| `start_date` | `string` | ISO Date |
| `version_current` | `boolean` | whether the `version` is the latest version |