@raytio/types 6.0.1 → 6.0.2

package/README.md

@@ -61,6 +61,8 @@ Hovering over the type in VSCode will display documentation and available proper
 - [Verification](#verification)
 - [VerificationPayload](#verificationpayload)
 - [VerificationProvider](#verificationprovider)
+- [WId](#wid)
+- [Webhook](#webhook)
 - [WizardConfig](#wizardconfig)
 - [WizardPage](#wizardpage)
 
@@ -111,7 +113,6 @@ ___
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `blank` | `string` | - |
-| `blankBackground` | `string` | - |
 | `climaterolText` | `string` | - |
 | `climaterolUi` | `string` | - |
 | `errorRed` | `string` | - |
@@ -229,6 +230,7 @@ ___
 | `profile_objects` | [`ProfileObject`](#profileobject)[] | data associated is access application's instance |
 | `reference` | `string` | reference provided by the user who shared the data |
 | `relationships?` | [`Relationship`](#relationship)[] | - |
+| `score?` | `unknown` | added by the client once it calculates the score |
 | `service_provider_n_id?` | [`NId`](#nid) | Service provider ID |
 | `start_date` | `string` | Earliest date on which the shared information was available |
 | `state` | [`SubmissionStatus`](#submissionstatus) | The status of a submission |
@@ -454,7 +456,7 @@ ___
 | `encrypt?` | `boolean` | whether the field should be encrypted |
 | `enum?` | `string`[] | - |
 | `examples?` | `unknown`[] | - |
-| `format?` | ``"date"`` \| ``"date-time"`` | - |
+| `format?` | ``"date"`` \| ``"date-time"`` \| ``"uri"`` | - |
 | `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?` | `Object` | `items` is used for nested arrays, (while `properties` is used for nested objects) |
 | `items.properties` | `Object` | - |
@@ -589,6 +591,38 @@ These `n_id`s point to service provider profile objects
 
 ___
 
+### WId
+
+Ƭ **WId**: `StringWithIdentity`<``"WId"``\>
+
+A `wi_id` is the ID of a @see Webhook
+
+___
+
+### Webhook
+
+Ƭ **Webhook**: `Object`
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `date_created` | `string` | ISO Date |
+| `date_updated` | `string` | ISO Date |
+| `provider_subscription_credentials` | `unknown` | - |
+| `provider_webhook_id` | [`NId`](#nid) | n_id of "the webhook provider which can be set up against a service provider" |
+| `status` | `unknown` | - |
+| `webhook_action` | { `webhook_action_type`: `string`  }[] | - |
+| `webhook_field_mapping_schema` | `Object` | - |
+| `webhook_filter_schema` | `Object` | - |
+| `webhook_filter_schema.field_name` | `string` | - |
+| `webhook_filter_schema.field_value` | `string` | - |
+| `webhook_filter_schema.operator` | `string` | - |
+| `webhook_filter_source` | `string` | - |
+| `wi_id` | [`WId`](#wid) | - |
+
+___
+
 ### WizardConfig
 
 Ƭ **WizardConfig**: `Object`

package/dist/raytio.d.ts

@@ -20,6 +20,8 @@ export declare type UId = StringWithIdentity<"UId">;
 export declare type AId = StringWithIdentity<"AId">;
 /** An `o_id` is the ID of an @see Organization */
 export declare type OId = StringWithIdentity<"OId">;
+/** A `wi_id` is the ID of a @see Webhook */
+export declare type WId = StringWithIdentity<"WId">;
 export declare type DataTypes = "string" | "number" | "boolean" | "object" | "integer" | "array" | "null";
 export declare type SubmissionStatus = "Submitted" | "Processing" | "Rejected" | "Expired" | "Completed" | "DataChanged" | "Received" | "Accepted";
 /** You can supply an option type argument if you know exactly what the properties will be */
@@ -148,6 +150,8 @@ export declare type Instance = {
         };
     };
     relationships?: Relationship[];
+    /** added by the client once it calculates the score */
+    score?: unknown;
 };
 /**
  * An organization.
@@ -183,4 +187,27 @@ export declare type Validation = {
         };
     };
 };
+export declare type Webhook = {
+    wi_id: WId;
+    /** n_id of "the webhook provider which can be set up against a service provider" */
+    provider_webhook_id: NId;
+    status: unknown;
+    /** ISO Date */
+    date_created: string;
+    /** ISO Date */
+    date_updated: string;
+    webhook_filter_schema: {
+        operator: string;
+        field_value: string;
+        field_name: string;
+    };
+    webhook_action: {
+        webhook_action_type: string;
+    }[];
+    provider_subscription_credentials: unknown;
+    webhook_filter_source: string;
+    webhook_field_mapping_schema: {
+        [key: string]: string;
+    };
+};
 export {};

package/dist/schema.d.ts

@@ -32,7 +32,7 @@ export declare type SchemaField = {
     pattern?: string;
     /** whether the field should be encrypted */
     encrypt?: boolean;
-    format?: "date" | "date-time";
+    format?: "date" | "date-time" | "uri";
     contentMediaType?: string;
     contentEncoding?: "base64";
     /** `items` is used for nested arrays, (while `properties` is used for nested objects) */

package/dist/theme.d.ts

@@ -21,7 +21,6 @@ export declare type Colors = {
     sariShade: string;
     feelingHugged: string;
     silverShell: string;
-    blankBackground: string;
     blank: string;
 };
 export declare type CustomFonts = {

package/package.json

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

package/src/raytio.ts

@@ -21,6 +21,8 @@ export type UId = StringWithIdentity<"UId">;
 export type AId = StringWithIdentity<"AId">;
 /** An `o_id` is the ID of an @see Organization */
 export type OId = StringWithIdentity<"OId">;
+/** A `wi_id` is the ID of a @see Webhook */
+export type WId = StringWithIdentity<"WId">;
 
 export type DataTypes =
   | "string"
@@ -190,6 +192,11 @@ export type Instance = {
     };
   };
   relationships?: Relationship[];
+
+  /** added by the client once it calculates the score */
+  // Defined as `unknown` instead of `ScoreResult` because it could be nonsense,
+  // or a deprected version of `ScoreResult`.
+  score?: unknown;
 };
 
 /**
@@ -227,3 +234,26 @@ export type Validation = {
     };
   };
 };
+
+export type Webhook = {
+  wi_id: WId;
+  /** n_id of "the webhook provider which can be set up against a service provider" */
+  provider_webhook_id: NId;
+  status: unknown;
+  /** ISO Date */
+  date_created: string;
+  /** ISO Date */
+  date_updated: string;
+
+  webhook_filter_schema: {
+    operator: string;
+    field_value: string;
+    field_name: string;
+  };
+  webhook_action: { webhook_action_type: string }[];
+  provider_subscription_credentials: unknown;
+  webhook_filter_source: string;
+  webhook_field_mapping_schema: {
+    [key: string]: string;
+  };
+};

package/src/schema.ts

@@ -79,7 +79,7 @@ export type SchemaField = {
   pattern?: string;
   /** whether the field should be encrypted */
   encrypt?: boolean;
-  format?: "date" | "date-time";
+  format?: "date" | "date-time" | "uri";
   contentMediaType?: string;
   contentEncoding?: "base64";
   /** `items` is used for nested arrays, (while `properties` is used for nested objects) */

package/src/theme.ts

@@ -21,7 +21,6 @@ export type Colors = {
   sariShade: string;
   feelingHugged: string;
   silverShell: string;
-  blankBackground: string;
   blank: string;
 };