taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

commit 82be8ad8d57ae4fc552fcc2aeb711569cd4c01bf
parent 87b539423051b635e26e2529e4a749b4693f2c3a
Author: Özgür Kesim <oec-taler@kesim.org>
Date:   Mon, 29 Dec 2025 12:05:26 +0100

fix/add various typescript defs

Diffstat:
Mcore/api-common.rst | 8+++++++-
Mcore/api-merchant.rst | 12++++++------
2 files changed, 13 insertions(+), 7 deletions(-)

diff --git a/core/api-common.rst b/core/api-common.rst @@ -95,7 +95,7 @@ handle the error as if an internal error (500) had been returned. // Numeric `error code <error-codes>` unique to the condition. // The other arguments are specific to the error value reported here. - code: Integer; + code: ErrorCode; // Human-readable description of the error, i.e. "missing parameter", "commitment violation", ... // Should give a human-readable hint about the error's nature. Optional, may change without notice! @@ -132,6 +132,12 @@ handle the error as if an internal error (500) had been returned. extra?: Object; } + .. ts:def:: ErrorCode + + // Numeric `error code <error-codes>` unique to the condition. + // The other arguments are specific to the error value reported here. + type ErrorCode = Integer; + ----------------------- Protocol Version Ranges ----------------------- diff --git a/core/api-merchant.rst b/core/api-merchant.rst @@ -3754,7 +3754,7 @@ Inspecting groups group_name: string; // Description for the group. - description: String; + description: string; } @@ -3854,7 +3854,7 @@ Creating orders can be used to determine details about how to proceed with the KYC process. The body is an `ErrorDetail` with an error - code of `MERCHANT_POST_ORDERS_ID_PAY_EXCHANGE_LEGALLY_REFUSED`. + code of ``MERCHANT_POST_ORDERS_ID_PAY_EXCHANGE_LEGALLY_REFUSED``. **Details:** @@ -4639,7 +4639,7 @@ Approving Refunds staff needs to find another way to give a refund to the customer. The body is an `ErrorDetail` with an error - code of `MERCHANT_POST_ORDERS_ID_REFUND_EXCHANGE_TRANSACTION_LIMIT_VIOLATION`. + code of ``MERCHANT_POST_ORDERS_ID_REFUND_EXCHANGE_TRANSACTION_LIMIT_VIOLATION``. **Details:** @@ -4971,7 +4971,7 @@ to validate that a customer made a payment. // "NONE" or 0: No algorithm (no pos confirmation will be generated) // "TOTP_WITHOUT_PRICE" or 1: Without amounts (typical OTP device) // "TOTP_WITH_PRICE" or 2: With amounts (special-purpose OTP device) - // The "String" variants are supported @since protocol **v7**. + // The "string" variants are supported @since protocol **v7**. otp_algorithm: Integer | string; // Counter for counter-based OTP devices. @@ -5928,7 +5928,7 @@ Inspecting reporting schedules report_serial: Integer; // Description for the report. - description: String; + description: string; // Frequency for the report. report_frequency: RelativeTime; @@ -6585,7 +6585,7 @@ Listing charity instances charity_name: string; // EdDSA public key of the charity (binary) - charity_pub_key: Bytes; + charity_pub_key: EddsaPublicKey; // Charity identifier inside the Donau service charity_id: Integer;