taler-docs

commit d9f7d8e3182bf43c9e226324ea3fe311949c952d
parent f7ac9fb9f68cf3b64c965eaf3079b186d919966a
Author: Florian Dold <florian@dold.me>
Date:   Tue, 22 Oct 2024 15:07:24 +0200

update wallet-core API docs

Diffstat:
M
wallet/wallet-core.md
 | 
55
+++++++++++++++++++++++++++++++++++++++----------------

1 file changed, 39 insertions(+), 16 deletions(-)
diff --git a/wallet/wallet-core.md b/wallet/wallet-core.md
@@ -736,7 +736,13 @@ export type GetWithdrawalDetailsForAmountOp = {
 ```
 ```typescript
 export interface GetWithdrawalDetailsForAmountRequest {
-  exchangeBaseUrl: string;
+  exchangeBaseUrl?: string;
+  /**
+   * Specify currency scope for the withdrawal.
+   *
+   * May only be used when exchangeBaseUrl is not specified.
+   */
+  restrictScope?: ScopeInfo;
   amount: AmountString;
   restrictAge?: number;
   /**
@@ -757,12 +763,9 @@ export interface GetWithdrawalDetailsForAmountRequest {
 ```typescript
 export interface WithdrawalDetailsForAmount {
   /**
-   * Did the user accept the current version of the exchange's
-   * terms of service?
-   *
-   * @deprecated the client should query the exchange entry instead
+   * Exchange base URL for the withdrawal.
    */
-  tosAccepted: boolean;
+  exchangeBaseUrl: string;
   /**
    * Amount that the user will transfer to the exchange.
    */
@@ -778,12 +781,6 @@ export interface WithdrawalDetailsForAmount {
    */
   numCoins: number;
   /**
-   * Ways to pay the exchange.
-   *
-   * @deprecated in favor of withdrawalAccountsList
-   */
-  paytoUris: string[];
-  /**
    * Ways to pay the exchange, including accounts that require currency conversion.
    */
   withdrawalAccountsList: WithdrawalExchangeAccountDetails[];
@@ -808,6 +805,19 @@ export interface WithdrawalDetailsForAmount {
    * Withdrawals over that amount will be denied.
    */
   kycHardLimit?: AmountString;
+  /**
+   * Ways to pay the exchange.
+   *
+   * @deprecated in favor of withdrawalAccountsList
+   */
+  paytoUris: string[];
+  /**
+   * Did the user accept the current version of the exchange's
+   * terms of service?
+   *
+   * @deprecated the client should query the exchange entry instead
+   */
+  tosAccepted: boolean;
 }
 
 ```
@@ -2510,6 +2520,9 @@ export interface CheckPeerPushDebitRequest {
 export interface CheckPeerPushDebitResponse {
   amountRaw: AmountString;
   amountEffective: AmountString;
+  /**
+   * Exchange base URL.
+   */
   exchangeBaseUrl: string;
   /**
    * Maximum expiration date, based on how close the coins
@@ -2587,6 +2600,7 @@ export interface PreparePeerPushCreditResponse {
   amountEffective: AmountString;
   transactionId: TransactionIdStr;
   exchangeBaseUrl: string;
+  scopeInfo: ScopeInfo;
   /**
    * @deprecated use transaction ID instead.
    */
@@ -2640,7 +2654,11 @@ export type CheckPeerPullCreditOp = {
 ```
 ```typescript
 export interface CheckPeerPullCreditRequest {
+  /**
+   * Require using this particular exchange for this operation.
+   */
   exchangeBaseUrl?: string;
+  restrictScope?: ScopeInfo;
   amount: AmountString;
   /**
    * ID provided by the client to cancel the request.
@@ -2727,14 +2745,19 @@ export interface PreparePeerPullDebitRequest {
 ```typescript
 export interface PreparePeerPullDebitResponse {
   contractTerms: PeerContractTerms;
+  amountRaw: AmountString;
+  amountEffective: AmountString;
+  transactionId: TransactionIdStr;
+  exchangeBaseUrl: string;
+  scopeInfo: ScopeInfo;
+  /**
+   * @deprecated Use transactionId instead
+   */
+  peerPullDebitId: string;
   /**
    * @deprecated Redundant field with bad name, will be removed soon.
    */
   amount: AmountString;
-  amountRaw: AmountString;
-  amountEffective: AmountString;
-  peerPullDebitId: string;
-  transactionId: TransactionIdStr;
 }
 
 ```