[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-docs] branch master updated: update wallet-core docs
From: |
gnunet |
Subject: |
[taler-docs] branch master updated: update wallet-core docs |
Date: |
Wed, 04 Dec 2024 23:09:05 +0100 |
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 9d9edbae update wallet-core docs
9d9edbae is described below
commit 9d9edbae0dfacdbb513013260263783dd8735594
Author: Florian Dold <florian@dold.me>
AuthorDate: Wed Dec 4 23:09:02 2024 +0100
update wallet-core docs
---
wallet/wallet-core.md | 97 ++++++++++++++++++++++++++++++++++++++++-----------
1 file changed, 76 insertions(+), 21 deletions(-)
diff --git a/wallet/wallet-core.md b/wallet/wallet-core.md
index 8a543087..1ab64d37 100644
--- a/wallet/wallet-core.md
+++ b/wallet/wallet-core.md
@@ -619,6 +619,11 @@ export type GetTransactionByIdOp = {
```typescript
export interface TransactionByIdRequest {
transactionId: string;
+ /**
+ * If set to true, report the full contract terms in the response
+ * if the transaction has them.
+ */
+ includeContractTerms?: boolean;
}
```
@@ -4135,6 +4140,12 @@ export interface TransactionPayment extends
TransactionCommon {
* Additional information about the payment.
*/
info: OrderShortInfo;
+ /**
+ * Full contract terms.
+ *
+ * Only included if explicitly included in the request.
+ */
+ contractTerms?: ContractTerms;
/**
* Amount that must be paid for the contract
*/
@@ -4231,6 +4242,71 @@ export interface Location {
}
```
```typescript
+export interface ContractTerms {
+ summary: string;
+ summary_i18n?: {
+ [lang_tag: string]: string;
+ };
+ order_id: string;
+ amount: AmountString;
+ public_reorder_url?: string;
+ fulfillment_url?: string;
+ fulfillment_message?: string;
+ fulfillment_message_i18n?: {
+ [lang_tag: string]: string;
+ };
+ max_fee: AmountString;
+ products: Product[];
+ timestamp: Timestamp;
+ refund_deadline: Timestamp;
+ pay_deadline: Timestamp;
+ wire_transfer_deadline: Timestamp;
+ merchant_pub: EddsaPublicKey;
+ merchant_base_url: string;
+ merchant: Merchant;
+ h_wire: HashCode;
+ wire_method: string;
+ exchanges: Exchange[];
+ delivery_location?: Location;
+ delivery_date?: Timestamp;
+ nonce: string;
+ auto_refund?: RelativeTime;
+ extra?: any;
+ minimum_age?: Integer;
+}
+```
+```typescript
+export interface Product {
+ product_id?: string;
+ description: string;
+ description_i18n?: {
+ [lang_tag: string]: string;
+ };
+ quantity?: Integer;
+ unit?: string;
+ price?: AmountString;
+ image?: ImageDataUrl;
+ taxes?: Tax[];
+ delivery_date?: Timestamp;
+}
+```
+```typescript
+export interface Tax {
+ name: string;
+ tax: AmountString;
+}
+```
+```typescript
+export interface Merchant {
+ name: string;
+ email?: string;
+ website?: string;
+ logo?: ImageDataUrl;
+ address?: Location;
+ jurisdiction?: Location;
+}
+```
+```typescript
export interface RefundInfoShort {
transactionId: string;
timestamp: TalerProtocolTimestamp;
@@ -4684,27 +4760,6 @@ export interface MerchantContractTerms {
}
```
```typescript
-export interface Product {
- product_id?: string;
- description: string;
- description_i18n?: {
- [lang_tag: string]: string;
- };
- quantity?: Integer;
- unit?: string;
- price?: AmountString;
- image?: ImageDataUrl;
- taxes?: Tax[];
- delivery_date?: Timestamp;
-}
-```
-```typescript
-export interface Tax {
- name: string;
- tax: AmountString;
-}
-```
-```typescript
/**
* Detailed reason for why the wallet's balance is insufficient.
*/
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.