summaryrefslogtreecommitdiff
path: root/manpages
diff options
context:
space:
mode:
authorThien-Thi Nguyen <ttn@gnuvola.org>2022-01-31 03:14:00 -0500
committerThien-Thi Nguyen <ttn@gnuvola.org>2022-01-31 03:14:21 -0500
commit592ec49e52792bb4d9f22c5d5de5a0ebacfc1c44 (patch)
tree1eb49e4fd93c4afe5477faf822a25b12bceb49c1 /manpages
parent16e0f82a90a1c01614af2cae96bd17315b9818d9 (diff)
downloaddocs-592ec49e52792bb4d9f22c5d5de5a0ebacfc1c44.tar.gz
docs-592ec49e52792bb4d9f22c5d5de5a0ebacfc1c44.tar.bz2
docs-592ec49e52792bb4d9f22c5d5de5a0ebacfc1c44.zip
document several ‘libeufin-cli sandbox’ commands
specifically: - sandbox - sandbox check - sandbox ebichost - sandbox ebichost create - sandbox ebichost list - sandbox ebicssubscriber - sandbox ebicssubscriber create - sandbox ebicssubscriber list - sandbox ebicsbankaccount - sandbox ebicsbankaccount create - sandbox bankaccount - sandbox bankaccount list - sandbox bankaccount generate-transactions - sandbox bankaccount simulate-incoming-transaction - sandbox bankaccount transactions
Diffstat (limited to 'manpages')
-rw-r--r--manpages/libeufin-cli.1.rst284
1 files changed, 283 insertions, 1 deletions
diff --git a/manpages/libeufin-cli.1.rst b/manpages/libeufin-cli.1.rst
index e7643082..b8c995f0 100644
--- a/manpages/libeufin-cli.1.rst
+++ b/manpages/libeufin-cli.1.rst
@@ -76,7 +76,289 @@ The following sections describe each command and their subcommands in detail.
sandbox
-------
-WRITEME
+The ``libeufin-cli sandbox`` command is for managing the sandbox process
+started by ``libeufin-sandbox serve``.
+It takes one option, ``--sandbox-url URL``, to be specified before
+the subcommands and their arguments.
+This URL can also be specified with the ``LIBEUFIN_SANDBOX_URL``
+environment variable (see above).
+
+The following subcommands are available: bankaccount, check, demobank,
+ebicsbankaccount, ebicshost, ebicssubscriber.
+
+The first command to use is ``check``,
+followed by ``ebicshost``, ``ebicssubscriber``,
+and ``ebicsbankaccount``, to configure the basic system.
+
+You can then use the ``bankaccount`` command to generate (simulated)
+transaction traffic.
+
+After that, the ``demobank`` command and its subcommands
+provide the same access to the API that Nexus itself uses.
+You normally do not need to use those commands directly.
+
+
+sandbox check
+-------------
+
+The ``check`` command attempts a simple aliveness check by
+contacting the sandbox and displaying its returned message.
+If all goes well, you should see something like:
+
+.. code-block:: console
+
+ $ libeufin-cli sandbox check
+ Hello, this is the Sandbox
+
+
+sandbox ebichost
+----------------
+
+The ``ebicshost`` command manages EBICS hosts.
+It has two subcommands: create and list.
+
+The ``ebicshost create`` command creates a EBICS host.
+It takes one option, ``--host-id ID``, where ``ID`` is used to
+identify that host for all future commands.
+
+The ``ebicshost list`` command lists the hosts in the system.
+
+For example:
+
+.. code-block:: console
+
+ $ libeufin-cli sandbox ebicshost create --host-id testhost
+ $ libeufin-cli sandbox ebicshost list
+ {
+ "ebicsHosts" : [ "testhost" ]
+ }
+
+Here, the ``ID`` is ``testhost``.
+
+
+sandbox ebicssubscriber
+-----------------------
+
+The ``ebicssubscriber`` command manages EBICS subscribers.
+It has two subcommands: create and list.
+
+The ``ebicssubscriber create`` command creates a EBICS subscriber.
+It takes three options, all of which are required:
+
+::
+
+ --host-id TEXT Ebics host ID
+ --partner-id TEXT Ebics partner ID
+ --user-id TEXT Ebics user ID
+
+The host ID should be the same one specified in ``ebicshost create``
+(see above).
+
+For example:
+
+.. code-block:: console
+
+ $ libeufin-cli sandbox ebicssubscriber create \
+ --host-id testhost \
+ --partner-id partner01 \
+ --user-id user01
+ $ libeufin-cli sandbox ebicssubscriber list
+ {
+ "subscribers" : [ {
+ "hostID" : "testhost",
+ "partnerID" : "partner01",
+ "userID" : "user01",
+ "systemID" : null,
+ "demobankAccountLabel" : "not associated yet"
+ } ]
+ }
+
+Note that ``testhost`` is the same as in the ``ebicshost create``
+example (see above).
+
+
+sandbox ebicsbankaccount
+------------------------
+
+The ``ebicsbankaccount`` command manages EBICS bank accounts.
+It has one subcommand: create.
+(To list accounts, see ``sandbox bankaccount`` below.)
+
+The ``ebicsbankaccount create`` command takes several options, all required:
+
+::
+
+ --iban TEXT IBAN
+ --bic TEXT BIC
+ --person-name TEXT bank account owner name
+ --account-name TEXT label of this bank account
+ --ebics-user-id TEXT user ID of the Ebics subscriber
+ --ebics-host-id TEXT host ID of the Ebics subscriber
+ --ebics-partner-id TEXT partner ID of the Ebics subscriber
+
+At this time, although the ``--person-name`` option is required,
+the sandbox does not remember the option value.
+(When queried, it displays "Bank account owner's name" instead.
+See ``sandbox bankaccount`` below.)
+For the sandbox, the important value is the ``--account-name`` option.
+
+For example:
+
+.. code-block:: console
+
+ $ libeufin-cli sandbox ebicsbankaccount create \
+ --iban DE18500105172929531888 \
+ --bic INGDDEFFXXX \
+ --person-name "Jane Normal" \
+ --account-name testacct01 \
+ --ebics-host-id testhost \
+ --ebics-user-id user01 \
+ --ebics-partner-id partner01
+
+Note that ``testhost`` is the same as in the ``ebicshost create``
+example, and that ``user01`` and ``partner01`` are the same as in the
+``ebicssubscriber create`` example (see above).
+
+
+sandbox bankaccount
+-------------------
+
+The ``bankaccount`` command manages bank accounts.
+It has several subcommands: list, generate-transactions,
+simulate-incoming-transaction, transactions.
+
+The ``bankaccount list`` command lists the bank accounts in the system.
+
+For example:
+
+.. code-block:: console
+
+ $ libeufin-cli sandbox bankaccount list
+ [ {
+ "label" : "bank",
+ "name" : "Bank account owner's name",
+ "iban" : "DE370758",
+ "bic" : "SANDBOXX"
+ }, {
+ "label" : "testacct01",
+ "name" : "Bank account owner's name",
+ "iban" : "DE18500105172929531888",
+ "bic" : "INGDDEFFXXX"
+ } ]
+
+Note that ``testacct01``, ``DE18500105172929531888``, and ``INGDDEFFXXX``
+are the same as specified in the ``ebicsbankaccount create`` example
+(see above).
+
+The remaining ``bankaccount`` commands deal with transactions
+to and from the bank accounts.
+
+The ``bankaccount generate-transactions`` command generates
+test transactions.
+It takes one arg, the account label.
+
+For example:
+
+.. code-block:: console
+
+ $ libeufin-cli sandbox bankaccount generate-transactions testacct01
+
+Note that ``testacct01`` is the account label shown in the ``bankaccount
+list`` example (see above).
+
+The ``bankaccount simulate-incoming-transaction`` books an
+incoming payment in the sandbox.
+It takes one arg, the account label, and several options.
+
+::
+
+ --debtor-iban TEXT IBAN sending the payment
+ --debtor-bic TEXT BIC sending the payment
+ --debtor-name TEXT name of the person who is sending the payment
+ --amount TEXT amount, no currency
+ --subject TEXT payment subject
+
+For example:
+
+.. code-block:: console
+
+ $ libeufin-cli sandbox bankaccount simulate-incoming-transaction
+ testacct01 \
+ --debtor-iban DE06500105174526623718 \
+ --debtor-bic INGDDEFFXXX \
+ --debtor-name "Joe Foo" \
+ --subject "Hello World" \
+ --amount 10.50
+
+Note that ``testacct01`` is the same as in previous examples (see above),
+and that ``10.50`` is in ``X.Y`` format.
+
+The ``bankaccount transactions`` command lists transactions.
+It takes one arg, the account label.
+
+For example:
+
+.. code-block:: console
+
+ $ libeufin-cli sandbox bankaccount transactions testacct01
+ {
+ "payments" : [ {
+ "accountLabel" : "testacct01",
+ "creditorIban" : "DE18500105172929531888",
+ "creditorBic" : "INGDDEFFXXX",
+ "creditorName" : "Creditor Name",
+ "debtorIban" : "DE64500105178797276788",
+ "debtorBic" : "DEUTDEBB101",
+ "debtorName" : "Max Mustermann",
+ "amount" : "5",
+ "currency" : "EUR",
+ "subject" : "sample transaction DILWBJHL",
+ "date" : "Wed, 26 Jan 2022 09:03:44 GMT",
+ "creditDebitIndicator" : "credit",
+ "accountServicerReference" : "DILWBJHL",
+ "paymentInformationId" : null
+ }, {
+ "accountLabel" : "testacct01",
+ "creditorIban" : "DE64500105178797276788",
+ "creditorBic" : "DEUTDEBB101",
+ "creditorName" : "Max Mustermann",
+ "debtorIban" : "DE18500105172929531888",
+ "debtorBic" : "INGDDEFFXXX",
+ "debtorName" : "Debitor Name",
+ "amount" : "12",
+ "currency" : "EUR",
+ "subject" : "sample transaction N7JSY17B",
+ "date" : "Wed, 26 Jan 2022 09:03:44 GMT",
+ "creditDebitIndicator" : "debit",
+ "accountServicerReference" : "N7JSY17B",
+ "paymentInformationId" : null
+ }, {
+ "accountLabel" : "testacct01",
+ "creditorIban" : "DE18500105172929531888",
+ "creditorBic" : "INGDDEFFXXX",
+ "creditorName" : "Creditor Name",
+ "debtorIban" : "DE06500105174526623718",
+ "debtorBic" : "INGDDEFFXXX",
+ "debtorName" : "Joe Foo",
+ "amount" : "10.50",
+ "currency" : "EUR",
+ "subject" : "Hello World",
+ "date" : "Wed, 26 Jan 2022 09:04:31 GMT",
+ "creditDebitIndicator" : "credit",
+ "accountServicerReference" : "sandbox-6UI2J3636J9EESXO",
+ "paymentInformationId" : null
+ } ]
+ }
+
+Note that ``testacct01`` is the same as in previous examples (see above),
+and that the generated transactions from previous examples are listed,
+as well.
+
+
+sandbox demobank
+----------------
+
+subcommands for the 'demobank' model and the Access API -- WRITEME
users