add-create-interaction-intent

finos · Jun 7, 2022 · 10f1e44 · 10f1e44
1 parent 6accbc1
commit 10f1e44
Show file tree

Hide file tree

Showing 5 changed files with 77 additions and 0 deletions.
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/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/intents/ref/CreateInteraction.md b/docs/intents/ref/CreateInteraction.md
@@ -0,0 +1,71 @@
+---
+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'
+        }
+    },
+    source: 'Outlook'
+}
+
+fdc3.raiseIntent('CreateInteraction', interaction)
+```
+
+## See Also
+
+Context
+- [Contact](../../context/ref/Contact)
+- [ContactList](../../context/ref/ContactList)
+- [TimeRange](../../context/ref/TimeRange)
diff --git a/docs/intents/spec.md b/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