Merge remote-tracking branch 'origin/dev' into get-entity-conditions

Author: rtkay123

.npmrc

@@ -1,3 +1,3 @@
 # SPDX-License-Identifier: Apache-2.0
-@frmscoe:registry=https://npm.pkg.github.com
+@tazama-lf:registry=https://npm.pkg.github.com
 //npm.pkg.github.com/:_authToken=${GH_TOKEN}

README.md

@@ -87,10 +87,45 @@ GET
 #### Headers
 No specific headers required apart from standard authentication headers if needed.
 
-### 2. `/v1/admin/event-flow-control/entity`
+### Request Example
+```http
+GET /v1/admin/reports/getreportbymsgid?msgid=1234567890 HTTP/1.1
+```
+
+#### Response
+
+- **Status 400 Bad Request:** When `msgid` is missing or invalid.
+    ```json
+    {
+      "statusCode": 400,
+      "code": "FST_ERR_VALIDATION",
+      "error": "Bad Request",
+      "message": "querystring must have required property 'msgid'"
+    }
+    ```
+
+- **Status 204 Not Found:** When no report is found for the given `msgid`.
+    ```json
+    {
+      "statusCode": 204,
+    }
+    ```
+
+- **Status 500 Internal Server Error:** For server-side errors.
+    ```json
+    {
+      "status": "error",
+      "message": "Internal server error occurred."
+    }
+    ```
+
+
+### 2. 
+##### a. `/v1/admin/event-flow-control/entity`
+##### b. `/v1/admin/event-flow-control/account`
 
 #### Description
-This endpoint stores entity conditions and condition edges in ArangoDB as well as in an in-memory data storage system.
+Both endpoints are responsible for storing conditions related to their specific accounts or entities and are expected to store condition edges within the in-memory system.
 
 #### Flow Diagram
 ```mermaid
@@ -108,16 +143,24 @@ sequenceDiagram
   tmsapi->>clientsystem: writeOK(recordId)
 ```
 
-#### URL
+#### URL 1
 ```
 /v1/admin/event-flow-control/entity
 ```
-
-#### Method
+#### Method 1
 ```
 POST
 ```
 
+#### URL 2
+```
+/v1/admin/event-flow-control/account
+```
+#### Method 2
+```
+POST
+```
+**Both endpoints share all properties except for ntty and acct. These properties are specific to each endpoint and indicate the governing condition**
 #### Body
 
 | Parameter | Type   | Required | Description                     |
@@ -130,14 +173,21 @@ POST
 | `condRsn`   | String | Yes      | Reason code. |
 | `forceCret`   | Boolean | Yes      | Flag indicating whether the entity should be created if it does not exist. |
 | `usr`   | String | Yes      | User that triggered the operation. |
+#### URL 1
+| Parameter | Type   | Required | Description                     |
+|-----------|--------|----------|---------------------------------|
 | `ntty`   | Object | Yes      | The entity object that the condition is governed by. |
+#### URL 2
+| Parameter | Type   | Required | Description                     |
+|-----------|--------|----------|---------------------------------|
+| `acct`   | Object | Yes      | The account object that the condition is governed by. |
 
 Possible values for some fields mention in the table above
 1. **evtTp**  : [`'pacs.008.01.10'`,`'pacs.002.01.11'`,`'pain.001.001.11'`,`'pain.013.001.09'`]
 2. **condTp** : `non-overridable-block` or `override` or `overridable-block`
 3. **prsptv** : `both` or `creditor` or `debtor`
 
-**ntty object type**
+**ntty object for :** `URL 1`
 ```JSON
 {
   "id": "string",
@@ -147,30 +197,48 @@ Possible values for some fields mention in the table above
 }
 ```
 
+**acct object for :** `URL 2`
+```JSON
+{
+  "id": "string",
+  "schmeNm": {
+      "prtry": "string"
+  },
+  "agt": {
+    "finInstnId": {
+      "clrSysMmbId": {
+        "mmbId": "string"
+      }
+    }
+  }
+}
+```
+
 #### Headers
-No specific headers required apart from standard authentication headers if needed.
+No specific headers required for both endpoints.
+
 
-#### Request Example
 ```http
-GET /v1/admin/reports/getreportbymsgid?msgid=1234567890 HTTP/1.1
+POST /v1/admin/event-flow-control/entity HTTP/1.1
 ```
 
 #### Response
 
-- **Status 400 Bad Request:** When `msgid` is missing or invalid.
+- **Status 400 Bad Request:** When `prsptv` is missing or invalid.
     ```json
     {
       "statusCode": 400,
       "code": "FST_ERR_VALIDATION",
       "error": "Bad Request",
-      "message": "querystring must have required property 'msgid'"
+      "message": "body must have required property 'prsptv'"
     }
     ```
 
-- **Status 204 Not Found:** When no report is found for the given `msgid`.
+- **Status 500 Not Found:** When account was not found in the database and forceCret was set to false
     ```json
     {
-      "statusCode": 204,
+      "statusCode": 500,
+      "message": "Error: account was not found and we could not create one because forceCret is set to false"
     }
     ```
 
@@ -182,20 +250,19 @@ GET /v1/admin/reports/getreportbymsgid?msgid=1234567890 HTTP/1.1
     }
     ```
 
-
 ```http
-POST /v1/admin/event-flow-control/entity HTTP/1.1
+POST /v1/admin/event-flow-control/account HTTP/1.1
 ```
 
 #### Response
 
-- **Status 400 Bad Request:** When `prsptv` is missing or invalid.
+- **Status 400 Bad Request:** When `condTp` is missing or invalid.
     ```json
     {
       "statusCode": 400,
       "code": "FST_ERR_VALIDATION",
       "error": "Bad Request",
-      "message": "body must have required property 'prsptv'"
+      "message": "body must have required property 'condTp'"
     }
     ```