Merge branch '588_intent_proposal_view_orders' of https://github.com/…

…pauldyson/FDC3 into pauldyson-588_intent_proposal_view_orders
finos · May 23, 2022 · fb6d4f6 · fb6d4f6
2 parents 150b720 + a203c38
commit fb6d4f6
Show file tree

Hide file tree

Showing 11 changed files with 67 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -32,8 +32,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * Added a `ViewResearch` Intent to be used when a user wants to see the latest research on a particular stock ([#623](https://github.com/finos/FDC3/pull/623))
 * Updated for Intent Naming conventions.  Added hyperlinks for existing Intent spec definitions. Changes based on ([#701](https://github.com/finos/FDC3/pull/701))
 * Added guide on how to submit a new Intent. ([#624](https://github.com/finos/FDC3/pull/624))
-* Added a context type for View Interactions. Used when a user wants to see the latest interactions (calls, meetings, conferences, roadshows) on a particular stock or with an individual or organization. ([#625](https://github.com/finos/FDC3/pull/625))
-
+* Added a context type for `ViewInteractions`. Used when a user wants to see the latest interactions (calls, meetings, conferences, roadshows) on a particular stock or with an individual or organization. ([#625](https://github.com/finos/FDC3/pull/625))
+* Added guide on how to submit a new Intent. ([#624](https://github.com/finos/FDC3/pull/624))
+* Added `ViewOrders`. Used when a user wants to see the order history of an individual, an institution or of a particular stock. ([#672](https://github.com/finos/FDC3/pull/672))
 
 ### Changed
 * Consolidated `Listener` documentation with other types ([#404](https://github.com/finos/FDC3/pull/404))

diff --git a/docs/context/ref/Contact.md b/docs/context/ref/Contact.md
@@ -51,6 +51,7 @@ Intents
 - [ViewProfile](../../intents/ref/ViewProfile)
 - [ViewResearch](../../intents/ref/ViewResearch)
 - [ViewInteractions](../../intents/ref/ViewInteractions)
+- [ViewOrders](../../intents/ref/ViewOrders)
 
 FINOS Financial Objects
 - [Contact](https://fo.finos.org/docs/objects/contact)
diff --git a/docs/context/ref/Instrument.md b/docs/context/ref/Instrument.md
@@ -81,6 +81,7 @@ Intents
 - [ViewQuote](../../intents/ref/ViewQuote)
 - [ViewResearch](../../intents/ref/ViewResearch)
 - [ViewInteractions](../../intents/ref/ViewInteractions)
+- [ViewOrders](../../intents/ref/ViewOrders)
 
 FINOS Financial Objects
 - [Instrument](https://fo.finos.org/docs/objects/instrument)
diff --git a/docs/context/ref/Organization.md b/docs/context/ref/Organization.md
@@ -57,6 +57,7 @@ Intents
 - [ViewProfile](../../intents/ref/ViewProfile)
 - [ViewResearch](../../intents/ref/ViewResearch)
 - [ViewInteractions](../../intents/ref/ViewInteractions)
+- [ViewOrders](../../intents/ref/ViewOrders)
 
 FINOS Financial Objects
 - [Organization](https://fo.finos.org/docs/objects/organization)
diff --git a/docs/intents/ref/ViewHoldings.md b/docs/intents/ref/ViewHoldings.md
@@ -46,3 +46,4 @@ Context
 Intents
 - [ViewInstrument](ViewInstrument)
 - [ViewAnalysis](ViewAnalysis)
+- [ViewOrders](ViewOrders)
diff --git a/docs/intents/ref/ViewInstrument.md b/docs/intents/ref/ViewInstrument.md
@@ -42,4 +42,5 @@ Context
 
 
 Intents
-- [ViewChart](ViewChart)
+- [ViewChart](ViewChart)
+- [ViewOrders](ViewOrders)
diff --git a/docs/intents/ref/ViewOrders.md b/docs/intents/ref/ViewOrders.md
@@ -0,0 +1,48 @@
+---
+id: ViewOrders
+sidebar_label: ViewOrders
+title: ViewOrders
+hide_title: true
+---
+# `ViewOrders`
+
+Display any orders related to the provided contact, instrument, or organization.
+
+## Intent Name
+
+`ViewOrders`
+
+## Display Name
+
+`View Orders`
+
+## Possible Contexts
+
+* [Contact](../../context/ref/Contact)
+* [Instrument](../../context/ref/Instrument)
+* [Organization](../../context/ref/Organization)
+
+## Example
+
+```js
+const instrument = {
+    type: 'fdc3.instrument',
+    name: 'Tesla, Inc.',
+    id: {
+        ticker: 'TSLA'
+    }
+}
+
+fdc3.raiseIntent('ViewOrders', instrument)
+```
+
+## See Also
+
+Context
+- [Contact](../../context/ref/Contact)
+- [Instrument](../../context/ref/Instrument)
+- [Organization](../../context/ref/Organization)
+
+Intents
+- [ViewHoldings](ViewHoldings)
+- [ViewInstrument](ViewInstrument)
diff --git a/docs/intents/spec.md b/docs/intents/spec.md
@@ -139,6 +139,8 @@ A list of standardized intents are defined in the following pages:
 * [`ViewProfile`](ref/ViewProfile)
 * [`ViewResearch`](ref/ViewResearch)
 * [`ViewInteractions`](ref/ViewInteractions)
+* [`ViewInteractions`](ref/ViewInteractions)
+* [`ViewOrders`](ref/ViewOrders)
 
 ### Deprecated Intents
 

diff --git a/src/intents/Intents.ts b/src/intents/Intents.ts
@@ -10,5 +10,6 @@ export enum Intents {
   ViewHoldings = 'ViewHoldings',
   ViewProfile = 'ViewProfile',
   ViewResearch = 'ViewResearch',
-  ViewInteractions = 'ViewInteractions'
+  ViewInteractions = 'ViewInteractions',
+  ViewOrders = 'ViewOrders'
 }
diff --git a/src/intents/standard intents.json b/src/intents/standard intents.json
@@ -47,6 +47,10 @@
     {
       "name": "ViewInteractions",
       "displayName": "Interactions"
+    },
+    {
+      "name": "ViewOrders",
+      "displayName": "Orders"
     }
   ]
 }
diff --git a/website/sidebars.json b/website/sidebars.json
@@ -42,7 +42,8 @@
           "intents/ref/ViewHoldings",
           "intents/ref/ViewProfile",
           "intents/ref/ViewResearch",
-          "intents/ref/ViewInteractions"
+          "intents/ref/ViewInteractions",
+          "intents/ref/ViewOrders"
         ]
       },
       {