taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

commit 9252b1c83a926c8ea573740f4730659ba2e8409f
parent 961f11d0e7aba981cf887740dbb9a3ddfe5e3d9f
Author: Florian Dold <florian@dold.me>
Date:   Mon,  9 Dec 2024 12:15:06 +0100

update wallet-core API docs

Diffstat:
Mwallet/wallet-core.md | 107+++++++++++++++++++++++++++++++++++++++++++++++++------------------------------
1 file changed, 67 insertions(+), 40 deletions(-)

diff --git a/wallet/wallet-core.md b/wallet/wallet-core.md @@ -57,9 +57,10 @@ This file is auto-generated from [wallet-core](https://git.taler.net/wallet-core * [PrepareWithdrawExchangeOp](#preparewithdrawexchangeop) * [AddExchangeOp](#addexchangeop) * [UpdateExchangeEntryOp](#updateexchangeentryop) -* [ListKnownBankAccountsOp](#listknownbankaccountsop) -* [AddKnownBankAccountsOp](#addknownbankaccountsop) -* [ForgetKnownBankAccountsOp](#forgetknownbankaccountsop) +* [ListBankAccountsOp](#listbankaccountsop) +* [GetBankAccountByIdOp](#getbankaccountbyidop) +* [AddBankAccountsOp](#addbankaccountsop) +* [ForgetBankAccountsOp](#forgetbankaccountsop) * [SetExchangeTosAcceptedOp](#setexchangetosacceptedop) * [SetExchangeTosForgottenOp](#setexchangetosforgottenop) * [GetExchangeTosOp](#getexchangetosop) @@ -1543,64 +1544,66 @@ export interface UpdateExchangeEntryRequest { ``` -### ListKnownBankAccountsOp +### ListBankAccountsOp ```typescript -export type ListKnownBankAccountsOp = { - op: WalletApiOperation.ListKnownBankAccounts; - request: ListKnownBankAccountsRequest; - response: ListKnownBankAccountsResponse; +export type ListBankAccountsOp = { + op: WalletApiOperation.ListBankAccounts; + request: ListBankAccountsRequest; + response: ListBankAccountsResponse; }; -// ListKnownBankAccounts = "listKnownBankAccounts" +// ListBankAccounts = "listBankAccounts" ``` ```typescript -export interface ListKnownBankAccountsRequest { +export interface ListBankAccountsRequest { currency?: string; } ``` ```typescript -export interface ListKnownBankAccountsResponse { - accounts: KnownBankAccountsInfo[]; +export interface ListBankAccountsResponse { + accounts: KnownBankAccountInfo[]; } ``` + +### GetBankAccountByIdOp ```typescript -export interface KnownBankAccountsInfo { - paytoUri: string; - /** - * Did we previously complete a KYC process for this bank account? - */ - kycCompleted: boolean; - /** - * Currencies supported by the bank, if known. - */ - currencies: string[] | undefined; - alias: string | undefined; +export type GetBankAccountByIdOp = { + op: WalletApiOperation.GetBankAccountById; + request: GetBankAccountByIdRequest; + response: GetBankAccountByIdResponse; +}; +// GetBankAccountById = "getBankAccountById" + +``` +```typescript +export interface GetBankAccountByIdRequest { + bankAccountId: string; } ``` -### AddKnownBankAccountsOp +### AddBankAccountsOp ```typescript -export type AddKnownBankAccountsOp = { - op: WalletApiOperation.AddKnownBankAccount; - request: AddKnownBankAccountRequest; - response: EmptyObject; +export type AddBankAccountsOp = { + op: WalletApiOperation.AddBankAccount; + request: AddBankAccountRequest; + response: AddBankAccountResponse; }; -// AddKnownBankAccount = "addKnownBankAccount" +// AddBankAccount = "addBankAccount" ``` ```typescript -export interface AddKnownBankAccountRequest { +export interface AddBankAccountRequest { /** * Payto URI of the bank account that should be added. */ paytoUri: string; /** - * Human-readable alias / label for the account. + * Human-readable label for the account. */ - alias: string; + label: string; /** * Currencies supported by the bank (if known). */ @@ -1608,24 +1611,33 @@ export interface AddKnownBankAccountRequest { /** * Bank account that this new account should replace. */ - replacePaytoUri?: string; + replaceBankAccountId?: string; } ``` +```typescript +export interface AddBankAccountResponse { + /** + * Identifier of the added bank account. + */ + bankAccountId: string; +} -### ForgetKnownBankAccountsOp +``` + +### ForgetBankAccountsOp ```typescript -export type ForgetKnownBankAccountsOp = { - op: WalletApiOperation.ForgetKnownBankAccount; - request: ForgetKnownBankAccountRequest; +export type ForgetBankAccountsOp = { + op: WalletApiOperation.ForgetBankAccount; + request: ForgetBankAccountRequest; response: EmptyObject; }; -// ForgetKnownBankAccount = "forgetKnownBankAccount" +// ForgetBankAccount = "forgetBankAccount" ``` ```typescript -export interface ForgetKnownBankAccountRequest { - paytoUri: string; +export interface ForgetBankAccountRequest { + bankAccountId: string; } ``` @@ -4873,6 +4885,21 @@ export interface AddExchangeRequest { } ``` ```typescript +export interface KnownBankAccountInfo { + bankAccountId: string; + paytoUri: string; + /** + * Did we previously complete a KYC process for this bank account? + */ + kycCompleted: boolean; + /** + * Currencies supported by the bank, if known. + */ + currencies: string[] | undefined; + label: string | undefined; +} +``` +```typescript export interface AcceptExchangeTosRequest { exchangeBaseUrl: string; }