commit 79fac5675f1dd20bfa45c6b61af85464b6208a08
parent b59a9caf64ebb3a93f79bd27936d8c7dcd39957e
Author: Florian Dold <florian@dold.me>
Date: Sun, 7 May 2023 22:48:01 +0200
wallet-core docs
Diffstat:
| M | wallet/wallet-core.md | | | 119 | +++++++++++++++++++++++-------------------------------------------------------- |
1 file changed, 34 insertions(+), 85 deletions(-)
diff --git a/wallet/wallet-core.md b/wallet/wallet-core.md
@@ -27,9 +27,8 @@ This file is auto-generated from [wallet-core](https://git.taler.net/wallet-core
* [PreparePayForTemplateOp](#preparepayfortemplateop)
* [GetContractTermsDetailsOp](#getcontracttermsdetailsop)
* [ConfirmPayOp](#confirmpayop)
-* [ApplyRefundOp](#applyrefundop)
-* [ApplyRefundFromPurchaseIdOp](#applyrefundfrompurchaseidop)
-* [PrepareRefundOp](#preparerefundop)
+* [StartRefundQueryForUriOp](#startrefundqueryforuriop)
+* [StartRefundQueryOp](#startrefundqueryop)
### Tipping
* [PrepareTipOp](#preparetipop)
* [AcceptTipOp](#accepttipop)
@@ -709,68 +708,39 @@ export interface ConfirmPayResultPending {
```
-### ApplyRefundOp
+### StartRefundQueryForUriOp
```typescript
/**
* Check for a refund based on a taler://refund URI.
*/
-export type ApplyRefundOp = {
- op: WalletApiOperation.ApplyRefund;
- request: ApplyRefundRequest;
- response: ApplyRefundResponse;
+export type StartRefundQueryForUriOp = {
+ op: WalletApiOperation.StartRefundQueryForUri;
+ request: PrepareRefundRequest;
+ response: EmptyObject;
};
-// ApplyRefund = "applyRefund"
+// StartRefundQueryForUri = "startRefundQueryForUri"
```
```typescript
-export interface ApplyRefundRequest {
+export interface PrepareRefundRequest {
talerRefundUri: string;
}
```
-### ApplyRefundFromPurchaseIdOp
-```typescript
-export type ApplyRefundFromPurchaseIdOp = {
- op: WalletApiOperation.ApplyRefundFromPurchaseId;
- request: ApplyRefundFromPurchaseIdRequest;
- response: ApplyRefundResponse;
-};
-// ApplyRefundFromPurchaseId = "applyRefundFromPurchaseId"
-
-```
-```typescript
-export interface ApplyRefundFromPurchaseIdRequest {
- purchaseId: string;
-}
-
-```
-
-### PrepareRefundOp
+### StartRefundQueryOp
```typescript
-export type PrepareRefundOp = {
- op: WalletApiOperation.PrepareRefund;
- request: PrepareRefundRequest;
- response: PrepareRefundResult;
+export type StartRefundQueryOp = {
+ op: WalletApiOperation.StartRefundQuery;
+ request: StartRefundQueryRequest;
+ response: EmptyObject;
};
-// PrepareRefund = "prepareRefund"
+// StartRefundQuery = "startRefundQuery"
```
```typescript
-export interface PrepareRefundRequest {
- talerRefundUri: string;
-}
-
-```
-```typescript
-export interface PrepareRefundResult {
- proposalId: string;
- effectivePaid: AmountString;
- gone: AmountString;
- granted: AmountString;
- pending: boolean;
- awaiting: AmountString;
- info: OrderShortInfo;
+export interface StartRefundQueryRequest {
+ transactionId: string;
}
```
@@ -2740,7 +2710,6 @@ export declare enum TransactionMajorState {
Aborting = "aborting",
Aborted = "aborted",
Suspended = "suspended",
- SuspendedDeletable = "suspended-deletable",
Dialog = "dialog",
SuspendedAborting = "suspended-aborting",
Failed = "failed",
@@ -2754,6 +2723,7 @@ export declare enum TransactionMinorState {
Deposit = "deposit",
KycRequired = "kyc",
AmlRequired = "aml",
+ MergeKycRequired = "merge-kyc",
Track = "track",
Pay = "pay",
RebindSession = "rebind-session",
@@ -2762,8 +2732,13 @@ export declare enum TransactionMinorState {
AutoRefund = "auto-refund",
User = "user",
Bank = "bank",
+ Exchange = "exchange",
ClaimProposal = "claim-proposal",
CheckRefunds = "check-refunds",
+ CreatePurse = "create-purse",
+ DeletePurse = "delete-purse",
+ Ready = "ready",
+ Merge = "merge",
Repurchase = "repurchase",
BankRegisterReserve = "bank-register-reserve",
BankConfirmTransfer = "bank-confirm-transfer",
@@ -2771,6 +2746,11 @@ export declare enum TransactionMinorState {
ExchangeWaitReserve = "exchange-wait-reserve",
AbortingBank = "aborting-bank",
Refused = "refused",
+ Withdraw = "withdraw",
+ MerchantOrderProposed = "merchant-order-proposed",
+ Proposed = "proposed",
+ RefundAvailable = "refund-available",
+ AcceptRefund = "accept-refund",
}
```
```typescript
@@ -3038,11 +3018,6 @@ export interface RefundInfoShort {
export interface TransactionRefund extends TransactionCommon {
type: TransactionType.Refund;
refundedTransactionId: string;
- info: OrderShortInfo;
- /**
- * Amount pending to be picked up
- */
- refundPending: AmountString | undefined;
amountRaw: AmountString;
amountEffective: AmountString;
}
@@ -3298,6 +3273,7 @@ export type PreparePayResult =
```typescript
export interface PreparePayResultInsufficientBalance {
status: PreparePayResultType.InsufficientBalance;
+ transactionId: string;
proposalId: string;
contractTerms: MerchantContractTerms;
amountRaw: string;
@@ -3338,10 +3314,6 @@ export interface MerchantContractTerms {
*/
amount: string;
/**
- * Auditors accepted by the merchant.
- */
- auditors: AuditorHandle[];
- /**
* Deadline to pay for the contract.
*/
pay_deadline: TalerProtocolTimestamp;
@@ -3428,22 +3400,6 @@ export interface MerchantContractTerms {
}
```
```typescript
-export interface AuditorHandle {
- /**
- * Official name of the auditor.
- */
- name: string;
- /**
- * Master public signing key of the auditor.
- */
- auditor_pub: string;
- /**
- * Base URL of the auditor.
- */
- url: string;
-}
-```
-```typescript
/**
* Information about an exchange as stored inside a
* merchant's contract terms.
@@ -3503,6 +3459,7 @@ export interface PayMerchantInsufficientBalanceDetails {
```typescript
export interface PreparePayResultAlreadyConfirmed {
status: PreparePayResultType.AlreadyConfirmed;
+ transactionId: string;
contractTerms: MerchantContractTerms;
paid: boolean;
amountRaw: string;
@@ -3518,6 +3475,10 @@ export interface PreparePayResultAlreadyConfirmed {
*/
export interface PreparePayResultPaymentPossible {
status: PreparePayResultType.PaymentPossible;
+ transactionId: string;
+ /**
+ * @deprecated use transactionId instead
+ */
proposalId: string;
contractTerms: MerchantContractTerms;
contractTermsHash: string;
@@ -3539,18 +3500,6 @@ export interface ForcedCoinSel {
}
```
```typescript
-export interface ApplyRefundResponse {
- contractTermsHash: string;
- transactionId: string;
- proposalId: string;
- amountEffectivePaid: AmountString;
- amountRefundGranted: AmountString;
- amountRefundGone: AmountString;
- pendingAtExchange: boolean;
- info: OrderShortInfo;
-}
-```
-```typescript
export interface AddExchangeRequest {
exchangeBaseUrl: string;
forceUpdate?: boolean;
