taler-docs

commit 23905f0b5664f5798b346403eec4f0f910e9de2a
parent 92288b2ecfcc77a4123c9bdcec61750cd2da2947
Author: Florian Dold <florian@dold.me>
Date:   Wed, 30 Oct 2024 16:53:11 +0100

update wallet-core API docs

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

1 file changed, 12 insertions(+), 37 deletions(-)
diff --git a/wallet/wallet-core.md b/wallet/wallet-core.md
@@ -1112,8 +1112,7 @@ export type GetContractTermsDetailsOp = {
 ```
 ```typescript
 export interface GetContractTermsDetailsRequest {
-  proposalId?: string;
-  transactionId?: string;
+  transactionId: string;
 }
 
 ```
@@ -1180,11 +1179,7 @@ export type ConfirmPayOp = {
 ```
 ```typescript
 export interface ConfirmPayRequest {
-  /**
-   * @deprecated use transactionId instead
-   */
-  proposalId?: string;
-  transactionId?: TransactionIdStr;
+  transactionId: TransactionIdStr;
   sessionId?: string;
   forcedCoinSel?: ForcedCoinSel;
 }
@@ -2602,10 +2597,6 @@ export interface PreparePeerPushCreditResponse {
   exchangeBaseUrl: string;
   scopeInfo: ScopeInfo;
   /**
-   * @deprecated use transaction ID instead.
-   */
-  peerPushCreditId: string;
-  /**
    * @deprecated
    */
   amount: AmountString;
@@ -2751,10 +2742,6 @@ export interface PreparePeerPullDebitResponse {
   exchangeBaseUrl: string;
   scopeInfo: ScopeInfo;
   /**
-   * @deprecated Use transactionId instead
-   */
-  peerPullDebitId: string;
-  /**
    * @deprecated Redundant field with bad name, will be removed soon.
    */
   amount: AmountString;
@@ -4610,9 +4597,12 @@ export interface PreparePayResultInsufficientBalance {
   status: PreparePayResultType.InsufficientBalance;
   transactionId: TransactionIdStr;
   /**
-   * @deprecated use transactionId
+   * Scopes involved in this transaction.
+   *
+   * For the insufficient balance response, contains scopes
+   * of *possible* payment providers.
    */
-  proposalId: string;
+  scopes: ScopeInfo[];
   contractTerms: MerchantContractTerms;
   amountRaw: AmountString;
   talerUri: string;
@@ -4735,11 +4725,11 @@ export interface PreparePayResultAlreadyConfirmed {
   paid: boolean;
   amountRaw: AmountString;
   amountEffective: AmountString | undefined;
-  contractTermsHash: string;
   /**
-   * @deprecated use transactionId
+   * Scopes involved in this transaction.
    */
-  proposalId: string;
+  scopes: ScopeInfo[];
+  contractTermsHash: string;
   talerUri: string;
 }
 ```
@@ -4752,15 +4742,9 @@ export interface PreparePayResultPaymentPossible {
   transactionId: TransactionIdStr;
   contractTerms: MerchantContractTerms;
   /**
-   * Details per currecy scope.
-   *
-   * Typically, only one scope is involved.
-   *
-   * In later versions, we might return more info here,
-   * such as the amount that each scope contributes
-   * to the transaction
+   * Scopes involved in this transaction.
    */
-  detailsPerScope: PerScopeDetails[];
+  scopes: ScopeInfo[];
   amountRaw: AmountString;
   amountEffective: AmountString;
   /**
@@ -4771,15 +4755,6 @@ export interface PreparePayResultPaymentPossible {
    * FIXME: Unclear why this is needed!  Remove?
    */
   talerUri: string;
-  /**
-   * @deprecated use transactionId instead
-   */
-  proposalId: string;
-}
-```
-```typescript
-export interface PerScopeDetails {
-  scopeInfo: ScopeInfo;
 }
 ```
 ```typescript