finos · mistryvinay · Mar 22, 2023 · Jun 7, 2022 · Jun 7, 2022 · Jun 7, 2022
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ## [Unreleased]
 
 ### Added
+* Added `CreateInteraction` intent. To be used when a user wants to record an interaction into a system.  New context `Interaction` also introduced. An interaction might be a call, IM, email, a meeting (physical or virtual) or the preparation of some specialist data. ([#747](https://github.com/finos/FDC3/pull/747))
 
 ### Changed
 

diff --git a/docs/context/ref/Contact.md b/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)
diff --git a/docs/context/ref/ContactList.md b/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)
diff --git a/docs/context/ref/Interaction.md b/docs/context/ref/Interaction.md
@@ -0,0 +1,88 @@
+---
+id: Interaction
+sidebar_label: Interaction
+title: Interaction
+hide_title: true
+---
+# `Interaction`
+
+An `Interaction` is a significant direct exchange of ideas or information between a number of participants, e.g. 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, such as financial data for a given company or sector.
+
+Notes:
+
+- `interactionType` SHOULD be one of 'Instant Message', 'Email', 'Call', or 'Meeting' although other values are permitted.
+- `origin` is used to represent the application or service that the interaction was created from to aid in tracing the source of an 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)
+- [ViewInteractions](../../intents/ref/ViewInteractions)
diff --git a/docs/context/ref/TimeRange.md b/docs/context/ref/TimeRange.md
@@ -80,3 +80,6 @@ const timeRange = {
 Other Types
 
 - [Chart](Chart)
+
+Intents
+- [CreateInteraction](../../intents/ref/CreateInteraction)
diff --git a/docs/context/spec.md b/docs/context/spec.md
@@ -157,23 +157,24 @@ For more details on FDC3 Standards compliance (including the versioning, depreca
 
 The following are standard FDC3 context types:
 
-* [`fdc3.chart`](ref/Chart) ([schema](/schemas/next/chart.schema.json))
-* [`fdc3.chat.initSettings`](ref/ChatInitSettings) ([schema](/schemas/next/chatInitSettings.schema.json))
-* [`fdc3.contact`](ref/Contact) ([schema](/schemas/next/contact.schema.json))
-* [`fdc3.contactList`](ref/ContactList) ([schema](/schemas/next/contactList.schema.json))
-* [`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.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.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.
+- [`fdc3.chart`](ref/Chart) ([schema](/schemas/next/chart.schema.json))
+- [`fdc3.chat.initSettings`](ref/ChatInitSettings) ([schema](/schemas/next/chatInitSettings.schema.json))
+- [`fdc3.contact`](ref/Contact) ([schema](/schemas/next/contact.schema.json))
+- [`fdc3.contactList`](ref/ContactList) ([schema](/schemas/next/contactList.schema.json))
+- [`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.instrument`](ref/Instrument) ([schema](/schemas/next/instrument.schema.json))
+- [`fdc3.instrumentList`](ref/InstrumentList) ([schema](/schemas/next/instrumentList.schema.json))
+- [`fdc3.interaction`](ref/Interaction) ([schema](/schemas/next/interaction.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.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.
 
 ### Examples
 

diff --git a/docs/intents/ref/CreateInteraction.md b/docs/intents/ref/CreateInteraction.md
@@ -0,0 +1,70 @@
+---
+id: CreateInteraction
+sidebar_label: CreateInteraction
+title: CreateInteraction
+hide_title: true
+---
+# `CreateInteraction`
+
+Create a record documenting an interaction (calls, meetings, etc.) between a list of contacts.
+
+## Intent Name
+
+`CreateInteraction`
+
+## Display Name
+
+`Create Interaction`
+
+## Possible Contexts
+
+* [ContactList](../../context/ref/ContactList)
+* [Interaction](../../context/ref/Interaction)
+
+## 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)
diff --git a/docs/intents/spec.md b/docs/intents/spec.md
@@ -161,6 +161,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
 

diff --git a/src/context/ContextTypes.ts b/src/context/ContextTypes.ts
@@ -109,7 +109,18 @@ export interface Country {
   name?: string;
 }
 
-export interface CountryID {
+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 CountryID {
   COUNTRY_ISOALPHA2?: string;
   COUNTRY_ISOALPHA3?: string;
   ISOALPHA2?: string;

diff --git a/src/context/schemas.json b/src/context/schemas.json
@@ -9,6 +9,7 @@
   "Email": ["https://fdc3.finos.org/schemas/next/email.schema.json"],
   "Instrument": ["https://fdc3.finos.org/schemas/next/instrument.schema.json"],
   "InstrumentList": ["https://fdc3.finos.org/schemas/next/instrumentList.schema.json"],
+  "Interaction": ["https://fdc3.finos.org/schemas/next/interaction.schema.json"],
   "Nothing": ["https://fdc3.finos.org/schemas/next/nothing.schema.json"],
   "Organization": ["https://fdc3.finos.org/schemas/next/organization.schema.json"],
   "Portfolio": ["https://fdc3.finos.org/schemas/next/portfolio.schema.json"],

diff --git a/src/context/schemas/interaction.schema.json b/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": ["participants", "timeRange", "interactionType", "description"]
+}
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',

diff --git a/src/intents/standard intents.json b/src/intents/standard intents.json
@@ -1,5 +1,9 @@
 {
   "intents": [
+    {
+      "name": "CreateInteraction",
+      "displayName": "Create Interaction"
+    },
     {
       "name": "StartCall",
       "displayName": "Call"

diff --git a/website/sidebars.json b/website/sidebars.json
@@ -38,6 +38,7 @@
         "label": "Intents Part",
         "ids": [
           "intents/spec",
+          "intents/ref/CreateInteraction",
           "intents/ref/StartCall",
           "intents/ref/StartChat",
           "intents/ref/StartEmail",
@@ -69,6 +70,7 @@
           "context/ref/Email",
           "context/ref/Instrument",
           "context/ref/InstrumentList",
+          "context/ref/Interaction",
           "context/ref/Nothing",
           "context/ref/Organization",
           "context/ref/Portfolio",

diff --git a/website/static/schemas/next/interaction.schema.json b/website/static/schemas/next/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": ["participants", "timeRange", "interactionType", "description"]
+}