592 771 context proposal TransactionResult

docs/context/ref/Contact.md

@@ -52,6 +52,7 @@ Intents
 - [ViewResearch](../../intents/ref/ViewResearch)
 - [ViewInteractions](../../intents/ref/ViewInteractions)
 - [ViewOrders](../../intents/ref/ViewOrders)
+- [CreateInteraction](../../intents/ref/CreateInteraction)
 
 FINOS Financial Objects
 - [Contact](https://fo.finos.org/docs/objects/contact)

docs/context/ref/ContactList.md

@@ -64,6 +64,7 @@ Other Types
 Intents
 - [StartChat](../../intents/ref/StartChat)
 - [StartCall](../../intents/ref/StartCall)
+- [CreateInteraction](../../intents/ref/CreateInteraction)
 
 FINOS Financial Objects
 - [ContactList](https://fo.finos.org/docs/objects/contactlist)

docs/context/ref/Interaction.md

@@ -0,0 +1,87 @@
+---
+id: Interaction
+sidebar_label: Interaction
+title: Interaction
+hide_title: true
+---
+# `Interaction`
+
+An interaction is a significant direct exchange of ideas or information between a Sell Side party and one or more Buy Side parties. An interaction might be a call, a meeting (physical or virtual), an IM or the preparation of some specialist data.
+
+Notes:
+
+- interactionType SHOULD be one of 'Instant Message', 'Email', 'Call', or 'Meeting' although other values can be provided
+- origin indicates the application or service that the interaction was created from to aid in tracing the source of the interaction
+
+## Type
+
+`fdc3.interaction`
+
+## Schema
+
+https://fdc3.finos.org/schemas/next/interaction.schema.json
+
+## Details
+
+| Property    | Type    | Required | Example Value       |
+|-------------|---------|----------|---------------------|
+| `type`      | string  | Yes      | `fdc3.interaction` |
+| `participants`      | fdc3.contactList  | Yes       | See below      |
+| `timeRange` | fdc3.timeRange  | Yes       | See below            |
+| `interactionType` | string  | Yes       | `Instant Message`            |
+| `description`    | string  | Yes       | `Blah, blah, blah`         |
+| `initiator`    | fdc3.contact  | No       | See below         |
+| `origin`    |  string  | No       | `Outlook`         |
+
+## Example
+
+```js
+const interaction = {
+    type: 'fdc3.interaction',
+    participants: {
+        type: 'fdc3.contactList',
+        contacts: [
+            {
+                type: 'fdc3.contact',
+                name: 'Jane Doe',
+                id: {
+                    email: 'jane.doe@mail.com'
+                }
+             },
+            {
+                type: 'fdc3.contact',
+                name: 'John Doe',
+                id: {
+                    email: 'john.doe@mail.com'
+                }
+            },
+        ]
+    },
+    interactionType: 'Instant Message',
+    timeRange: {
+        type: 'fdc3.timeRange',
+        startTime: '2022-02-10T15:12:00Z'
+    },
+    description: 'Laboris libero dapibus fames elit adipisicing eu, fermentum, dignissimos laboriosam, erat, risus qui deserunt. Praesentium! Reiciendis. Hic harum nostrud, harum potenti amet? Mauris. Pretium aliquid animi, eget eiusmod integer proident. Architecto ipsum blandit ducimus, possimus illum sunt illum necessitatibus ab litora sed, nonummy integer minus corrupti ducimus iste senectus accumsan, fugiat nostrud? Pede vero dictumst excepturi, iure earum consequuntur voluptatum',
+    initiator:  {
+        type: 'fdc3.contact',
+        name: 'Jane Doe',
+        id: {
+            email: 'jane.doe@mail.com'
+        }
+    },
+    origin: 'Outlook'
+}
+
+fdc3.raiseIntent('CreateInteraction', interaction)
+```
+
+## See Also
+
+Other Types
+- [Contact](Contact)
+- [ContactList](ContactList)
+- [TimeRange](TimeRange)
+
+Intents
+- [CreateInteraction](../../intents/ref/CreateInteraction)

docs/context/ref/TimeRange.md

@@ -80,3 +80,6 @@ const timeRange = {
 Other Types
 
 - [Chart](Chart)
+
+Intents
+- [CreateInteraction](../../intents/ref/CreateInteraction)

docs/context/ref/TransactionResult.md

@@ -0,0 +1,59 @@
+---
+id: TransactionResult
+sidebar_label: TransactionResult
+title: TransactionResult
+hide_title: true
+---
+# `TransactionResult`
+
+The result of any given create, update or delete intent.
+
+## Type
+
+`fdc3.transactionResult`
+
+## Schema
+
+https://fdc3.finos.org/schemas/next/transactionresult.schema.json
+
+## Details
+
+| Property    | Type    | Required | Example Value     |
+|-------------|---------|----------|-------------------|
+| `type`      | Context  | Yes      | See Below  |
+| `status`      | string  | Yes       | `'Updated'`      |
+| `context`  | string  | Yes       | See Below |
+| `message`  | string  | No       | See Below |
+
+## Example
+
+```js
+const contact = {
+    type: "fdc3.contact",
+    name: "Jane Doe",
+    id: {
+        email: "jane.doe@mail.com"
+    }
+}
+
+const resolution = await window.fdc3.raiseIntent('CreateOrUpdateProfile', contact);
+const result = await resolution.getResult();
+console.log(JSON.stringify(result));
+```
+
+Console log will display:
+
+```json
+{
+    "type": "fdc3.transactionResult",
+    "status": "Updated",
+    "context": {
+        "type": "fdc3.contact",
+        "name": "Jane Doe",
+        "id": {
+            "email": "jane.doe@mail.com"
+        }
+    },
+    "message": "record with id jane.doe@mail.com was updated"
+}
+```

docs/context/spec.md

@@ -146,13 +146,15 @@ The following are standard FDC3 context types:
 - [`fdc3.country`](ref/Country) ([schema](/schemas/next/country.schema.json))
 - [`fdc3.currency`](ref/Currency) ([schema](/schemas/next/currency.schema.json))
 - [`fdc3.email`](ref/Email) ([schema](/schemas/next/email.schema.json))
+- [`fdc3.interaction`](ref/Interaction) ([schema](/schemas/next/interaction.schema.json))
 - [`fdc3.instrument`](ref/Instrument) ([schema](/schemas/next/instrument.schema.json))
 - [`fdc3.instrumentList`](ref/InstrumentList) ([schema](/schemas/next/instrumentList.schema.json))
 - [`fdc3.organization`](ref/Organization) ([schema](/schemas/next/organization.schema.json))
 - [`fdc3.portfolio`](ref/Portfolio) ([schema](/schemas/next/portfolio.schema.json))
 - [`fdc3.position`](ref/Position) ([schema](/schemas/next/position.schema.json))
 - [`fdc3.nothing`](ref/Nothing) ([schema](/schemas/next/nothing.schema.json))
 - [`fdc3.timerange`](ref/TimeRange) ([schema](/schemas/next/timerange.schema.json))
+- [`fdc3.transactionResult`](ref/TransactionResult) ([schema](/schemas/next/transactionresult.schema.json))
 - [`fdc3.valuation`](ref/Valuation) ([schema](/schemas/next/valuation.schema.json))
 
 __Note:__ The below examples show how the base context data interface can be used to define specific context data objects.

docs/intents/ref/CreateInteraction.md

@@ -0,0 +1,69 @@
+---
+id: CreateInteraction
+sidebar_label: CreateInteraction
+title: CreateInteraction
+hide_title: true
+---
+# `CreateInteraction`
+
+Create an interaction with a list of contacts.
+
+## Intent Name
+
+`CreateInteraction`
+
+## Display Name
+
+`Create Interaction`
+
+## Possible Contexts
+
+* [ContactList](../../context/ref/ContactList)
+
+## Example
+
+```js
+const interaction = {
+    type: 'fdc3.interaction',
+    contacts: {
+        type: 'fdc3.contactList',
+        contacts: [
+            {
+                type: 'fdc3.contact',
+                name: 'Jane Doe',
+                id: {
+                    email: 'jane.doe@mail.com'
+                }
+             },
+            {
+                type: 'fdc3.contact',
+                name: 'John Doe',
+                id: {
+                    email: 'john.doe@mail.com'
+                }
+            },
+        ]
+    },
+    interactionType: 'Instant Message',
+    timeRange: {
+        type: 'fdc3.timeRange',
+        startTime: '2022-02-10T15:12:00Z'
+    },
+    description: 'Laboris libero dapibus fames elit adipisicing eu, fermentum, dignissimos laboriosam, erat, risus qui deserunt. Praesentium! Reiciendis. Hic harum nostrud, harum potenti amet? Mauris. Pretium aliquid animi, eget eiusmod integer proident. Architecto ipsum blandit ducimus, possimus illum sunt illum necessitatibus ab litora sed, nonummy integer minus corrupti ducimus iste senectus accumsan, fugiat nostrud? Pede vero dictumst excepturi, iure earum consequuntur voluptatum',
+    initiator:  {
+        type: 'fdc3.contact',
+        name: 'Jane Doe',
+        id: {
+            email: 'jane.doe@mail.com'
+        }
+    },
+    origin: 'Outlook'
+}
+
+fdc3.raiseIntent('CreateInteraction', interaction)
+```
+
+## See Also
+
+Context
+- [Interaction](../../context/ref/Interaction)

docs/intents/spec.md

@@ -141,6 +141,7 @@ A list of standardized intents are defined in the following pages:
 * [`ViewProfile`](ref/ViewProfile)
 * [`ViewQuote`](ref/ViewQuote)
 * [`ViewResearch`](ref/ViewResearch)
+* [`CreateInteraction`](ref/CreateInteraction)
 
 ### Deprecated Intents
 

src/context/ContextType.ts

@@ -6,13 +6,15 @@ export enum ContextTypes {
   Country = 'fdc3.country',
   Currency = 'fdc3.currency',
   Email = 'fdc3.email',
+  Interaction = 'fdc3.interaction',
   Instrument = 'fdc3.instrument',
   InstrumentList = 'fdc3.instrumentList',
   Organization = 'fdc3.organization',
   Portfolio = 'fdc3.portfolio',
   Position = 'fdc3.position',
   Nothing = 'fdc3.nothing',
   TimeRange = 'fdc3.timerange',
+  TransactionResult = 'fdc3.transactionResult',
   Valuation = 'fdc3.valuation',
 }
 

src/context/ContextTypes.ts

@@ -48,6 +48,17 @@ export interface Email {
   richTextBody?: object;
 }
 
+export interface Interaction {
+  id?: { [key: string]: string };
+  type: string;
+  participants: ContactList;
+  timeRange: TimeRange;
+  interactionType: ("Instant Message" | "Email" | "Call" | "Meeting") | string;
+  description: string;
+  initiator?: Contact;
+  origin?: string;
+}
+
 export interface InstrumentList {
   instruments: Instrument[];
   type: string;
@@ -115,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 {

src/context/schemas.json

@@ -9,6 +9,7 @@
   "Country": ["https://fdc3.finos.org/schemas/next/country.schema.json"],
   "Currency": ["https://fdc3.finos.org/schemas/next/currency.schema.json"],
   "Email": ["https://fdc3.finos.org/schemas/next/email.schema.json"],
+  "Interaction": ["https://fdc3.finos.org/schemas/next/interaction.schema.json"],
   "Instrument": ["https://fdc3.finos.org/schemas/next/instrument.schema.json"],
   "InstrumentList": ["https://fdc3.finos.org/schemas/next/instrumentList.schema.json"],
   "Country": ["https://fdc3.finos.org/schemas/next/country.schema.json"],
@@ -17,5 +18,6 @@
   "Position": ["https://fdc3.finos.org/schemas/next/position.schema.json"],
   "Nothing": ["https://fdc3.finos.org/schemas/next/nothing.schema.json"],
   "TimeRange": ["https://fdc3.finos.org/schemas/next/timerange.schema.json"],
+  "TransactionResult": ["https://fdc3.finos.org/schemas/next/transactionresult.schema.json"],
   "Valuation": ["https://fdc3.finos.org/schemas/next/valuation.schema.json"]
 }

src/context/schemas/interaction.schema.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://fdc3.finos.org/schemas/next/interaction.schema.json",
+  "type": "object",
+  "title": "Interaction",
+  "allOf": [{ "$ref": "context.schema.json#" }],
+  "properties": {
+    "type": { "const": "fdc3.interaction" },
+    "participants": {
+      "$ref": "contactList.schema.json#"
+    },
+    "timeRange": {
+      "$ref": "timerange.schema.json#"
+    },
+    "interactionType": {
+      "anyOf": [
+        {
+          "type": "string",
+          "enum": ["Instant Message", "Email", "Call", "Meeting"]
+        },
+        {
+          "type": "string"
+        }
+      ]
+    },
+    "description": {
+      "type": "string"
+    },
+    "initiator": {
+       "$ref": "contact.schema.json#"
+    },
+     "origin": {
+      "type": "string"
+    }
+  },
+  "required": ["contacts", "timeRange", "interactionType", "description"]
+}

src/context/schemas/transactionresult.schema.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://fdc3.finos.org/schemas/next/transactionresult.schema.json",
+  "type": "object",
+  "title": "TransactionResult",
+  "allOf": [{ "$ref": "context.schema.json#" }],
+  "properties": {
+    "type": { "const": "fdc3.transactionResult" },
+    "status": {
+      "anyOf": [
+        {
+          "type": "string",
+          "enum": ["Created", "Deleted", "Updated", "Failed"]
+        },
+        {
+          "type": "string"
+        }
+      ]
+    },
+    "context": { "$ref": "context.schema.json#" }
+  },
+    "message": {
+      "type": "string"
+    },
+  "required": ["status", "context"]
+}