@raytio/types 8.0.0 → 8.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +215 -51
- package/dist/authz.d.ts +4 -0
- package/dist/authz.js +2 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +2 -0
- package/dist/raytio.d.ts +80 -28
- package/dist/schema.d.ts +211 -38
- package/dist/subscription.d.ts +1 -0
- package/dist/tenant.d.ts +6 -0
- package/dist/tenant.js +2 -0
- package/dist/theme.d.ts +4 -0
- package/dist/verification.d.ts +9 -8
- package/dist/wizard.d.ts +37 -2
- package/package.json +2 -2
- package/src/authz.ts +13 -0
- package/src/index.ts +2 -0
- package/src/raytio.ts +98 -35
- package/src/schema.ts +261 -39
- package/src/subscription.ts +1 -0
- package/src/tenant.ts +7 -0
- package/src/theme.ts +4 -0
- package/src/verification.ts +9 -7
- package/src/wizard.ts +44 -2
package/README.md
CHANGED
|
@@ -35,12 +35,21 @@ Hovering over the type in VSCode will display documentation and available proper
|
|
|
35
35
|
### Type Aliases
|
|
36
36
|
|
|
37
37
|
- [AA](#aa)
|
|
38
|
+
- [AAObject](#aaobject)
|
|
38
39
|
- [AATag](#aatag)
|
|
40
|
+
- [AINId](#ainid)
|
|
41
|
+
- [AINKId](#ainkid)
|
|
39
42
|
- [AId](#aid)
|
|
43
|
+
- [AOId](#aoid)
|
|
44
|
+
- [AuthzObjectType](#authzobjecttype)
|
|
45
|
+
- [AuthzRelation](#authzrelation)
|
|
46
|
+
- [AuthzSubjectType](#authzsubjecttype)
|
|
47
|
+
- [BId](#bid)
|
|
40
48
|
- [CId](#cid)
|
|
41
49
|
- [Colors](#colors)
|
|
42
50
|
- [CommonFields](#commonfields)
|
|
43
51
|
- [CommonSchemaAttributes](#commonschemaattributes)
|
|
52
|
+
- [ConditionalTags](#conditionaltags)
|
|
44
53
|
- [ConditionallyRequired](#conditionallyrequired)
|
|
45
54
|
- [ContactPoint](#contactpoint)
|
|
46
55
|
- [ContentUrl](#contenturl)
|
|
@@ -51,10 +60,14 @@ Hovering over the type in VSCode will display documentation and available proper
|
|
|
51
60
|
- [CustomerUser](#customeruser)
|
|
52
61
|
- [DataTypes](#datatypes)
|
|
53
62
|
- [Encrypted](#encrypted)
|
|
63
|
+
- [FndI18nEntry](#fndi18nentry)
|
|
54
64
|
- [GId](#gid)
|
|
55
65
|
- [GPMId](#gpmid)
|
|
66
|
+
- [GroupName](#groupname)
|
|
56
67
|
- [IId](#iid)
|
|
57
68
|
- [Instance](#instance)
|
|
69
|
+
- [InstanceNode](#instancenode)
|
|
70
|
+
- [InstanceNodeKey](#instancenodekey)
|
|
58
71
|
- [InstanceWithoutData](#instancewithoutdata)
|
|
59
72
|
- [KId](#kid)
|
|
60
73
|
- [LId](#lid)
|
|
@@ -86,6 +99,7 @@ Hovering over the type in VSCode will display documentation and available proper
|
|
|
86
99
|
- [PartySite](#partysite)
|
|
87
100
|
- [PaymentMethod](#paymentmethod)
|
|
88
101
|
- [PaymentProcessor](#paymentprocessor)
|
|
102
|
+
- [Permission](#permission)
|
|
89
103
|
- [PermissionType](#permissiontype)
|
|
90
104
|
- [PriceList](#pricelist)
|
|
91
105
|
- [PriceListLine](#pricelistline)
|
|
@@ -105,6 +119,8 @@ Hovering over the type in VSCode will display documentation and available proper
|
|
|
105
119
|
- [Subscription](#subscription)
|
|
106
120
|
- [SubscriptionLine](#subscriptionline)
|
|
107
121
|
- [TId](#tid)
|
|
122
|
+
- [TNTId](#tntid)
|
|
123
|
+
- [Tenant](#tenant)
|
|
108
124
|
- [UId](#uid)
|
|
109
125
|
- [Urn](#urn)
|
|
110
126
|
- [UrnNodeType](#urnnodetype)
|
|
@@ -138,11 +154,13 @@ Hovering over the type in VSCode will display documentation and available proper
|
|
|
138
154
|
| `active?` | `boolean` | - |
|
|
139
155
|
| `auth_list_enabled?` | `boolean` | if true, only specific email addresses can submit the form |
|
|
140
156
|
| `callback_uri?` | `string`[] | - |
|
|
157
|
+
| `client_challenge_type?` | ``"turnstile"`` \| ``null`` | Bot protection challenge type. If set, users must complete a challenge before accessing the wizard. |
|
|
141
158
|
| `customer_id` | [`CId`](#cid) | - |
|
|
142
159
|
| `description?` | `string` | - |
|
|
143
160
|
| `end_date?` | `Date` | - |
|
|
144
161
|
| `key?` | `string` | - |
|
|
145
162
|
| `logout_uri?` | `string`[] | - |
|
|
163
|
+
| `merchant_id?` | [`MId`](#mid) | the id of the associated merchant (replaces service_provider_n_id) |
|
|
146
164
|
| `metadata?` | `unknown` | - |
|
|
147
165
|
| `name` | `string` | - |
|
|
148
166
|
| `org_id?` | [`OId`](#oid) | the id of the associated organization |
|
|
@@ -151,7 +169,7 @@ Hovering over the type in VSCode will display documentation and available proper
|
|
|
151
169
|
| `ruleset?` | `unknown` | configuration for the submission rules |
|
|
152
170
|
| `scopes?` | `string`[] | - |
|
|
153
171
|
| `secret?` | `unknown` | - |
|
|
154
|
-
| `service_provider_n_id?` | [`NId`](#nid) |
|
|
172
|
+
| `service_provider_n_id?` | [`NId`](#nid) | **`Deprecated`** use merchant_id instead |
|
|
155
173
|
| `start_date?` | `Date` | Currently Unused Attributes |
|
|
156
174
|
| `tags?` | [`AATag`](#aatag)[] | - |
|
|
157
175
|
| `theme?` | { `colors?`: [`Colors`](#colors) ; `font?`: [`CustomFonts`](#customfonts) } | - |
|
|
@@ -160,9 +178,31 @@ Hovering over the type in VSCode will display documentation and available proper
|
|
|
160
178
|
|
|
161
179
|
___
|
|
162
180
|
|
|
181
|
+
### AAObject
|
|
182
|
+
|
|
183
|
+
Ƭ **AAObject**: [`CommonFields`](#commonfields)<[`AOId`](#aoid)\> & { `aa_id`: [`AId`](#aid) ; `aai_id`: [`IId`](#iid) ; `labels`: `string`[] ; `properties`: `Json` }
|
|
184
|
+
|
|
185
|
+
___
|
|
186
|
+
|
|
163
187
|
### AATag
|
|
164
188
|
|
|
165
|
-
Ƭ **AATag**: ``"type:client_only"`` \| ``"type:share_with_new_user"`` \|
|
|
189
|
+
Ƭ **AATag**: ``"type:client_only"`` \| ``"type:share_with_new_user"`` \| ``"Merchant"``
|
|
190
|
+
|
|
191
|
+
___
|
|
192
|
+
|
|
193
|
+
### AINId
|
|
194
|
+
|
|
195
|
+
Ƭ **AINId**: `StringWithIdentity`<``"AINId"``\>
|
|
196
|
+
|
|
197
|
+
A `aain_id` is the ID of an Instance Node
|
|
198
|
+
|
|
199
|
+
___
|
|
200
|
+
|
|
201
|
+
### AINKId
|
|
202
|
+
|
|
203
|
+
Ƭ **AINKId**: `StringWithIdentity`<``"AINKId"``\>
|
|
204
|
+
|
|
205
|
+
A `aaink_id` is the ID of an Instance Node Key
|
|
166
206
|
|
|
167
207
|
___
|
|
168
208
|
|
|
@@ -174,6 +214,42 @@ An `a_id` is the ID of an [AA](#aa)
|
|
|
174
214
|
|
|
175
215
|
___
|
|
176
216
|
|
|
217
|
+
### AOId
|
|
218
|
+
|
|
219
|
+
Ƭ **AOId**: `StringWithIdentity`<``"AOId"``\>
|
|
220
|
+
|
|
221
|
+
An `ao_id` is the ID of an [AAObject](#aaobject)
|
|
222
|
+
|
|
223
|
+
___
|
|
224
|
+
|
|
225
|
+
### AuthzObjectType
|
|
226
|
+
|
|
227
|
+
Ƭ **AuthzObjectType**: ``"dsm_node"`` \| ``"dsm_access_application"`` \| ``"dsm_access_application_instance"`` \| ``"dsm_link"`` \| ``"dsm_public_profile"`` \| ``"far_customer"`` \| ``"group"``
|
|
228
|
+
|
|
229
|
+
___
|
|
230
|
+
|
|
231
|
+
### AuthzRelation
|
|
232
|
+
|
|
233
|
+
Ƭ **AuthzRelation**: ``"viewer"`` \| ``"editor"`` \| ``"admin"`` \| ``"owner"`` \| ``"member"``
|
|
234
|
+
|
|
235
|
+
Relation types used by the new authz tuple system
|
|
236
|
+
|
|
237
|
+
___
|
|
238
|
+
|
|
239
|
+
### AuthzSubjectType
|
|
240
|
+
|
|
241
|
+
Ƭ **AuthzSubjectType**: ``"user"`` \| ``"group"``
|
|
242
|
+
|
|
243
|
+
___
|
|
244
|
+
|
|
245
|
+
### BId
|
|
246
|
+
|
|
247
|
+
Ƭ **BId**: `StringWithIdentity`<``"BId"``\>
|
|
248
|
+
|
|
249
|
+
A `b_id` is the ID of a badge definition
|
|
250
|
+
|
|
251
|
+
___
|
|
252
|
+
|
|
177
253
|
### CId
|
|
178
254
|
|
|
179
255
|
Ƭ **CId**: `StringWithIdentity`<``"CId"``\>
|
|
@@ -190,11 +266,15 @@ ___
|
|
|
190
266
|
|
|
191
267
|
| Name | Type | Description |
|
|
192
268
|
| :------ | :------ | :------ |
|
|
269
|
+
| `altColoursBgLight` | `string` | - |
|
|
270
|
+
| `altColoursBgMedium` | `string` | - |
|
|
193
271
|
| `blank` | `string` | - |
|
|
194
272
|
| `climaterolText` | `string` | - |
|
|
195
273
|
| `climaterolUi` | `string` | - |
|
|
274
|
+
| `elevatedSurface` | `string` | - |
|
|
196
275
|
| `errorRed` | `string` | - |
|
|
197
276
|
| `feelingHugged` | `string` | - |
|
|
277
|
+
| `fillNeutral` | `string` | - |
|
|
198
278
|
| `loadingYellow` | `string` | - |
|
|
199
279
|
| `poolblueText` | `string` | - |
|
|
200
280
|
| `poolblueUi` | `string` | - |
|
|
@@ -265,33 +345,64 @@ not exported. Attributes that are identical in both client schema & server schem
|
|
|
265
345
|
| Name | Type | Description |
|
|
266
346
|
| :------ | :------ | :------ |
|
|
267
347
|
| `description` | `string` | - |
|
|
268
|
-
| `description_decorator?` | ``"md"`` |
|
|
269
|
-
| `display?` | { `compact_table?`: `boolean` ; `expand?`: { `fields`: `string`[] ; `label`: `string` }[] ; `head_main?`: { `fields`: `string`[] ; `format?`: `string` } ; `head_sub?`: { `fields`: `string`[] ; `format?`: `string` } ; `tabular?`: { `fields`: `string`[] } } | - |
|
|
348
|
+
| `description_decorator?` | ``"md"`` | **`Deprecated`** Markdown is now rendered by default for all descriptions. This property is no longer needed. |
|
|
349
|
+
| `display?` | { `compact_table?`: `boolean` ; `expand?`: { `fields`: `string`[] ; `label`: `string` }[] ; `filters?`: { `name`: `string` ; `operation`: ``"and"`` \| ``"or"`` ; `tokens`: { `operator`: `string` ; `propertyKey`: `string` ; `value`: `string` }[] }[] ; `head_main?`: { `fields`: `string`[] ; `format?`: `string` } ; `head_sub?`: { `fields`: `string`[] ; `format?`: `string` } ; `kanban?`: { `card_fields?`: `string`[] ; `column_field?`: `string` ; `title_field?`: `string` } ; `tabular?`: { `fields`: `string`[] } } | - |
|
|
270
350
|
| `display.compact_table?` | `boolean` | determines if profile pages should display using compacted 'MiniPO' view or deafult view |
|
|
271
351
|
| `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 |
|
|
352
|
+
| `display.filters?` | { `name`: `string` ; `operation`: ``"and"`` \| ``"or"`` ; `tokens`: { `operator`: `string` ; `propertyKey`: `string` ; `value`: `string` }[] }[] | Pre-defined filter presets provided by the schema author. These appear as "Default filters" in the admin table UI and cannot be deleted by users (unlike user-saved filters). Each token's `propertyKey` must match a key in `properties`. Valid operators: `=`, `!=`, `:`, `!:`, `>`, `<`, `>=`, `<=` |
|
|
272
353
|
| `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 |
|
|
273
354
|
| `display.head_main.fields` | `string`[] | - |
|
|
274
355
|
| `display.head_main.format?` | `string` | - |
|
|
275
356
|
| `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 |
|
|
276
357
|
| `display.head_sub.fields` | `string`[] | - |
|
|
277
358
|
| `display.head_sub.format?` | `string` | - |
|
|
359
|
+
| `display.kanban?` | { `card_fields?`: `string`[] ; `column_field?`: `string` ; `title_field?`: `string` } | Kanban board configuration for admin dashboard |
|
|
360
|
+
| `display.kanban.card_fields?` | `string`[] | Additional fields displayed on each card |
|
|
361
|
+
| `display.kanban.column_field?` | `string` | Field that determines which column a card belongs to |
|
|
362
|
+
| `display.kanban.title_field?` | `string` | Field displayed as the card title |
|
|
278
363
|
| `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. |
|
|
279
364
|
| `display.tabular.fields` | `string`[] | - |
|
|
280
365
|
| `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` } }; } | - |
|
|
281
|
-
| `onboard_properties?` | { `
|
|
282
|
-
| `onboard_properties.
|
|
283
|
-
| `onboard_properties.
|
|
284
|
-
| `onboard_properties.
|
|
366
|
+
| `onboard_properties?` | { `[namespace: string]`: { `[version: string]`: { `[endpoint: string]`: `Record`<`string`, `unknown`\>[] \| `undefined`; } \| `undefined`; } \| `object` \| `string`[] \| `string` \| `undefined`; `actions?`: { `[key: string]`: `any`; `create_access_application_link?`: { `properties`: `Record`<`string`, `unknown`\> ; `store_as?`: `string` }[] ; `create_organization?`: { `properties`: `Json` ; `store_as?`: `string` }[] } ; `db?`: { `[version: string]`: { `[endpoint: string]`: `Record`<`string`, `unknown`\>[] \| `undefined`; } \| `undefined`; `v1?`: { `[endpoint: string]`: `Record`<`string`, `unknown`\>[] \| `undefined`; `dsm_access_applications?`: `Omit`<[`AA`](#aa), ``"org_id"`` \| ``"a_id"``\> & { `links?`: { `description`: `string` ; `wizardConfig`: `Omit`<[`WizardConfig`](#wizardconfig), ``"a_id"``\> }[] ; `org_id?`: `string` }[] ; `dsm_node_relationships?`: { `from`: `string` ; `properties?`: `Record`<`string`, `unknown`\> ; `to`: `string` ; `type`: `string` }[] ; `dsm_nodes?`: { `labels?`: `string`[] ; `properties`: `Record`<`string`, `unknown`\> ; `schema_name?`: [`SchemaName`](#schemaname) }[] ; `xrm_merchants?`: `Record`<`string`, `unknown`\>[] } ; `v2?`: { `[endpoint: string]`: `Record`<`string`, `unknown`\>[] \| `undefined`; } } ; `execution_order?`: `string`[] ; `return_to?`: `string` } | only the schema used for the onboarding wizard have this property |
|
|
367
|
+
| `onboard_properties.actions?` | { `[key: string]`: `any`; `create_access_application_link?`: { `properties`: `Record`<`string`, `unknown`\> ; `store_as?`: `string` }[] ; `create_organization?`: { `properties`: `Json` ; `store_as?`: `string` }[] } | High-level actions for complex workflows. create_organization: Single object for creating one organization create_access_application_link: Array for creating multiple links |
|
|
368
|
+
| `onboard_properties.actions.create_access_application_link?` | { `properties`: `Record`<`string`, `unknown`\> ; `store_as?`: `string` }[] | Creates access application links (can be multiple) |
|
|
369
|
+
| `onboard_properties.actions.create_organization?` | { `properties`: `Json` ; `store_as?`: `string` }[] | Creates a single organization. Use this instead of legacy 'organizations' array. |
|
|
370
|
+
| `onboard_properties.db?` | { `[version: string]`: { `[endpoint: string]`: `Record`<`string`, `unknown`\>[] \| `undefined`; } \| `undefined`; `v1?`: { `[endpoint: string]`: `Record`<`string`, `unknown`\>[] \| `undefined`; `dsm_access_applications?`: `Omit`<[`AA`](#aa), ``"org_id"`` \| ``"a_id"``\> & { `links?`: { `description`: `string` ; `wizardConfig`: `Omit`<[`WizardConfig`](#wizardconfig), ``"a_id"``\> }[] ; `org_id?`: `string` }[] ; `dsm_node_relationships?`: { `from`: `string` ; `properties?`: `Record`<`string`, `unknown`\> ; `to`: `string` ; `type`: `string` }[] ; `dsm_nodes?`: { `labels?`: `string`[] ; `properties`: `Record`<`string`, `unknown`\> ; `schema_name?`: [`SchemaName`](#schemaname) }[] ; `xrm_merchants?`: `Record`<`string`, `unknown`\>[] } ; `v2?`: { `[endpoint: string]`: `Record`<`string`, `unknown`\>[] \| `undefined`; } } | Generic API endpoints organized by namespace and version. Structure: `{namespace}.{version}.{endpoint_name}` → `POST /{namespace}/{version}/{endpoint_name}` Examples: - `db.v1.xrm_merchants` → `POST /db/v1/xrm_merchants` - `db.v2.something` → `POST /db/v2/something` - `persist.v2.endpoint` → `POST /persist/v2/endpoint` Any namespace can be used. The `db` namespace is shown below as the primary example. |
|
|
371
|
+
| `onboard_properties.db.v1?` | { `[endpoint: string]`: `Record`<`string`, `unknown`\>[] \| `undefined`; `dsm_access_applications?`: `Omit`<[`AA`](#aa), ``"org_id"`` \| ``"a_id"``\> & { `links?`: { `description`: `string` ; `wizardConfig`: `Omit`<[`WizardConfig`](#wizardconfig), ``"a_id"``\> }[] ; `org_id?`: `string` }[] ; `dsm_node_relationships?`: { `from`: `string` ; `properties?`: `Record`<`string`, `unknown`\> ; `to`: `string` ; `type`: `string` }[] ; `dsm_nodes?`: { `labels?`: `string`[] ; `properties`: `Record`<`string`, `unknown`\> ; `schema_name?`: [`SchemaName`](#schemaname) }[] ; `xrm_merchants?`: `Record`<`string`, `unknown`\>[] } | - |
|
|
372
|
+
| `onboard_properties.db.v1.dsm_access_applications?` | `Omit`<[`AA`](#aa), ``"org_id"`` \| ``"a_id"``\> & { `links?`: { `description`: `string` ; `wizardConfig`: `Omit`<[`WizardConfig`](#wizardconfig), ``"a_id"``\> }[] ; `org_id?`: `string` }[] | Access Applications - POST /db/v1/dsm_access_applications |
|
|
373
|
+
| `onboard_properties.db.v1.dsm_node_relationships?` | { `from`: `string` ; `properties?`: `Record`<`string`, `unknown`\> ; `to`: `string` ; `type`: `string` }[] | Relationships - POST /db/v1/dsm_node_relationships |
|
|
374
|
+
| `onboard_properties.db.v1.dsm_nodes?` | { `labels?`: `string`[] ; `properties`: `Record`<`string`, `unknown`\> ; `schema_name?`: [`SchemaName`](#schemaname) }[] | Profile objects - POST /db/v1/dsm_nodes |
|
|
375
|
+
| `onboard_properties.db.v1.xrm_merchants?` | `Record`<`string`, `unknown`\>[] | Merchants - POST /db/v1/xrm_merchants |
|
|
376
|
+
| `onboard_properties.db.v2?` | { `[endpoint: string]`: `Record`<`string`, `unknown`\>[] \| `undefined`; } | - |
|
|
377
|
+
| `onboard_properties.execution_order?` | `string`[] | Execution order for entity creation. If not specified, uses default order. Examples: ["actions.create_organization", "db.v1.xrm_merchants", "db.v1.dsm_nodes"] |
|
|
285
378
|
| `onboard_properties.return_to?` | `string` | The relative path in the client to redirect to once finished. May include variables |
|
|
286
379
|
| `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` }[] | - |
|
|
287
|
-
| `
|
|
380
|
+
| `schema_country_codes?` | `string`[] | Array of 2-character country codes that this schema is available for |
|
|
381
|
+
| `schema_group?` | `string` \| `string`[] | the group that a schema belongs to, such as "passports". This is useful for forms that accept different types of similar documents. Can be a single group (string) or multiple groups (string[]) to allow a schema to appear in multiple lists. |
|
|
288
382
|
| `schema_type?` | [`SchemaType`](#schematype) | - |
|
|
383
|
+
| `search_terms?` | `string`[] | Additional search terms to help users find schemas (e.g., ["license", "passport", "drivers license"]) |
|
|
384
|
+
| `suggest_post_create?` | [`SchemaName`](#schemaname) | if specified, suggests this onboarding scenario after creating a PO of this schema type |
|
|
289
385
|
| `tags?` | [`SchemaTag`](#schematag)[] | - |
|
|
290
386
|
| `title` | `string` | these fields will always exist on schema |
|
|
291
387
|
| `title_plural?` | `string` | plural version of the title |
|
|
292
388
|
|
|
293
389
|
___
|
|
294
390
|
|
|
391
|
+
### ConditionalTags
|
|
392
|
+
|
|
393
|
+
Ƭ **ConditionalTags**: `Object`
|
|
394
|
+
|
|
395
|
+
Schema-level conditional tags, evaluated at runtime based on form values
|
|
396
|
+
|
|
397
|
+
#### Type declaration
|
|
398
|
+
|
|
399
|
+
| Name | Type |
|
|
400
|
+
| :------ | :------ |
|
|
401
|
+
| `if` | { `[fieldName: string]`: (`string` \| `number` \| `boolean`)[]; } |
|
|
402
|
+
| `tags` | `string`[] |
|
|
403
|
+
|
|
404
|
+
___
|
|
405
|
+
|
|
295
406
|
### ConditionallyRequired
|
|
296
407
|
|
|
297
408
|
Ƭ **ConditionallyRequired**: `Object`
|
|
@@ -391,6 +502,14 @@ ___
|
|
|
391
502
|
|
|
392
503
|
___
|
|
393
504
|
|
|
505
|
+
### FndI18nEntry
|
|
506
|
+
|
|
507
|
+
Ƭ **FndI18nEntry**: [`CommonFields`](#commonfields)<`never`\> & { `category`: `string` ; `i18n_key`: `string` ; `translations`: { `[locale: string]`: { `description?`: `string` ; `title`: `string` ; `title_plural?`: `string` }; } }
|
|
508
|
+
|
|
509
|
+
An i18n entry from the fnd_i18n_entries API endpoint
|
|
510
|
+
|
|
511
|
+
___
|
|
512
|
+
|
|
394
513
|
### GId
|
|
395
514
|
|
|
396
515
|
Ƭ **GId**: `StringWithIdentity`<``"GId"``\>
|
|
@@ -407,6 +526,14 @@ A `gpm_id` is the ID of a Verification Type
|
|
|
407
526
|
|
|
408
527
|
___
|
|
409
528
|
|
|
529
|
+
### GroupName
|
|
530
|
+
|
|
531
|
+
Ƭ **GroupName**: `StringWithIdentity`<``"GroupName"``\>
|
|
532
|
+
|
|
533
|
+
a `GroupName` is the unique name of a group, often used instead of [GId](#gid)
|
|
534
|
+
|
|
535
|
+
___
|
|
536
|
+
|
|
410
537
|
### IId
|
|
411
538
|
|
|
412
539
|
Ƭ **IId**: `StringWithIdentity`<``"IId"``\>
|
|
@@ -424,9 +551,21 @@ longer does :( so `@raytio/core` reconstructs this object.
|
|
|
424
551
|
|
|
425
552
|
___
|
|
426
553
|
|
|
554
|
+
### InstanceNode
|
|
555
|
+
|
|
556
|
+
Ƭ **InstanceNode**: [`CommonFields`](#commonfields)<[`AINId`](#ainid)\> & { `aa_id`: [`AId`](#aid) ; `field_list`: `string`[] ; `n_id`: [`NId`](#nid) }
|
|
557
|
+
|
|
558
|
+
___
|
|
559
|
+
|
|
560
|
+
### InstanceNodeKey
|
|
561
|
+
|
|
562
|
+
Ƭ **InstanceNodeKey**: [`CommonFields`](#commonfields)<[`AINKId`](#ainkid)\> & { `aa_id`: [`AId`](#aid) ; `aai_id`: [`IId`](#iid) ; `aain_id`: [`AINId`](#ainid) ; `field_name`: `string` ; `key_data`: `string` }
|
|
563
|
+
|
|
564
|
+
___
|
|
565
|
+
|
|
427
566
|
### InstanceWithoutData
|
|
428
567
|
|
|
429
|
-
Ƭ **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` ; `
|
|
568
|
+
Ƭ **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` ; `merchant_id`: [`MId`](#mid) ; `platform_footer_html?`: `unknown` ; `previous_state?`: [`SubmissionStatus`](#submissionstatus) ; `reference`: `string` ; `related_offers?`: `unknown` ; `related_service_types?`: `unknown` ; `score?`: `unknown` ; `source_ip?`: `unknown` ; `state`: [`SubmissionStatus`](#submissionstatus) ; `sub_merchant_hash`: `string` ; `thread`: `string` }
|
|
430
569
|
|
|
431
570
|
___
|
|
432
571
|
|
|
@@ -493,8 +632,11 @@ ___
|
|
|
493
632
|
| :------ | :------ | :------ |
|
|
494
633
|
| `children?` | [`Lookup`](#lookup)[] | - |
|
|
495
634
|
| `description?` | `string` | - |
|
|
635
|
+
| `display_order?` | `number` | Sort order within a lookup set. NULL = unordered. |
|
|
636
|
+
| `image_src?` | `string` | Icon source in format `icon:{AntDesignIconName}` (e.g., `icon:CameraOutlined`) |
|
|
496
637
|
| `key` | `string` \| `number` | - |
|
|
497
638
|
| `label?` | `string` \| `number` | Used in Antd Cascader |
|
|
639
|
+
| `lookup_group?` | `string` | Group heading for dropdown lists (e.g., "APAC", "EMEA"). NULL = ungrouped. |
|
|
498
640
|
| `requires_2FA?` | `boolean` | used in AkahuDynamicSection only |
|
|
499
641
|
| `value` | `string` \| `number` | - |
|
|
500
642
|
|
|
@@ -699,6 +841,28 @@ ___
|
|
|
699
841
|
|
|
700
842
|
___
|
|
701
843
|
|
|
844
|
+
### Permission
|
|
845
|
+
|
|
846
|
+
Ƭ **Permission**: `Object`
|
|
847
|
+
|
|
848
|
+
#### Type declaration
|
|
849
|
+
|
|
850
|
+
| Name | Type |
|
|
851
|
+
| :------ | :------ |
|
|
852
|
+
| `group_name` | ``"ALL"`` \| ``"Public"`` \| \`sharing\|${UId}\|${UId}\` \| [`GId`](#gid) |
|
|
853
|
+
| `group_permission_type` | ``"VIEWS"`` \| ``"EDITS"`` \| ``null`` |
|
|
854
|
+
| `id` | [`NId`](#nid) |
|
|
855
|
+
| `is_owner` | `boolean` |
|
|
856
|
+
| `labels` | `string`[] |
|
|
857
|
+
| `n_id` | [`NId`](#nid) |
|
|
858
|
+
| `permission_id` | [`PId`](#pid) |
|
|
859
|
+
| `properties` | { `permissions`: `string` ; `provider_name`: `string` } |
|
|
860
|
+
| `properties.permissions` | `string` |
|
|
861
|
+
| `properties.provider_name` | `string` |
|
|
862
|
+
| `user_permission_type` | `string` \| ``null`` |
|
|
863
|
+
|
|
864
|
+
___
|
|
865
|
+
|
|
702
866
|
### PermissionType
|
|
703
867
|
|
|
704
868
|
Ƭ **PermissionType**: ``"ADMINS"`` \| ``"VIEWS"`` \| ``"EDITS"`` \| ``"OWNS"``
|
|
@@ -829,7 +993,7 @@ ___
|
|
|
829
993
|
|
|
830
994
|
### Schema
|
|
831
995
|
|
|
832
|
-
Ƭ **Schema**: [`CommonSchemaAttributes`](#commonschemaattributes) & { `clientLocale?`: `string` ; `database?`: { `primary_key`: `string` ; `table
|
|
996
|
+
Ƭ **Schema**: [`CommonSchemaAttributes`](#commonschemaattributes) & { `clientLocale?`: `string` ; `conditionalTags?`: [`ConditionalTags`](#conditionaltags)[] ; `database?`: { `method?`: ``"POST"`` \| ``"PATCH"`` \| ``"DELETE"`` ; `path?`: `string` ; `primary_key`: `string` ; `query_parameters?`: `string` ; `return_to?`: [`SchemaName`](#schemaname) ; `select?`: `string` ; `table?`: `string` } ; `end_date?`: `string` ; `groupNames?`: `Record`<`string`, `string`\> ; `group_title?`: `string` ; `groups?`: { `order?`: `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` }
|
|
833
997
|
|
|
834
998
|
Raytio's variant of JSON Schema, as used by the client. It is a modified version
|
|
835
999
|
of what the API returns.
|
|
@@ -855,7 +1019,7 @@ ___
|
|
|
855
1019
|
| `default?` | `unknown` | the default value |
|
|
856
1020
|
| `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 |
|
|
857
1021
|
| `description?` | `string` | - |
|
|
858
|
-
| `description_decorator?` | ``"md"`` |
|
|
1022
|
+
| `description_decorator?` | ``"md"`` | **`Deprecated`** Markdown is now rendered by default for all descriptions. This property is no longer needed. |
|
|
859
1023
|
| `encrypt?` | `boolean` | whether the field should be encrypted |
|
|
860
1024
|
| `encrypt_require?` | `boolean` | if true, the user must have encryption enabled to save this data, see #1324 |
|
|
861
1025
|
| `enum?` | (`string` \| `number` \| `boolean`)[] | - |
|
|
@@ -868,9 +1032,10 @@ ___
|
|
|
868
1032
|
| `items.properties` | { `[subFieldName: string]`: [`SchemaField`](#schemafield); } | - |
|
|
869
1033
|
| `items.type` | [`DataTypes`](#datatypes) | - |
|
|
870
1034
|
| `lookup?` | `string` | URL to a JSON file in the `Lookup` format |
|
|
871
|
-
| `
|
|
1035
|
+
| `lookupTransform?` | `string` \| { `key?`: `string` ; `path`: `string` ; `value?`: `string` } | Transforms the lookup response into the expected `{ key, value }[]` format. Use when the API returns data in a different structure. Simple format (extract array from path, use values as both key and value): ```json "lookupTransform": "[0].scopes" ``` Object format (specify key/value mapping): ```json "lookupTransform": { "path": "[0].items", "key": "id", "value": "name" } ``` |
|
|
1036
|
+
| `maxLength?` | `number` | for string inputs, the maximum character length. Also used to determine textarea rendering (maxLength > 30 renders a textarea) |
|
|
872
1037
|
| `maximum?` | `number` | for number inputs, the maximum allowed value |
|
|
873
|
-
| `minLength?` | `number` |
|
|
1038
|
+
| `minLength?` | `number` | for string inputs, the minimum character length. Not currently used anywhere in the client |
|
|
874
1039
|
| `minimum?` | `number` | for number inputs, the minimum allowed value |
|
|
875
1040
|
| `override?` | { `permissions`: { `default`: `string` } } | - |
|
|
876
1041
|
| `override.permissions` | { `default`: `string` } | - |
|
|
@@ -891,7 +1056,7 @@ ___
|
|
|
891
1056
|
|
|
892
1057
|
### SchemaFieldTag
|
|
893
1058
|
|
|
894
|
-
Ƭ **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"``
|
|
1059
|
+
Ƭ **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}\` \| ``"display:content-block"`` \| ``"display:info"`` \| ``"display:warning"`` \| ``"display:error"`` \| ``"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:"`` \| \`action:timeout:${number}\` \| \`action:server-search:${string}\` \| ``"verify:show_if_pending"`` \| ``"special:hide_select_behind_button"`` \| ``"type:capture_geolocation"`` \| ``"type:extract_required"``
|
|
895
1060
|
|
|
896
1061
|
___
|
|
897
1062
|
|
|
@@ -905,13 +1070,13 @@ ___
|
|
|
905
1070
|
|
|
906
1071
|
### SchemaTag
|
|
907
1072
|
|
|
908
|
-
Ƭ **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:
|
|
1073
|
+
Ƭ **SchemaTag**: ``"action:experimental_pass_object_store_id"`` \| ``"action:verify"`` \| \`action:display\_qr\_code:${string}:${string}\` \| \`action:display\_global\_idv\_app\_qr\_code:${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"`` \| ``"support_challenge"`` \| ``"type:merchant"`` \| ``"type:service_offer"`` \| ``"type:marketplace"`` \| ``"type:client_only"`` \| ``"type:globally_unique_field"`` \| ``"type:application_object"``
|
|
909
1074
|
|
|
910
1075
|
___
|
|
911
1076
|
|
|
912
1077
|
### SchemaType
|
|
913
1078
|
|
|
914
|
-
Ƭ **SchemaType**: ``"ss"`` \| ``"ps"`` \| ``"us"``
|
|
1079
|
+
Ƭ **SchemaType**: ``"ss"`` \| ``"ps"`` \| ``"us"`` \| ``"ms"``
|
|
915
1080
|
|
|
916
1081
|
Type Classification of a Schema returned by API
|
|
917
1082
|
|
|
@@ -927,13 +1092,13 @@ ___
|
|
|
927
1092
|
|
|
928
1093
|
### SubmissionStatus
|
|
929
1094
|
|
|
930
|
-
Ƭ **SubmissionStatus**: ``"Submitted"`` \| ``"Processing"`` \| ``"Rejected"`` \| ``"Expired"`` \| ``"Completed"`` \| ``"DataChanged"`` \| ``"Received"`` \| ``"Accepted"``
|
|
1095
|
+
Ƭ **SubmissionStatus**: ``"Submitted"`` \| ``"Processing"`` \| ``"Rejected"`` \| ``"Expired"`` \| ``"Completed"`` \| ``"DataChanged"`` \| ``"Received"`` \| ``"Pending"`` \| ``"Accepted"``
|
|
931
1096
|
|
|
932
1097
|
___
|
|
933
1098
|
|
|
934
1099
|
### Subscription
|
|
935
1100
|
|
|
936
|
-
Ƭ **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`` }
|
|
1101
|
+
Ƭ **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`` ; `subscription_timezone_offset_minutes`: `number` \| ``null`` }
|
|
937
1102
|
|
|
938
1103
|
___
|
|
939
1104
|
|
|
@@ -951,6 +1116,20 @@ A `t_id` is the ID of a transaction
|
|
|
951
1116
|
|
|
952
1117
|
___
|
|
953
1118
|
|
|
1119
|
+
### TNTId
|
|
1120
|
+
|
|
1121
|
+
Ƭ **TNTId**: `StringWithIdentity`<``"TNTId"``\>
|
|
1122
|
+
|
|
1123
|
+
A `tnt_id` is the ID of a Tenant
|
|
1124
|
+
|
|
1125
|
+
___
|
|
1126
|
+
|
|
1127
|
+
### Tenant
|
|
1128
|
+
|
|
1129
|
+
Ƭ **Tenant**: [`CommonFields`](#commonfields)<[`TNTId`](#tntid)\> & { `tenant_description`: `string` \| ``null`` ; `tenant_domain_prefix`: `string` \| ``null`` ; `tenant_name`: `string` }
|
|
1130
|
+
|
|
1131
|
+
___
|
|
1132
|
+
|
|
954
1133
|
### UId
|
|
955
1134
|
|
|
956
1135
|
Ƭ **UId**: `StringWithIdentity`<``"UId"``\>
|
|
@@ -1007,7 +1186,7 @@ ___
|
|
|
1007
1186
|
|
|
1008
1187
|
### VerificationPayload
|
|
1009
1188
|
|
|
1010
|
-
Ƭ **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?`: [`
|
|
1189
|
+
Ƭ **VerificationPayload**<`WithValue`\>: { `field`: `string` ; `hashed_source_n_id?`: [`NId`](#nid) ; `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?`: [`MId`](#mid) ; `verifier_service_id?`: [`MId`](#mid) ; `verifier_source_id?`: [`MId`](#mid) } & `WithValue` extends ``true`` ? { `value`: `string` \| `number` } : {}
|
|
1011
1190
|
|
|
1012
1191
|
#### Type parameters
|
|
1013
1192
|
|
|
@@ -1021,17 +1200,17 @@ ___
|
|
|
1021
1200
|
|
|
1022
1201
|
Ƭ **VerificationProvider**: `Object`
|
|
1023
1202
|
|
|
1024
|
-
These
|
|
1203
|
+
These IDs point to merchants (formerly service provider profile objects)
|
|
1025
1204
|
|
|
1026
1205
|
#### Type declaration
|
|
1027
1206
|
|
|
1028
1207
|
| Name | Type | Description |
|
|
1029
1208
|
| :------ | :------ | :------ |
|
|
1030
|
-
| `dataSourceNId?` | [`
|
|
1209
|
+
| `dataSourceNId?` | [`MId`](#mid) | - |
|
|
1031
1210
|
| `date?` | `Date` | the date which the verification was verified on, or last re-verified on |
|
|
1032
|
-
| `serviceProviderNId?` | [`
|
|
1211
|
+
| `serviceProviderNId?` | [`MId`](#mid) | - |
|
|
1033
1212
|
| `verificationTypeId?` | [`GPMId`](#gpmid) | - |
|
|
1034
|
-
| `verifierNId?` | [`
|
|
1213
|
+
| `verifierNId?` | [`MId`](#mid) | - |
|
|
1035
1214
|
|
|
1036
1215
|
___
|
|
1037
1216
|
|
|
@@ -1059,36 +1238,13 @@ ___
|
|
|
1059
1238
|
|
|
1060
1239
|
### Webhook
|
|
1061
1240
|
|
|
1062
|
-
Ƭ **Webhook**: `
|
|
1063
|
-
|
|
1064
|
-
#### Type declaration
|
|
1065
|
-
|
|
1066
|
-
| Name | Type | Description |
|
|
1067
|
-
| :------ | :------ | :------ |
|
|
1068
|
-
| `date_created` | `string` | ISO Date |
|
|
1069
|
-
| `date_updated` | `string` | ISO Date |
|
|
1070
|
-
| `provider_signature_check_enabled` | `boolean` | - |
|
|
1071
|
-
| `provider_signature_credentials` | `unknown` | - |
|
|
1072
|
-
| `provider_subscription_credentials` | `unknown` | - |
|
|
1073
|
-
| `provider_webhook_id` | [`NId`](#nid) | n_id of "the webhook provider which can be set up against a service provider" |
|
|
1074
|
-
| `provider_webhook_subscription_id` | [`NId`](#nid) | not sure what this is |
|
|
1075
|
-
| `status` | [`WebhookStatus`](#webhookstatus) | - |
|
|
1076
|
-
| `subscribe_log?` | { `date`: `string` ; `response_payload`: `Json` ; `response_status_code`: `number` }[] | - |
|
|
1077
|
-
| `webhook_action` | { `webhook_action_type`: `string` }[] | - |
|
|
1078
|
-
| `webhook_field_mapping_schema` | { `[key: string]`: `string`; } | - |
|
|
1079
|
-
| `webhook_filter_schema` | { `field_name`: `string` ; `field_value`: `string` ; `operator`: `string` } | - |
|
|
1080
|
-
| `webhook_filter_schema.field_name` | `string` | - |
|
|
1081
|
-
| `webhook_filter_schema.field_value` | `string` | - |
|
|
1082
|
-
| `webhook_filter_schema.operator` | `string` | - |
|
|
1083
|
-
| `webhook_filter_source` | `string` | - |
|
|
1084
|
-
| `webhook_processing_rules` | `unknown` | - |
|
|
1085
|
-
| `wi_id` | [`WId`](#wid) | - |
|
|
1241
|
+
Ƭ **Webhook**: [`CommonFields`](#commonfields)<[`WId`](#wid)\> & { `aa_id`: [`AId`](#aid) ; `date_created?`: `string` ; `date_updated?`: `string` ; `metadata`: `unknown` ; `provider_signature_check_enabled`: `boolean` ; `provider_signature_credentials`: `unknown` ; `provider_subscription_credentials`: `unknown` ; `provider_webhook_id`: `string` ; `provider_webhook_subscription_id`: `string` \| ``null`` ; `status`: [`WebhookStatus`](#webhookstatus) ; `subscribe_log?`: { `date`: `string` ; `response_payload`: `Json` ; `response_status_code`: `number` }[] \| ``null`` ; `webhook_action`: { `webhook_action_type`: `string` }[] \| ``null`` ; `webhook_field_mapping_schema`: { `[key: string]`: `string`; } \| ``null`` ; `webhook_filter_schema`: { `field_name`: `string` ; `field_value`: `string` ; `operator`: `string` } \| ``null`` ; `webhook_filter_source`: `string` \| ``null`` ; `webhook_processing_rules`: `unknown` ; `wi_id?`: [`WId`](#wid) }
|
|
1086
1242
|
|
|
1087
1243
|
___
|
|
1088
1244
|
|
|
1089
1245
|
### WebhookStatus
|
|
1090
1246
|
|
|
1091
|
-
Ƭ **WebhookStatus**: ``"
|
|
1247
|
+
Ƭ **WebhookStatus**: ``"PENDING"`` \| ``"SUBSCRIBED"`` \| ``"UNSUBSCRIBED"`` \| ``"UNSUBSCRIBE_FAILED"`` \| ``"ERROR"`` \| ``"ARCHIVED"``
|
|
1092
1248
|
|
|
1093
1249
|
___
|
|
1094
1250
|
|
|
@@ -1110,6 +1266,7 @@ in the query parameters, it needs to be base64 and/or url encoded.
|
|
|
1110
1266
|
| `expiry_date?` | `number` | number of days in the future |
|
|
1111
1267
|
| `pages` | [`WizardPage`](#wizardpage)[] | - |
|
|
1112
1268
|
| `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 |
|
|
1269
|
+
| `quick_onboard_require_consent?` | `boolean` | If true, users must explicitly accept privacy terms during quick onboard. If false, the form auto-submits without user intervention. **`Default`** ```ts true ``` |
|
|
1113
1270
|
| `reference?` | `string` | - |
|
|
1114
1271
|
| `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) |
|
|
1115
1272
|
| `return_to?` | `string` | the callback url to redirect to once complete. Must be in the AA's list of authorized callback urls |
|
|
@@ -1151,18 +1308,24 @@ configuration data for a single wizard page ([WizardConfig](#wizardconfig))
|
|
|
1151
1308
|
| `extract_threshold_pass_action?` | ``"review"`` \| ``"next_step"`` | for ImageDynamicSection, the action to take if pre-verify passes |
|
|
1152
1309
|
| `field_list?` | `string`[] | if supplied, only the fields that are listed should be shared (#520, #1024) |
|
|
1153
1310
|
| `filter` | ``"oneOf"`` \| ``"anyOf"`` | - |
|
|
1311
|
+
| `is_terminal?` | `boolean` | If true, user cannot proceed past this page (error/blocking behavior) If false, user can continue to next page (informational) **`Default`** ```ts false ``` |
|
|
1312
|
+
| `merchant_link?` | `boolean` | see #463 |
|
|
1154
1313
|
| `multiple?` | `boolean` | if true mulitple POs can be shared |
|
|
1155
1314
|
| `name?` | `string` \| `symbol` | if undefined, the schema title will be used |
|
|
1156
1315
|
| `optional?` | `boolean` | if true this page can be skipped. The PageResult wil be undefined |
|
|
1157
1316
|
| `optional_fields?` | `string`[] | a list of fields that should not be required, even if the schema says they're required |
|
|
1158
|
-
| `
|
|
1317
|
+
| `page_content?` | `string` | Content to display on message pages. Supports markdown if page_content_decorator is "md" |
|
|
1318
|
+
| `page_content_decorator?` | ``"md"`` | Set to "md" to render page_content as markdown |
|
|
1319
|
+
| `page_type?` | ``"form"`` \| ``"message"`` | Page type: 'form' for data collection, 'message' for info/error display **`Default`** ```ts "form" ``` |
|
|
1320
|
+
| `profile?` | `boolean` | **`Deprecated`** - AO/PO classification is now done per-object using schema tags (type:application_object) instead of page-level profile property |
|
|
1159
1321
|
| `reverify_header?` | `string` | custom text & header that's displayed on reverfication modal for expired PO |
|
|
1160
1322
|
| `reverify_text?` | `string` | - |
|
|
1161
1323
|
| `schemas` | [`SchemaName`](#schemaname)[] | - |
|
|
1162
1324
|
| `selection_hierarchy_json?` | `string` | a URL to a preset for configuing NestedSchemaSelect. DeepConfig |
|
|
1163
|
-
| `service_provider_link?` | `boolean` | see #463 |
|
|
1164
1325
|
| `share?` | ``"profile"`` \| ``"verification"`` \| ``"both"`` | the information to share. undefined implies both. |
|
|
1165
1326
|
| `tags?` | [`WizardPageTag`](#wizardpagetag)[] | - |
|
|
1327
|
+
| `terminal_button_label?` | `string` | Label for the exit button on terminal pages **`Default`** ```ts "Home" ``` |
|
|
1328
|
+
| `terminal_button_url?` | `string` | URL to redirect to when exit button is clicked on terminal pages **`Default`** ```ts "/" or return_to from WizardConfig ``` |
|
|
1166
1329
|
| `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 ``` |
|
|
1167
1330
|
|
|
1168
1331
|
___
|
|
@@ -1186,6 +1349,7 @@ This is what's returned by the API
|
|
|
1186
1349
|
| `active` | ``true`` | - |
|
|
1187
1350
|
| `end_date` | `string` | ISO Date. If this tag exists, the schema is deprecated. |
|
|
1188
1351
|
| `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`[] } | - |
|
|
1352
|
+
| `schema_country_codes?` | `string`[] | Country codes that this schema is available for |
|
|
1189
1353
|
| `schema_name` | [`SchemaName`](#schemaname) | Schema Name Type and Version Properties |
|
|
1190
1354
|
| `schema_type` | [`SchemaType`](#schematype) | - |
|
|
1191
1355
|
| `schema_version` | `string` | - |
|
package/dist/authz.d.ts
ADDED
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
/** Relation types used by the new authz tuple system */
|
|
2
|
+
export type AuthzRelation = "viewer" | "editor" | "admin" | "owner" | "member";
|
|
3
|
+
export type AuthzSubjectType = "user" | "group";
|
|
4
|
+
export type AuthzObjectType = "dsm_node" | "dsm_access_application" | "dsm_access_application_instance" | "dsm_link" | "dsm_public_profile" | "far_customer" | "group";
|
package/dist/authz.js
ADDED
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
|
@@ -23,3 +23,5 @@ __exportStar(require("./wizard"), exports);
|
|
|
23
23
|
__exportStar(require("./orgs"), exports);
|
|
24
24
|
__exportStar(require("./subscription"), exports);
|
|
25
25
|
__exportStar(require("./merchant"), exports);
|
|
26
|
+
__exportStar(require("./tenant"), exports);
|
|
27
|
+
__exportStar(require("./authz"), exports);
|