update transaction result based on feedback

finos · Jul 6, 2022 · c1a30b8 · c1a30b8
1 parent c05af21
commit c1a30b8
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 4 deletions.
diff --git a/docs/context/ref/TransactionResult.md b/docs/context/ref/TransactionResult.md
@@ -20,9 +20,10 @@ https://fdc3.finos.org/schemas/next/transactionresult.schema.json
 
 | Property    | Type    | Required | Example Value     |
 |-------------|---------|----------|-------------------|
-| `type`      | string  | Yes      | `'fdc3.transactionResult'`  |
+| `type`      | Context  | Yes      | See Below  |
 | `status`      | string  | Yes       | `'Updated'`      |
 | `context`  | string  | Yes       | See Below |
+| `message`  | string  | No       | See Below |
 
 ## Example
 
@@ -52,6 +53,7 @@ Console log will display:
         "id": {
             "email": "jane.doe@mail.com"
         }
-    }
+    },
+    "message": "record with id jane.doe@mail.com was updated"
 }
 ```
diff --git a/src/context/ContextType.ts b/src/context/ContextType.ts
@@ -6,6 +6,7 @@ export enum ContextTypes {
   Country = 'fdc3.country',
   Currency = 'fdc3.currency',
   Email = 'fdc3.email',
+  Interaction = 'fdc3.interaction',
   Instrument = 'fdc3.instrument',
   InstrumentList = 'fdc3.instrumentList',
   Organization = 'fdc3.organization',

diff --git a/src/context/ContextTypes.ts b/src/context/ContextTypes.ts
@@ -126,6 +126,13 @@ export interface Nothing {
   type: string;
 }
 
+export interface TransactionResult {
+  status: ("Created" | "Deleted" | "Updated" | "Failed") | string; 
+  type: string;
+  context: Context;
+  message: string;
+}
+
 // Converts JSON strings to/from your types
 // and asserts the results of JSON.parse at runtime
 export class Convert {

diff --git a/src/context/schemas/transactionresult.schema.json b/src/context/schemas/transactionresult.schema.json
@@ -10,7 +10,7 @@
       "anyOf": [
         {
           "type": "string",
-          "enum": ["Created", "Deleted", "Updated"]
+          "enum": ["Created", "Deleted", "Updated", "Failed"]
         },
         {
           "type": "string"
@@ -19,5 +19,8 @@
     },
     "context": { "$ref": "context.schema.json#" }
   },
+    "message": {
+      "type": "string"
+    },
   "required": ["status", "context"]
 }
diff --git a/src/intents/Intents.ts b/src/intents/Intents.ts
@@ -1,4 +1,5 @@
 export enum Intents {
+  CreateInteraction = 'CreateInteraction',
   StartCall = 'StartCall',
   StartChat = 'StartChat',
   StartEmail = 'StartEmail',
@@ -13,5 +14,4 @@ export enum Intents {
   ViewProfile = 'ViewProfile',
   ViewQuote = 'ViewQuote',
   ViewResearch = 'ViewResearch',
-  CreateInteraction = 'CreateInteraction',
 }