taler-docs

commit 32e5ffa8475bf357303d619cbc4cc3abb9cd95c3
parent 6d429fbe7b038f64c62652de3807c80ea845e289
Author: Florian Dold <florian@dold.me>
Date:   Thu, 13 Jun 2024 14:33:17 +0200

update wallet-core API docs

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

1 file changed, 86 insertions(+), 11 deletions(-)
diff --git a/wallet/wallet-core.md b/wallet/wallet-core.md
@@ -64,6 +64,7 @@ This file is auto-generated from [wallet-core](https://git.taler.net/wallet-core
 * [SetExchangeTosAcceptedOp](#setexchangetosacceptedop)
 * [SetExchangeTosForgottenOp](#setexchangetosforgottenop)
 * [GetExchangeTosOp](#getexchangetosop)
+* [GetDepositWireTypesForCurrencyOp](#getdepositwiretypesforcurrencyop)
 * [GetExchangeDetailedInfoOp](#getexchangedetailedinfoop)
 * [GetExchangeEntryByUrlOp](#getexchangeentrybyurlop)
 * [GetExchangeResourcesOp](#getexchangeresourcesop)
@@ -122,6 +123,7 @@ This file is auto-generated from [wallet-core](https://git.taler.net/wallet-core
 * [TestingWaitTransactionStateOp](#testingwaittransactionstateop)
 * [TestingPingOp](#testingpingop)
 * [TestingGetReserveHistoryOp](#testinggetreservehistoryop)
+* [TestingResetAllRetriesOp](#testingresetallretriesop)
 * [TestingGetDenomStatsOp](#testinggetdenomstatsop)
 * [SetCoinSuspendedOp](#setcoinsuspendedop)
 * [ForceRefreshOp](#forcerefreshop)
@@ -373,7 +375,7 @@ export type ConvertDepositAmountOp = {
   request: ConvertAmountRequest;
   response: AmountResponse;
 };
-// ConvertDepositAmount = "ConvertDepositAmount"
+// ConvertDepositAmount = "convertDepositAmount"
 
 ```
 
@@ -384,7 +386,7 @@ export type GetMaxDepositAmountOp = {
   request: GetAmountRequest;
   response: AmountResponse;
 };
-// GetMaxDepositAmount = "GetMaxDepositAmount"
+// GetMaxDepositAmount = "getMaxDepositAmount"
 
 ```
 
@@ -406,7 +408,7 @@ export type GetMaxPeerPushAmountOp = {
   request: GetAmountRequest;
   response: AmountResponse;
 };
-// GetMaxPeerPushAmount = "GetMaxPeerPushAmount"
+// GetMaxPeerPushAmount = "getMaxPeerPushAmount"
 
 ```
 
@@ -417,7 +419,7 @@ export type ConvertWithdrawalAmountOp = {
   request: ConvertAmountRequest;
   response: AmountResponse;
 };
-// ConvertWithdrawalAmount = "ConvertWithdrawalAmount"
+// ConvertWithdrawalAmount = "convertWithdrawalAmount"
 
 ```
 
@@ -782,13 +784,12 @@ export type PrepareBankIntegratedWithdrawalOp = {
 ```typescript
 export interface PrepareBankIntegratedWithdrawalRequest {
   talerWithdrawUri: string;
-  selectedExchange?: string;
 }
 
 ```
 ```typescript
 export interface PrepareBankIntegratedWithdrawalResponse {
-  transactionId?: string;
+  transactionId: TransactionIdStr;
   info: WithdrawUriInfoResponse;
 }
 
@@ -838,6 +839,13 @@ export interface AcceptBankIntegratedWithdrawalRequest {
   talerWithdrawUri: string;
   exchangeBaseUrl: string;
   forcedDenomSel?: ForcedDenomSel;
+  /**
+   * Amount to withdraw.
+   * If the bank's withdrawal operation uses a fixed amount,
+   * this field must either be left undefined or its value must match
+   * the amount from the withdrawal operation.
+   */
+  amount?: AmountString;
   restrictAge?: number;
 }
 
@@ -969,7 +977,6 @@ export type CheckPayTemplateReponse = {
 export interface WalletTemplateDetails {
   template_contract: TemplateContractDetails;
   editable_defaults?: TemplateContractDetailsDefaults;
-  required_currency?: string;
 }
 
 ```
@@ -1575,7 +1582,7 @@ export type SetExchangeTosForgottenOp = {
   request: AcceptExchangeTosRequest;
   response: EmptyObject;
 };
-// SetExchangeTosForgotten = "SetExchangeTosForgotten"
+// SetExchangeTosForgotten = "setExchangeTosForgotten"
 
 ```
 
@@ -1634,6 +1641,45 @@ export interface GetExchangeTosResult {
 
 ```
 
+### GetDepositWireTypesForCurrencyOp
+```typescript
+/**
+ * Get wire types that can be used for a deposit operation
+ * with the provided currency.
+ */
+export type GetDepositWireTypesForCurrencyOp = {
+  op: WalletApiOperation.GetDepositWireTypesForCurrency;
+  request: GetDepositWireTypesForCurrencyRequest;
+  response: GetDepositWireTypesForCurrencyResponse;
+};
+// GetDepositWireTypesForCurrency = "getDepositWireTypesForCurrency"
+
+```
+```typescript
+export interface GetDepositWireTypesForCurrencyRequest {
+  currency: string;
+  /**
+   * Optional scope info to further restrict the result.
+   * Currency must match the currency field.
+   */
+  scopeInfo?: ScopeInfo;
+}
+
+```
+```typescript
+/**
+ * Response with wire types that are supported for a deposit.
+ *
+ * In the future, we might surface more information here, such as debit restrictions
+ * by the exchange, which then can be shown by UIs to the user before they
+ * enter their payment information.
+ */
+export interface GetDepositWireTypesForCurrencyResponse {
+  wireTypes: string[];
+}
+
+```
+
 ### GetExchangeDetailedInfoOp
 ```typescript
 /**
@@ -3128,6 +3174,21 @@ export type TestingGetReserveHistoryOp = {
 
 ```
 
+### TestingResetAllRetriesOp
+```typescript
+/**
+ * Reset all task/transaction retries,
+ * resulting in immediate re-try of all operations.
+ */
+export type TestingResetAllRetriesOp = {
+  op: WalletApiOperation.TestingResetAllRetries;
+  request: EmptyObject;
+  response: EmptyObject;
+};
+// TestingResetAllRetries = "testingResetAllRetries"
+
+```
+
 ### TestingGetDenomStatsOp
 ```typescript
 /**
@@ -3352,9 +3413,15 @@ export declare enum TransactionAmountMode {
 export interface ConvertAmountRequest {
   amount: AmountString;
   type: TransactionAmountMode;
+  depositPaytoUri: PaytoString;
 }
 ```
 ```typescript
+export type PaytoString = string & {
+  [__payto_str]: true;
+};
+```
+```typescript
 export interface AmountResponse {
   effectiveAmount: AmountString;
   rawAmount: AmountString;
@@ -3394,7 +3461,7 @@ export interface TransactionWithdrawal extends TransactionCommon {
   /**
    * Exchange of the withdrawal.
    */
-  exchangeBaseUrl: string;
+  exchangeBaseUrl: string | undefined;
   /**
    * Amount that got subtracted from the reserve balance.
    */
@@ -3495,8 +3562,10 @@ export declare enum TransactionMajorState {
   Done = "done",
   Aborting = "aborting",
   Aborted = "aborted",
-  Suspended = "suspended",
   Dialog = "dialog",
+  Finalizing = "finalizing",
+  Suspended = "suspended",
+  SuspendedFinalizing = "suspended-finalizing",
   SuspendedAborting = "suspended-aborting",
   Failed = "failed",
   Expired = "expired",
@@ -4099,8 +4168,13 @@ export interface WithdrawUriInfoResponse {
   operationId: string;
   status: WithdrawalOperationStatus;
   confirmTransferUrl?: string;
-  amount: AmountString;
+  currency: string;
+  amount: AmountString | undefined;
+  editableAmount: boolean;
+  maxAmount: AmountString | undefined;
+  wireFee: AmountString | undefined;
   defaultExchangeBaseUrl?: string;
+  editableExchange: boolean;
   possibleExchanges: ExchangeListItem[];
 }
 ```
@@ -4147,6 +4221,7 @@ export declare enum ExchangeTosStatus {
   Pending = "pending",
   Proposed = "proposed",
   Accepted = "accepted",
+  MissingTos = "missing-tos",
 }
 ```
 ```typescript