update language, add functions

Author: alexv-quant

docs/payscript/built_in_functions.md

@@ -4,18 +4,48 @@ parent: Payscript
 layout: page
 ---
 
-built in functions
+# built in functions
 
-## Reserve functions
+## Account Functions
 
-### Add Funds
-`addFundsToReserve(String fromAccount, String toReserve, decimal amount, String reference)`
+## `boolean accountExists(AccountIdentifier accountIdentifier)`
+Checks whether an account exists.
+
+
+## `boolean checkAccountFunds(AccountIdentifier accountIdentifier, BigDecimal amount)`
+Checks whether an account has the required funds available 
+
+
+## `BalanceInfo getBalance(AccountIdentifier accountIdentifier)`
+Shows the total balance and available balance for an account
+
+
+## `List<RelatedAccountInfo> getRelatedAccountIds(AccountIdentifier accountIdentifier)`
+Retrieve the number of accounts related to a specified account
+
+## `ConsentStatus getConsent(AccountIdentifier giverAccountId, AccountIdentifier holderAccountId, ConsentType type)`
+Retrieve consent status for a particular account
+
+## Payment Functions
 
+## `UUID createPayment(String payerAccountNumber, String payeeAccountNumber, BigDecimal amount, String purpose)`
+Makes a payment between two accounts
+
+## `UUID requestPayment(String payerAccountNumber, String payeeAccountNumber, BigDecimal amount, String purpose)`
+Sends a payment request from one account to another
+
+## `getPaymentInfo`
+Retrieve payment information
+
+
+
+## Reserve Functions
+
+`addFundsToReserve(String fromAccount, String toReserve, decimal amount, String reference)`
 Sets aside an `amount` of funds from the account `fromAccount` into the reserve `toReserve`. The transaction reference used is the text `reference`.
 
-### Withdraw Funds
-`withdrawFundsFromReserve(fromReserve, toAccount, amount, reference);`
 
+`withdrawFundsFromReserve(fromReserve, toAccount, amount, reference);`
 Withdraws an `amount` of funds into the account `toAccount` from the reserve `fromReserve`. The transaction reference used is the text `reference`.
 
 ### Create Reserve Update

docs/payscript/concepts/index.md docs/payscript/concepts.mddocs/payscript/concepts/index.md renamed to docs/payscript/concepts.md

@@ -5,9 +5,8 @@ layout: page
 nav_order: 4
 ---
 
-
 ## Automation
-An entity created by a [customer] into their bank account. The automation is created from a PayScript from among the ones that have been deployed by [developers]. If the selected payscript uses a trigger type that requires [trigger parameters], those need to be specified as part of creating the automation. If the selected payscript defines [script parameters], those need to be specified as part of creating the automation.
+Automations are features powered by one or more PayScripts, which a [customer] can enable in their bank account. If the selected payscript uses a trigger type that requires [trigger parameters](), those need to be specified as part of creating the automation. If the selected payscript defines [script parameters], those need to be specified as part of creating the automation.
 
 ## Reserve
 An abstract segregation of funds in a customer's account with a name and a purpose, so that those funds can be considered unavailable for other purposes, effectively reserving them. Funds can be added to and removed from the reserve by the account owner, or by whoever the account owner has given [consent] to do this.
@@ -20,4 +19,5 @@ Balance: Allows seeing the balance of the owner
 Transactions: Allows making transactions on behalf of the owner
 
 [customer]: /docs/quant_flow/personas#customer
-[developers]: /docs/quant_flow/personas#developer
+[developers]: /docs/quant_flow/personas#developer
+[trigger parameters]: /docs/payscript/triggers#parameters

docs/payscript/example_scripts/automated_transfer.md

@@ -7,7 +7,6 @@ layout: page
 ```groovy
 trigger = "on_demand";
 
-
 def payer  = ${payer:scan};
 def payee = ${payee:scan};
 def amount = ${amount:decimal};

docs/payscript/index.md

@@ -1,5 +1,5 @@
 ---
 title: Payscript
 layout: page
-nav_order: 2
+nav_order: 4
 ---

docs/payscript/language_reference.md

@@ -5,18 +5,18 @@ layout: page
 nav_order: 1
 ---
 
-## Payscript
+# Payscript
 Payscript is a domain specific language (DSL) derived from Groovy. Using the Groovy syntax, with additional [built-in functions], it is able to cover the functionality needed to operate in the environment of a financial services provider. 
 
 For Syntax, this version does not differ from Groovy. please consult the [Groovy syntax reference][groovy syntax]. 
 
-## Script Structure
+
+### Script Structure
 PayScript has two special structures, beyond the programming logic; A [trigger] definition and [script parameters]. The trigger specifies what type of event will cause the script to run. When an automation is created with the script, the parameters of the trigger will be specified. For example, if the script's trigger type is "time", the parameters would be which date and time it should run on.
 Also during the creation of the automation, the script parameters required by the script will be supplied.
 
-## Parameters
+### Script Parameters
 The script parameters are values which will be used by the script but will be specified by the customer who creates an automation which uses this script. At that time they will be prompted for the values, much like the trigger parameters.
-
 Parameters are specified in the script using the following syntax:
 
 ```groovy
@@ -28,6 +28,21 @@ Where [parameter name] is to be replaced with the name of the parameter, as will
 ## Logic
 The logic section contains what the script needs to accomplish, utilizing groovy logic and the payscript built-in functions.
 
+## Concepts
+
+### Automation
+Automations are features powered by one or more PayScripts, which a [customer] can enable in their bank account. If the selected payscript uses a trigger type that requires [trigger parameters](), those need to be specified as part of creating the automation. If the selected payscript defines [script parameters], those need to be specified as part of creating the automation.
+
+### Reserve
+An abstract segregation of funds in a customer's account with a name and a purpose, so that those funds can be considered unavailable for other purposes, effectively reserving them. Funds can be added to and removed from the reserve by the account owner, or by whoever the account owner has given [consent] to do this.
+
+## Consent
+Consent is given by a [customer] to another customer perform specific actions on their accounts. The types of consent that can be given are:
+Fund check: Allows checking if the owner has more available funds than a given amount
+Automations: 
+Balance: Allows seeing the balance of the owner
+Transactions: Allows making transactions on behalf of the owner
+
 
 [groovy syntax]: https://groovy-lang.org/single-page-documentation.html
 [built-in functions]: built_in_functions

docs/quant_flow/index.md

@@ -1,5 +1,5 @@
 ---
 title: Quant Flow
 layout: page
-nav_order: 1
+nav_order: 2
 ---

docs/quant_flow/personas.md

@@ -5,7 +5,6 @@ nav_order: 1
 parent: Quant Flow
 ---
 
-
 # Personas
 The white label version of Quant Flow is designed for financial service providers such as banks. With that in mind, the following personas are referred to in this documentation as a generalisation of roles played in the product vision.
 
@@ -16,6 +15,6 @@ The financial service provider which has adopted and implemented Quant Flow.
 The professional responsible for developing and managing PayScripts.
 
 ## Customer
-The Bank's end user, utilising the provided financial services powered by Quant Flow. In the Sandbox, customers do this by creating [Automations], while in a real implementation of Quant Flow the features can be made available in different ways.
+The Bank's end user, utilising the provided financial services powered by Quant Flow. In the Sandbox, customers do this by activating [Automations], while in a real implementation of Quant Flow the features can be made available in different ways.
 
 [automations]: /docs/sandbox/automations

docs/sandbox/automations.md

@@ -1,5 +1,5 @@
 ---
 title: Tutorials
 layout: page
-nav_order: 4
+nav_order: 5
 ---