finos · mistryvinay · Jun 7, 2022 · Jun 7, 2022 · Jun 7, 2022 · Jun 8, 2022
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,11 +8,26 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ### 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))
+* Added `TransactionResult` context. A context type representing the result of a transaction initiated via FDC3. Its purpose is to provide a status and message (where needed) for the transaction and MAY wrap a returned context object. ([#761](https://github.com/finos/FDC3/pull/761))
+* Added `Order` (`fdc3.order`) context type representing the details of an order, which may be used to transmit a new order to a third party or share details of an existing order. ([#824](https://github.com/finos/FDC3/pull/824))
+
+* Added a `SendChatMessage` intent to be used when a user wants to send a message to an existing chat room. ([#794](https://github.com/finos/FDC3/pull/794))
+* Added a context type representing a chat message (`fdc3.chat.message`). ([#794](https://github.com/finos/FDC3/pull/794))
+* Added a context type representing a chat room (`fdc3.chat.room`). ([#794](https://github.com/finos/FDC3/pull/794))
+* Added a chat `Message` type in order to describe messages with rich content and attachments. ([#779](https://github.com/finos/FDC3/pull/779))
+* Added an `Action` type, encapsulating either a `Context` or the association of a `Context` with an `Intent` inside another object.  ([#779](https://github.com/finos/FDC3/pull/779))
+* Added a `ViewChat` Intent to be used when a user wants to open an existing chat room. ([#796](https://github.com/finos/FDC3/pull/796))
+* Added a `ViewMessages` intent to be used when a user wants to search and see a list of messages. ([#797](https://github.com/finos/FDC3/pull/797))
+* Added a context type representing a ChatSearchCriteria (`fdc3.chat.searchCriteria`). ([#797](https://github.com/finos/FDC3/pull/797))
+
 * Added error examples to the /v2 App Directory API routes ([#973](https://github.com/finos/FDC3/pull/973))
 
 ### Changed
 
+* Updated definition of the `ChatInitSettings` context type to use the new `Message` type.  ([#779](https://github.com/finos/FDC3/pull/779))
 * Updated definition of the `Instrument` context type to include optional market identifiers ([#819](https://github.com/finos/FDC3/pull/819))
+* Updated the `StartChat` intent to return a reference to the room. ([#794](https://github.com/finos/FDC3/pull/794))
 * Corrected API functions and object types to always use `string` instead of `String` ([#924](https://github.com/finos/FDC3/pull/924))
 
 ### Deprecated

diff --git a/docs/context/ref/Action.md b/docs/context/ref/Action.md
@@ -0,0 +1,74 @@
+---
+id: Action
+sidebar_label: Action
+title: Action
+hide_title: true
+---
+# `Action`
+
+A representation of an FDC3 Action (specified via a Context or Context & Intent) that can be inserted inside another object, 
+for example a chat message.
+
+The action may be completed by calling `fdc3.raiseIntent()` with the specified Intent and Context, or, if only a context is specified, by calling `fdc3.raiseIntentForContext()` (which the Desktop Agent will resolve by presenting the user with a list of available Intents for the Context).
+
+Accepts an optional `app` parameter in order to specify a certain app.
+
+## Type
+
+`fdc3.action`
+
+## Schema
+
+https://fdc3.finos.org/schemas/next/action.schema.json
+
+## Details
+
+| Property          | Type                                      | Required | Example Value           |
+|-------------------|-------------------------------------------|----------|-------------------------|
+| `type`            | string                                    | Yes      | `'fdc3.action'`         |
+| `title`           | string                                    | Yes      | `'Click to view Chart'` |
+| `intent`          | string                                    | No       | `'ViewChart'`           |
+| `context`         | string                                    | Yes      | See Below               |
+| `app`             | object                                    | No       | `'myApp'`               |
+| `app.appId`       | string                                    | Yes      | `'app1'`                |
+| `app.instanceId`  | string                                    | No       | `'instance1'`           |
+
+
+
+## Example
+
+```js
+const action = {
+    type: 'fdc3.action',
+    title: 'Click to view Chart',
+    intent: 'ViewChart',
+    context {
+        type: 'fdc3.chart',
+        instruments: [
+            {
+                type: 'fdc3.instrument',
+                id: {
+                    ticker: 'EURUSD'
+                }
+            }
+        ],
+        range: {
+            type: 'fdc3.dateRange',
+            starttime: '2020-09-01T08:00:00.000Z',
+            endtime: '2020-10-31T08:00:00.000Z'
+        },
+        style: 'candle'
+    },
+    app {
+        appId: 'MyChartViewingApp',
+        instanceId: 'instance1'
+    }
+}
+
+## See Also
+
+Other Types
+* [Message](Message)
+
+Intents
+* [StartChat](../../intents/ref/StartChat)
diff --git a/docs/context/ref/ChatInitSettings.md b/docs/context/ref/ChatInitSettings.md
@@ -22,12 +22,12 @@ https://fdc3.finos.org/schemas/next/chatInitSettings.schema.json
 | Property                       | Type        | Required | Example Value                                                        |
 | ------------------------------ | ----------- | -------- | -------------------------------------------------------------------- |
 | `type`                         | string      | Yes      | `'fdc3.chat.initSettings'`                                           |
-| `chatName`                     | string      | No       | `'Instrument XYZ'`                                                    |
+| `chatName`                     | string      | No       | `'Instrument XYZ'`                                                   |
 | `members`                      | ContactList | No       | ContactList - cf. below                                              |
-| `initMessage`                  | string      | No       | `'Hello!'`                                                           |
+| `message`                      | Message     | No       | Message - cf. below                                                  |
 | `options.groupRecipients`      | boolean     | No       | `true`: if false a separate chat will be created for each member     |
-| `options.public`               | boolean     | No       | `true`: the room will be visible to everyone in the chat application |
-| `options.allowHistoryBrowsing` | boolean     | No       | `true`: members will be allowed to browse past messages             |
+| `options.isPublic`             | boolean     | No       | `true`: the room will be visible to everyone in the chat application |
+| `options.allowHistoryBrowsing` | boolean     | No       | `true`: members will be allowed to browse past messages              |
 | `options.allowMessageCopy`     | boolean     | No       | `true`: members will be allowed to copy/paste messages               |
 | `options.allowAddUser`         | boolean     | No       | `true`: members will be allowed to add other members to the chat     |
 
@@ -58,27 +58,45 @@ const initSettings = {
     },
     options: {
         groupRecipients: true, // one chat with both contacts
-        public: false, // private chat room
+        isPublic: false, // private chat room
         allowHistoryBrowsing: true,
         allowMessageCopy: true
     }
-    initMessage: 'Hello both!'
+    message: {
+      type: 'fdc3.message',
+      text: {
+        'text/plain': 'Hey all, can we discuss the issue together? I attached a screenshot'
+      },
+      entities: {
+         '0': {
+             type: 'fdc3.fileAttachment',
+              data: {
+              name: 'myImage.png',
+                    dataUri: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII'
+              }
+          }
+      }
+    }
 }
 
 const res = fdc3.raiseIntent('StartChat', initSettings);
-const roomRefs = await res.getResult();
+
+// Return a reference to the room
+const chatRoom = await res.getResult();
 ```
 
 ## See Also
 
 Other Types
 
+- [ChatRoom](ChatRoom)
 - [ContactList](ContactList)
+- [Message](Message)
 
 Intents
-
 - [StartChat](../../intents/ref/StartChat)
 - [StartCall](../../intents/ref/StartCall)
+- [SendChatMessage](../../intents/ref/StartChat)
 - [ViewContact](../../intents/ref/ViewContact)
 
 FINOS Financial Objects

diff --git a/docs/context/ref/ChatMessage.md b/docs/context/ref/ChatMessage.md
@@ -0,0 +1,51 @@
+---
+id: ChatMessage
+sidebar_label: ChatMessage
+title: ChatMessage
+hide_title: true
+---
+# `ChatMessage`
+
+A context representing a chat message. Typically used to send the message or to pre-populate a message for sending.
+
+## Type
+
+`fdc3.chat.message`
+
+## Schema
+
+- https://fdc3.finos.org/schemas/next/chatMessage.schema.json
+
+## Details
+
+| Property    | Type    | Required | Example Value     |
+|-------------|---------|----------|-------------------|
+| `type`      | string  | Yes      | `'fdc3.chat.message'`  |
+| `chatRoom`      | ChatRoom  | Yes       | `{ type: 'fdc3.chat.room', providerName: 'Symphony', id:{ streamId: 'j75xqXy25NBOdacUI3FNBH'} }`      |
+| `message`  | [Message](https://fdc3.finos.org/schemas/next/message.schema.json)  | Yes       | `'A message to send'` |
+
+## Example
+
+```js
+const chatMessage = {
+    type: "fdc3.chat.message",
+    chatRoom: {
+        type: 'fdc3.chat.room',
+        providerName: "Symphony",
+        id: {
+            streamId: "j75xqXy25NBOdacUI3FNBH"
+        }
+    },
+    message: "A message to send"
+}
+```
+
+## See Also
+
+Intents
+- [StartChat](../../intents/ref/StartChat)
+- [StartCall](../../intents/ref/StartCall)
+- [SendChatMessage](../../intents/ref/SendChatMessage)
+
+FINOS Financial Objects
+- [Contact](https://fo.finos.org/docs/objects/contact)
diff --git a/docs/context/ref/ChatRoom.md b/docs/context/ref/ChatRoom.md
@@ -0,0 +1,64 @@
+---
+id: ChatRoom
+sidebar_label: ChatRoom
+title: Contact
+hide_title: true
+---
+# `ChatRoom`
+
+Reference to the chat room(s) (which could be used later to send a message to the room(s)).
+
+## Type
+
+`fdc3.chat.room`
+
+## Schema
+
+https://fdc3.finos.org/schemas/next/chatRoom.schema.json
+
+## Details
+
+| Property    | Type    | Required | Example Value     |
+|-------------|---------|----------|-------------------|
+| `type`      | string  | Yes      | `'fdc3.chat.room'`  |
+| `providerName`      | string  | Yes       | `'Symphony'`      |
+| `id`  | object  | Yes       | `{ streamId: 'j75xqXy25NBOdacUI3FNBH', anyOtherKey: 'abcdef'}` |
+| `url` | string  | No       | `'http://symphony.com/ref/room/j75xqXy25NBOdacUI3FNBH___pqSsuJRdA'`      |
+| `name` | string  | No       | `'My new room'`      |
+
+The `url` is an universal url to access to the room. It could be opened from a browser, a mobile app, etc...
+
+## Example
+
+```js
+const chatRoom = {
+  type: "fdc3.chat.room",
+  providerName: "Symphony",
+  id: {
+      streamId: "j75xqXy25NBOdacUI3FNBH"
+  }
+  url: "http://symphony.com/ref/room/j75xqXy25NBOdacUI3FNBH___pqSsuJRdA",
+  name: 'My new room'
+};
+
+//Chat rooms are returned by the StartChat intent as a result
+const intentResolution = await fdc3.raiseIntent("StartChat", context);
+
+try {
+    const chatRooms = await intentResolution.getResult():
+} catch (error) {
+   //chat room were not created...
+}
+```
+
+## See Also
+
+Other Types
+* [ChatInitSettings](ChatInitSettings)
+
+Intents
+- [StartChat](../../intents/ref/StartChat)
+- [SendChatMessage](../../intents/ref/SendChatMessage)
+
+FINOS Financial Objects
+- [Contact](https://fo.finos.org/docs/objects/contact)
diff --git a/docs/context/ref/Contact.md b/docs/context/ref/Contact.md
@@ -46,6 +46,7 @@ Other Types
 - [ContactList](ContactList)
 
 Intents
+- [CreateInteraction](../../intents/ref/CreateInteraction)
 - [StartChat](../../intents/ref/StartChat)
 - [StartCall](../../intents/ref/StartCall)
 - [ViewProfile](../../intents/ref/ViewProfile)

diff --git a/docs/context/ref/ContactList.md b/docs/context/ref/ContactList.md
@@ -62,6 +62,7 @@ Other Types
 - [Contact](Contact)
 
 Intents
+- [CreateInteraction](../../intents/ref/CreateInteraction)
 - [StartChat](../../intents/ref/StartChat)
 - [StartCall](../../intents/ref/StartCall)
 

diff --git a/docs/context/ref/Interaction.md b/docs/context/ref/Interaction.md
@@ -0,0 +1,96 @@
+---
+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 string 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.
+- `id` does not need to be populated by the originating application, however the target application could store it for future reference and SHOULD return it in a `TransactionResult`. 
+- `id` can be used by a target application to pass an identifier back to the originating application after an interaction record has been created, updated or deleted.
+- `id.URI` can be used by a target application to pass a record's link back to the originating application. This offers the originating application a way to open the record for a user to view. 
+
+## 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`                                       |
+| `id.SINGLETRACK`   | string           | No        | `a0S8d000000uO05EAE`                            |
+| `id.SALESFORCE`    | string           | No        | `a0S8d000000uO05EAE`                            |
+| `id.URI`           | string           | No        | `https://example.com/record/a0S8d000000uO05EAE` |
+
+
+## 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)
+- [TransactionResult](TransactionResult]
+
+Intents
+- [CreateInteraction](../../intents/ref/CreateInteraction)
+- [ViewInteractions](../../intents/ref/ViewInteractions)