[taler-docs] branch master updated: update wallet-core API docs

[gnunet]

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

dold pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new d69d6993 update wallet-core API docs
d69d6993 is described below

commit d69d69930100fbe679d57771ecadbec4ffcc584a
Author: Florian Dold <florian@dold.me>
AuthorDate: Tue Nov 28 11:43:22 2023 +0100

    update wallet-core API docs
---
 wallet/wallet-core.md | 77 ++++++++++++++++++++++++++++++---------------------
 1 file changed, 46 insertions(+), 31 deletions(-)

diff --git a/wallet/wallet-core.md b/wallet/wallet-core.md
index 4ebd7b43..2e34fb4f 100644
--- a/wallet/wallet-core.md
+++ b/wallet/wallet-core.md
@@ -595,9 +595,9 @@ export interface ManualWithdrawalDetails {
    */
   paytoUris: string[];
   /**
-   * Ways to pay the exchange, including
+   * Ways to pay the exchange, including accounts that require currency 
conversion.
    */
-  withdrawalAccountList: WithdrawalAccountInfo[];
+  withdrawalAccountList: WithdrawalExchangeAccountDetails[];
   /**
    * If the exchange supports age-restricted coins it will return
    * the array of ages.
@@ -698,7 +698,7 @@ export interface AcceptManualWithdrawalResult {
    * Public key of the newly created reserve.
    */
   reservePub: string;
-  withdrawalAccountsList: WithdrawalAccountInfo[];
+  withdrawalAccountsList: WithdrawalExchangeAccountDetails[];
   transactionId: TransactionIdStr;
 }
 
@@ -1339,27 +1339,6 @@ export interface ExchangeWireAccount {
   master_sig: EddsaSignatureString;
 }
 
-```
-```typescript
-export type AccountRestriction =
-  | RegexAccountRestriction
-  | DenyAllAccountRestriction;
-
-```
-```typescript
-export interface RegexAccountRestriction {
-  type: "regex";
-  payto_regex: string;
-  human_hint: string;
-  human_hint_i18n?: InternationalizedString;
-}
-
-```
-```typescript
-export interface DenyAllAccountRestriction {
-  type: "deny";
-}
-
 ```
 ```typescript
 export interface FeeDescription {
@@ -3323,7 +3302,7 @@ interface WithdrawalDetailsForManualTransfer {
    * @deprecated in favor of exchangeCreditAccounts
    */
   exchangePaytoUris: string[];
-  exchangeCreditAccounts?: WithdrawalAccountInfo[];
+  exchangeCreditAccountDetails?: WithdrawalExchangeAccountDetails[];
   reservePub: string;
   /**
    * Is the reserve ready for withdrawal?
@@ -3332,9 +3311,50 @@ interface WithdrawalDetailsForManualTransfer {
 }
 ```
 ```typescript
-export interface WithdrawalAccountInfo {
+export interface WithdrawalExchangeAccountDetails {
+  /**
+   * Payto URI to credit the exchange.
+   *
+   * Depending on whether the (manual!) withdrawal is accepted or just
+   * being checked, this already includes the subject with the
+   * reserve public key.
+   */
   paytoUri: string;
+  /**
+   * Transfer amount. Might be in a different currency than the requested
+   * amount for withdrawal.
+   *
+   * Redundant with the amount in paytoUri, just included to avoid parsing.
+   */
   transferAmount: AmountString;
+  /**
+   * Further restrictions for sending money to the
+   * exchange.
+   */
+  creditRestrictions?: AccountRestriction[];
+}
+```
+```typescript
+export type AccountRestriction =
+  | RegexAccountRestriction
+  | DenyAllAccountRestriction;
+```
+```typescript
+export interface RegexAccountRestriction {
+  type: "regex";
+  payto_regex: string;
+  human_hint: string;
+  human_hint_i18n?: InternationalizedString;
+}
+```
+```typescript
+export interface InternationalizedString {
+  [lang_tag: string]: string;
+}
+```
+```typescript
+export interface DenyAllAccountRestriction {
+  type: "deny";
 }
 ```
 ```typescript
@@ -3465,11 +3485,6 @@ export interface Location {
 }
 ```
 ```typescript
-export interface InternationalizedString {
-  [lang_tag: string]: string;
-}
-```
-```typescript
 export interface RefundInfoShort {
   transactionId: string;
   timestamp: TalerProtocolTimestamp;

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