[taler-docs] branch master updated: document #6363

[gnunet]

This is an automated email from the git hooks/post-receive script.

grothoff pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new 51fc9f0  document #6363
51fc9f0 is described below

commit 51fc9f0d4a9cf32e7304e8e0edb08c612482f7c9
Author: Christian Grothoff <christian@grothoff.org>
AuthorDate: Wed Apr 12 16:09:37 2023 +0200

    document #6363
---
 conf.py                                 | 14 +++++++
 core/api-merchant.rst                   | 16 ++++++++
 manpages/taler-merchant-webhook.1.rst   | 62 ++++++++++++++++++++++++++++++
 manpages/taler-merchant-wirewatch.1.rst | 68 +++++++++++++++++++++++++++++++++
 manpages/taler.conf.5.rst               | 22 +++++++++++
 5 files changed, 182 insertions(+)

diff --git a/conf.py b/conf.py
index b4e2927..df8fa96 100644
--- a/conf.py
+++ b/conf.py
@@ -481,6 +481,20 @@ man_pages = [
         "GNU Taler contributors",
         1,
     ),
+    (
+        "manpages/taler-merchant-webhook.1",
+        "taler-merchant-webhook",
+        "execute webhooks of the Taler merchant backend (optional service)",
+        "GNU Taler contributors",
+        1,
+    ),
+    (
+        "manpages/taler-merchant-wirewatch.1",
+        "taler-merchant-wirewatch",
+        "import credit transactions from a merchant bank account into merchant 
backend (optional)",
+        "GNU Taler contributors",
+        1,
+    ),
     (
         "manpages/taler-merchant-setup-reserve.1",
         "taler-merchant-setup-reserve",
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
index 57a669a..8cbdbe9 100644
--- a/core/api-merchant.rst
+++ b/core/api-merchant.rst
@@ -912,6 +912,11 @@ Setting up instances
       // Merchant name corresponding to this instance.
       name: string;
 
+      // Type of the user (business or individual).
+      // Defaults to 'business'. Should become mandatory field
+      // in the future, left as optional for API compatibility for now.
+      user_type?: string;
+
       // Merchant email for customer contact.
       email?: string;
 
@@ -1025,6 +1030,11 @@ Setting up instances
       // Merchant name corresponding to this instance.
       name: string;
 
+      // Type of the user (business or individual).
+      // Defaults to 'business'. Should become mandatory field
+      // in the future, left as optional for API compatibility for now.
+      user_type?: string;
+
       // Merchant email for customer contact.
       email?: string;
 
@@ -1099,6 +1109,9 @@ Inspecting instances
       // Merchant name corresponding to this instance.
       name: string;
 
+      // Type of the user ("business" or "individual").
+      user_type: string;
+
       // Merchant public website.
       website?: string;
 
@@ -1145,6 +1158,9 @@ Inspecting instances
       // Merchant name corresponding to this instance.
       name: string;
 
+      // Type of the user ("business" or "individual").
+      user_type: string;
+
       // Merchant email for customer contact.
       email?: string;
 
diff --git a/manpages/taler-merchant-webhook.1.rst 
b/manpages/taler-merchant-webhook.1.rst
new file mode 100644
index 0000000..2d9b61c
--- /dev/null
+++ b/manpages/taler-merchant-webhook.1.rst
@@ -0,0 +1,62 @@
+taler-merchant-webhook(1)
+########################
+
+.. only:: html
+
+   Name
+   ====
+
+   **taler-merchant-webhook** - run webhooks of Taler merchant backend
+
+
+Synopsis
+========
+
+**taler-merchant-webhook**
+[**-c** *FILENAME* | **--config=**\ ‌\ *FILENAME*]
+[**-h** | **--help**]
+[**-L** *LOGLEVEL* | **--loglevel=**\ ‌\ *LOGLEVEL*]
+[**-l** *FILENAME* | **--logfile=**\ ‌\ *FILENAME*]
+[**-t** | **--test**]
+[**-v** | **--version**]
+
+Description
+===========
+
+**taler-merchant-webhook** is a command-line tool to trigger webhooks
+scheduled by a Taler merchant backend. It makes the necessary HTTP
+requests and updates the Taler merchant database accordingly.
+
+Its options are as follows:
+
+**-c** *FILENAME* \| **--config=**\ ‌\ *FILENAME*
+   Use the configuration and other resources for the merchant to operate
+   from *FILENAME*.
+
+**-h** \| **--help**
+   Print short help on options.
+
+**-L** *LOGLEVEL* \| **--loglevel=**\ ‌\ *LOGLEVEL*
+   Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``,
+   ``WARNING``, ``ERROR``.
+
+**-l** *FILENAME* \| **--logfile=**\ ‌\ *FILENAME*
+   Send logging output to *FILENAME*.
+
+**-t** \| **--test**
+   Run in test mode. Only runs until there are no more webhooks
+   to be executed.
+
+**-v** \| **–version**
+   Print version information.
+
+See Also
+========
+
+taler-merchant-httpd(1), taler.conf(5).
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net or by sending electronic
+mail to <taler@gnu.org>.
diff --git a/manpages/taler-merchant-wirewatch.1.rst 
b/manpages/taler-merchant-wirewatch.1.rst
new file mode 100644
index 0000000..54daa76
--- /dev/null
+++ b/manpages/taler-merchant-wirewatch.1.rst
@@ -0,0 +1,68 @@
+taler-merchant-wirewatch(1)
+###########################
+
+.. only:: html
+
+   Name
+   ====
+
+   **taler-merchant-wirewatch** - import bank transfers into Taler merchant 
backend
+
+
+Synopsis
+========
+
+**taler-merchant-wirewatch**
+[**-c** *FILENAME* | **--config=**\ ‌\ *FILENAME*]
+[**-h** | **--help**]
+[**-L** *LOGLEVEL* | **--loglevel=**\ ‌\ *LOGLEVEL*]
+[**-l** *FILENAME* | **--logfile=**\ ‌\ *FILENAME*]
+[**-t** | **--test**]
+[**-v** | **--version**]
+
+Description
+===========
+
+**taler-merchant-wirewatch** is a command-line tool to import
+information about incoming bank transfers into a Taler merchant
+backend. This will allow the merchant backend to validate that
+the exchange paid the merchant correctly.
+
+Its options are as follows:
+
+**-c** *FILENAME* \| **--config=**\ ‌\ *FILENAME*
+   Use the configuration and other resources for the merchant to operate
+   from *FILENAME*.
+
+**-h** \| **--help**
+   Print short help on options.
+
+**-L** *LOGLEVEL* \| **--loglevel=**\ ‌\ *LOGLEVEL*
+   Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``,
+   ``WARNING``, ``ERROR``.
+
+**-l** *FILENAME* \| **--logfile=**\ ‌\ *FILENAME*
+   Send logging output to *FILENAME*.
+
+**-s** *SECTION* \| **--section=**\ \ *SECTION*
+   Configuration section to use. Default is taler-merchant-wirewatch. Needed
+   if different processes are used to watch multiple bank accounts (for the
+   same instance or different instances).
+
+**-t** \| **--test**
+   Run in test mode. Only runs until the current list of bank
+   transactions are all imported.
+
+**-v** \| **–version**
+   Print version information.
+
+See Also
+========
+
+taler-merchant-httpd(1), taler.conf(5).
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net or by sending electronic
+mail to <taler@gnu.org>.
diff --git a/manpages/taler.conf.5.rst b/manpages/taler.conf.5.rst
index 3d83b8d..f1a5101 100644
--- a/manpages/taler.conf.5.rst
+++ b/manpages/taler.conf.5.rst
@@ -579,6 +579,28 @@ CURRENCY
   we use, which must be given in the ``[taler]`` section.
 
 
+MERCHANT WIREWATCH OPTIONS
+--------------------------
+
+The name of the configuration section used by taler-merchant-wirewatch
+can be changed via the command-line. By default, it is simply
+"[taler-merchant-wirewatch]".  The options are:
+
+INSTANCE
+  Which instance of the backend should transactions be imported for by this 
wirewatcher.
+WIRE_GATEWAY_URL
+  Under which URL is the wire gateway (libeufin facade) reachable that makes 
bank transfer data availalbe to us.
+WIRE_GATEWAY_AUTH_METHOD
+  Which authentication method should be used (currently only "NONE" or "BASIC" 
are supported).
+USERNAME
+  Username to give to the wire gateway when using "BASIC" authentication.
+PASSWORD
+  Password to give to the wire gateway when using "BASIC" authentication.
+
+Note that the libeufin facade type to configure for a taler-merchant-wirewatch
+operation is the "Anastasis" facade.
+
+
 AUDITOR OPTIONS
 ---------------
 

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.