@meshtrade/api-web 1.30.0

package/dist/meshtrade/wallet/account/v1/index.js

@@ -0,0 +1,44 @@
+"use strict";
+// ===================================================================
+// AUTO-GENERATED SECTION - ONLY EDIT BELOW THE CLOSING COMMENT BLOCK
+// ===================================================================
+// This section is automatically managed by protoc-gen-meshts.
+//
+// DO NOT EDIT ANYTHING IN THIS SECTION MANUALLY!
+// Your changes will be overwritten during code generation.
+//
+// To add custom exports, scroll down to the
+// "MANUAL EXPORTS" section indicated below.
+// ===================================================================
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Generated exports
+__exportStar(require("./account_pb"), exports);
+__exportStar(require("./service_pb"), exports);
+__exportStar(require("./service_web_meshts"), exports);
+// ===================================================================
+// END OF AUTO-GENERATED SECTION
+// ===================================================================
+//
+// MANUAL EXPORTS - ADD YOUR CUSTOM EXPORTS BELOW
+//
+// You can safely add your own export statements in this section.
+// They will be preserved across code generation.
+//
+// Example:
+//   export * from "./my_custom_module";
+//   export { MyCustomClass } from "./another_module";
+// ===================================================================

package/dist/meshtrade/wallet/account/v1/service_pb.d.ts

@@ -0,0 +1,559 @@
+import type { GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
+import type { SortingOrder } from "../../../type/v1/sorting_pb";
+import type { Account, AccountSchema } from "./account_pb";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file meshtrade/wallet/account/v1/service.proto.
+ */
+export declare const file_meshtrade_wallet_account_v1_service: GenFile;
+/**
+ *
+ * Request to create a new account.
+ *
+ * @generated from message meshtrade.wallet.account.v1.CreateAccountRequest
+ */
+export type CreateAccountRequest = Message<"meshtrade.wallet.account.v1.CreateAccountRequest"> & {
+    /**
+     *
+     * The account configuration for creation.
+     * The name, number, ledger_id, and owners fields will be ignored and assigned by the system.
+     *
+     * @generated from field: meshtrade.wallet.account.v1.Account account = 1;
+     */
+    account?: Account;
+};
+/**
+ * Describes the message meshtrade.wallet.account.v1.CreateAccountRequest.
+ * Use `create(CreateAccountRequestSchema)` to create a new message.
+ */
+export declare const CreateAccountRequestSchema: GenMessage<CreateAccountRequest>;
+/**
+ *
+ * Request to update an existing account.
+ *
+ * @generated from message meshtrade.wallet.account.v1.UpdateAccountRequest
+ */
+export type UpdateAccountRequest = Message<"meshtrade.wallet.account.v1.UpdateAccountRequest"> & {
+    /**
+     *
+     * Complete account resource with updated fields.
+     * Only display_name can be modified.
+     *
+     * @generated from field: meshtrade.wallet.account.v1.Account account = 1;
+     */
+    account?: Account;
+};
+/**
+ * Describes the message meshtrade.wallet.account.v1.UpdateAccountRequest.
+ * Use `create(UpdateAccountRequestSchema)` to create a new message.
+ */
+export declare const UpdateAccountRequestSchema: GenMessage<UpdateAccountRequest>;
+/**
+ *
+ * Request to open an account on the ledger.
+ *
+ * @generated from message meshtrade.wallet.account.v1.OpenAccountRequest
+ */
+export type OpenAccountRequest = Message<"meshtrade.wallet.account.v1.OpenAccountRequest"> & {
+    /**
+     *
+     * The resource name of the account to open.
+     * Format: accounts/{ULIDv2}.
+     *
+     * @generated from field: string name = 1;
+     */
+    name: string;
+};
+/**
+ * Describes the message meshtrade.wallet.account.v1.OpenAccountRequest.
+ * Use `create(OpenAccountRequestSchema)` to create a new message.
+ */
+export declare const OpenAccountRequestSchema: GenMessage<OpenAccountRequest>;
+/**
+ *
+ * Response a transaction reference to monitor the ledger operation to open the account.
+ *
+ * @generated from message meshtrade.wallet.account.v1.OpenAccountResponse
+ */
+export type OpenAccountResponse = Message<"meshtrade.wallet.account.v1.OpenAccountResponse"> & {
+    /**
+     *
+     * Transaction reference for monitoring the ledger operation to open the account.
+     * The Account is open once this transaction has succeeded.
+     * Format: transactions/{ULIDv2}.
+     *
+     * @generated from field: string ledger_transaction = 1;
+     */
+    ledgerTransaction: string;
+};
+/**
+ * Describes the message meshtrade.wallet.account.v1.OpenAccountResponse.
+ * Use `create(OpenAccountResponseSchema)` to create a new message.
+ */
+export declare const OpenAccountResponseSchema: GenMessage<OpenAccountResponse>;
+/**
+ *
+ * Request to add signatories to an account on the ledger.
+ *
+ * @generated from message meshtrade.wallet.account.v1.AddSignatoriesToAccountRequest
+ */
+export type AddSignatoriesToAccountRequest = Message<"meshtrade.wallet.account.v1.AddSignatoriesToAccountRequest"> & {
+    /**
+     *
+     * The resource name of the account to which signatories should be added.
+     * Format: accounts/{ULIDv2}.
+     *
+     * @generated from field: string name = 1;
+     */
+    name: string;
+    /**
+     *
+     * The resource names of the (api)users to add as signatories on the identified account.
+     * Format: api_users/{ULIDv2} or users/{ULIDv2}.
+     * At least one user must be provided.
+     *
+     * @generated from field: repeated string users = 2;
+     */
+    users: string[];
+};
+/**
+ * Describes the message meshtrade.wallet.account.v1.AddSignatoriesToAccountRequest.
+ * Use `create(AddSignatoriesToAccountRequestSchema)` to create a new message.
+ */
+export declare const AddSignatoriesToAccountRequestSchema: GenMessage<AddSignatoriesToAccountRequest>;
+/**
+ *
+ * Response containing a transaction reference to monitor the ledger operation to add signatories.
+ *
+ * @generated from message meshtrade.wallet.account.v1.AddSignatoriesToAccountResponse
+ */
+export type AddSignatoriesToAccountResponse = Message<"meshtrade.wallet.account.v1.AddSignatoriesToAccountResponse"> & {
+    /**
+     *
+     * Transaction reference for monitoring the ledger operation to add the given users as signatories.
+     * The signatories are added once this transaction has succeeded.
+     * Format: transactions/{ULIDv2}.
+     *
+     * @generated from field: string ledger_transaction = 1;
+     */
+    ledgerTransaction: string;
+};
+/**
+ * Describes the message meshtrade.wallet.account.v1.AddSignatoriesToAccountResponse.
+ * Use `create(AddSignatoriesToAccountResponseSchema)` to create a new message.
+ */
+export declare const AddSignatoriesToAccountResponseSchema: GenMessage<AddSignatoriesToAccountResponse>;
+/**
+ *
+ * Request to remove signatories from an account on the ledger.
+ *
+ * @generated from message meshtrade.wallet.account.v1.RemoveSignatoriesFromAccountRequest
+ */
+export type RemoveSignatoriesFromAccountRequest = Message<"meshtrade.wallet.account.v1.RemoveSignatoriesFromAccountRequest"> & {
+    /**
+     *
+     * The resource name of the account from which signatories should be removed.
+     * Format: accounts/{ULIDv2}.
+     *
+     * @generated from field: string name = 1;
+     */
+    name: string;
+    /**
+     *
+     * The resource names of the (api)users to remove as signatories from the identified account.
+     * Format: api_users/{ULIDv2} or users/{ULIDv2}.
+     * At least one user must be provided.
+     *
+     * @generated from field: repeated string users = 2;
+     */
+    users: string[];
+};
+/**
+ * Describes the message meshtrade.wallet.account.v1.RemoveSignatoriesFromAccountRequest.
+ * Use `create(RemoveSignatoriesFromAccountRequestSchema)` to create a new message.
+ */
+export declare const RemoveSignatoriesFromAccountRequestSchema: GenMessage<RemoveSignatoriesFromAccountRequest>;
+/**
+ *
+ * Response containing a transaction reference to monitor the ledger operation to remove signatories.
+ *
+ * @generated from message meshtrade.wallet.account.v1.RemoveSignatoriesFromAccountResponse
+ */
+export type RemoveSignatoriesFromAccountResponse = Message<"meshtrade.wallet.account.v1.RemoveSignatoriesFromAccountResponse"> & {
+    /**
+     *
+     * Transaction reference for monitoring the ledger operation to remove the given users as signatories.
+     * The signatories are removed once this transaction has succeeded.
+     * Format: transactions/{ULIDv2}.
+     *
+     * @generated from field: string ledger_transaction = 1;
+     */
+    ledgerTransaction: string;
+};
+/**
+ * Describes the message meshtrade.wallet.account.v1.RemoveSignatoriesFromAccountResponse.
+ * Use `create(RemoveSignatoriesFromAccountResponseSchema)` to create a new message.
+ */
+export declare const RemoveSignatoriesFromAccountResponseSchema: GenMessage<RemoveSignatoriesFromAccountResponse>;
+/**
+ *
+ * Request to retrieve a specific account.
+ *
+ * @generated from message meshtrade.wallet.account.v1.GetAccountRequest
+ */
+export type GetAccountRequest = Message<"meshtrade.wallet.account.v1.GetAccountRequest"> & {
+    /**
+     *
+     * The resource name of the account to retrieve.
+     * Format: accounts/{ULIDv2}.
+     *
+     * @generated from field: string name = 1;
+     */
+    name: string;
+    /**
+     *
+     * When true, fetches current balances and state from the ledger.
+     * When false, returns only stored metadata without live data.
+     *
+     * @generated from field: bool populate_ledger_data = 2;
+     */
+    populateLedgerData: boolean;
+};
+/**
+ * Describes the message meshtrade.wallet.account.v1.GetAccountRequest.
+ * Use `create(GetAccountRequestSchema)` to create a new message.
+ */
+export declare const GetAccountRequestSchema: GenMessage<GetAccountRequest>;
+/**
+ *
+ * Request to retrieve an account by its account number.
+ *
+ * @generated from message meshtrade.wallet.account.v1.GetAccountByNumberRequest
+ */
+export type GetAccountByNumberRequest = Message<"meshtrade.wallet.account.v1.GetAccountByNumberRequest"> & {
+    /**
+     *
+     * The Account Number.
+     * Must be a 7-digit number starting with '1'.
+     *
+     * @generated from field: string account_number = 1;
+     */
+    accountNumber: string;
+    /**
+     *
+     * When true, fetches current balances and state from the ledger.
+     * When false, returns only stored metadata without live data.
+     *
+     * @generated from field: bool populate_ledger_data = 2;
+     */
+    populateLedgerData: boolean;
+};
+/**
+ * Describes the message meshtrade.wallet.account.v1.GetAccountByNumberRequest.
+ * Use `create(GetAccountByNumberRequestSchema)` to create a new message.
+ */
+export declare const GetAccountByNumberRequestSchema: GenMessage<GetAccountByNumberRequest>;
+/**
+ *
+ * Request to list all accounts in the hierarchy.
+ *
+ * @generated from message meshtrade.wallet.account.v1.ListAccountsRequest
+ */
+export type ListAccountsRequest = Message<"meshtrade.wallet.account.v1.ListAccountsRequest"> & {
+    /**
+     *
+     * Optional sorting configuration.
+     *
+     * @generated from field: meshtrade.wallet.account.v1.ListAccountsRequest.Sorting sorting = 1;
+     */
+    sorting?: ListAccountsRequest_Sorting;
+    /**
+     *
+     * When true, fetches current balances and state from the ledger.
+     * When false, returns only stored metadata without live data.
+     *
+     * @generated from field: bool populate_ledger_data = 2;
+     */
+    populateLedgerData: boolean;
+};
+/**
+ * Describes the message meshtrade.wallet.account.v1.ListAccountsRequest.
+ * Use `create(ListAccountsRequestSchema)` to create a new message.
+ */
+export declare const ListAccountsRequestSchema: GenMessage<ListAccountsRequest>;
+/**
+ *
+ * Sorting configuration for organizing results.
+ *
+ * @generated from message meshtrade.wallet.account.v1.ListAccountsRequest.Sorting
+ */
+export type ListAccountsRequest_Sorting = Message<"meshtrade.wallet.account.v1.ListAccountsRequest.Sorting"> & {
+    /**
+     *
+     * Field to sort by.
+     * Supported values: "number" or empty string for default ordering.
+     *
+     * @generated from field: string field = 1;
+     */
+    field: string;
+    /**
+     *
+     * Sort order for results.
+     *
+     * @generated from field: meshtrade.type.v1.SortingOrder order = 2;
+     */
+    order: SortingOrder;
+};
+/**
+ * Describes the message meshtrade.wallet.account.v1.ListAccountsRequest.Sorting.
+ * Use `create(ListAccountsRequest_SortingSchema)` to create a new message.
+ */
+export declare const ListAccountsRequest_SortingSchema: GenMessage<ListAccountsRequest_Sorting>;
+/**
+ *
+ * Response containing a list of accounts.
+ *
+ * @generated from message meshtrade.wallet.account.v1.ListAccountsResponse
+ */
+export type ListAccountsResponse = Message<"meshtrade.wallet.account.v1.ListAccountsResponse"> & {
+    /**
+     *
+     * Collection of accounts in the hierarchy.
+     *
+     * @generated from field: repeated meshtrade.wallet.account.v1.Account accounts = 1;
+     */
+    accounts: Account[];
+};
+/**
+ * Describes the message meshtrade.wallet.account.v1.ListAccountsResponse.
+ * Use `create(ListAccountsResponseSchema)` to create a new message.
+ */
+export declare const ListAccountsResponseSchema: GenMessage<ListAccountsResponse>;
+/**
+ *
+ * Request to search accounts with filtering criteria.
+ *
+ * @generated from message meshtrade.wallet.account.v1.SearchAccountsRequest
+ */
+export type SearchAccountsRequest = Message<"meshtrade.wallet.account.v1.SearchAccountsRequest"> & {
+    /**
+     *
+     * Optional sorting configuration.
+     *
+     * @generated from field: meshtrade.wallet.account.v1.SearchAccountsRequest.Sorting sorting = 1;
+     */
+    sorting?: SearchAccountsRequest_Sorting;
+    /**
+     *
+     * Optional substring to search for in account display names.
+     * Case-insensitive partial matching.
+     *
+     * @generated from field: string display_name = 2;
+     */
+    displayName: string;
+    /**
+     *
+     * When true, fetches current balances and state from the ledger.
+     * When false, returns only stored metadata without live data.
+     *
+     * @generated from field: bool populate_ledger_data = 3;
+     */
+    populateLedgerData: boolean;
+};
+/**
+ * Describes the message meshtrade.wallet.account.v1.SearchAccountsRequest.
+ * Use `create(SearchAccountsRequestSchema)` to create a new message.
+ */
+export declare const SearchAccountsRequestSchema: GenMessage<SearchAccountsRequest>;
+/**
+ *
+ * Sorting configuration for organizing results.
+ *
+ * @generated from message meshtrade.wallet.account.v1.SearchAccountsRequest.Sorting
+ */
+export type SearchAccountsRequest_Sorting = Message<"meshtrade.wallet.account.v1.SearchAccountsRequest.Sorting"> & {
+    /**
+     *
+     * Field to sort by.
+     * Supported values: "number" or empty string for default ordering.
+     *
+     * @generated from field: string field = 1;
+     */
+    field: string;
+    /**
+     *
+     * Sort order for results.
+     *
+     * @generated from field: meshtrade.type.v1.SortingOrder order = 2;
+     */
+    order: SortingOrder;
+};
+/**
+ * Describes the message meshtrade.wallet.account.v1.SearchAccountsRequest.Sorting.
+ * Use `create(SearchAccountsRequest_SortingSchema)` to create a new message.
+ */
+export declare const SearchAccountsRequest_SortingSchema: GenMessage<SearchAccountsRequest_Sorting>;
+/**
+ *
+ * Response containing search results.
+ *
+ * @generated from message meshtrade.wallet.account.v1.SearchAccountsResponse
+ */
+export type SearchAccountsResponse = Message<"meshtrade.wallet.account.v1.SearchAccountsResponse"> & {
+    /**
+     *
+     * Collection of accounts matching the search criteria.
+     *
+     * @generated from field: repeated meshtrade.wallet.account.v1.Account accounts = 1;
+     */
+    accounts: Account[];
+};
+/**
+ * Describes the message meshtrade.wallet.account.v1.SearchAccountsResponse.
+ * Use `create(SearchAccountsResponseSchema)` to create a new message.
+ */
+export declare const SearchAccountsResponseSchema: GenMessage<SearchAccountsResponse>;
+/**
+ *
+ * AccountService manages ledger wallet accounts and their lifecycle operations (BETA).
+ *
+ * This service provides comprehensive account management capabilities across multiple
+ * ledger networks (Stellar, Solana, Bitcoin, Ethereum). Accounts serve as the
+ * primary containers for holding and managing digital assets on the Mesh platform.
+ *
+ * Key capabilities include account creation, opening on-chain, balance queries,
+ * and account lifecycle management. All operations are scoped to the authenticated
+ * group's hierarchy and require appropriate wallet domain permissions.
+ *
+ * Note: This service is currently in BETA. Interface and functionality may change.
+ *
+ * @generated from service meshtrade.wallet.account.v1.AccountService
+ */
+export declare const AccountService: GenService<{
+    /**
+     *
+     * Creates a new account record in the system (off-chain).
+     *
+     * The account is created in a pending state and must be explicitly opened
+     * on the ledger using OpenAccount before it can receive funds or execute
+     * transactions. Account ownership must match the executing context.
+     *
+     * @generated from rpc meshtrade.wallet.account.v1.AccountService.CreateAccount
+     */
+    createAccount: {
+        methodKind: "unary";
+        input: typeof CreateAccountRequestSchema;
+        output: typeof AccountSchema;
+    };
+    /**
+     *
+     * Updates an existing account's mutable metadata.
+     *
+     * Only the display_name field can be modified. All other fields including
+     * ownership, ledger, and account number are immutable after creation.
+     *
+     * @generated from rpc meshtrade.wallet.account.v1.AccountService.UpdateAccount
+     */
+    updateAccount: {
+        methodKind: "unary";
+        input: typeof UpdateAccountRequestSchema;
+        output: typeof AccountSchema;
+    };
+    /**
+     *
+     * Opens an account on the ledger.
+     *
+     * Initializes the account on-chain, making it ready to receive deposits
+     * and execute transactions. Returns the opened account and a transaction
+     * reference for monitoring the ledger operation.
+     *
+     * @generated from rpc meshtrade.wallet.account.v1.AccountService.OpenAccount
+     */
+    openAccount: {
+        methodKind: "unary";
+        input: typeof OpenAccountRequestSchema;
+        output: typeof OpenAccountResponseSchema;
+    };
+    /**
+     *
+     * Adds the given users as signatories to an account on the ledger.
+     *
+     * Returns a transaction reference for monitoring the ledger operation.
+     *
+     * @generated from rpc meshtrade.wallet.account.v1.AccountService.AddSignatoriesToAccount
+     */
+    addSignatoriesToAccount: {
+        methodKind: "unary";
+        input: typeof AddSignatoriesToAccountRequestSchema;
+        output: typeof AddSignatoriesToAccountResponseSchema;
+    };
+    /**
+     *
+     * Removes the given users as signatories from an account on the ledger.
+     *
+     * Returns a transaction reference for monitoring the ledger operation.
+     *
+     * @generated from rpc meshtrade.wallet.account.v1.AccountService.RemoveSignatoriesFromAccount
+     */
+    removeSignatoriesFromAccount: {
+        methodKind: "unary";
+        input: typeof RemoveSignatoriesFromAccountRequestSchema;
+        output: typeof RemoveSignatoriesFromAccountResponseSchema;
+    };
+    /**
+     *
+     * Retrieves a specific account by its resource identifier.
+     *
+     * Provides access to account metadata and optionally fetches live
+     * balance data from the ledger when populate_ledger_data is true.
+     *
+     * @generated from rpc meshtrade.wallet.account.v1.AccountService.GetAccount
+     */
+    getAccount: {
+        methodKind: "unary";
+        input: typeof GetAccountRequestSchema;
+        output: typeof AccountSchema;
+    };
+    /**
+     *
+     * Retrieves an account using its Account Number.
+     *
+     * Provides a convenient lookup method using the 7-digit account number.
+     * Optionally fetches live balance data when populate_ledger_data is true.
+     *
+     * @generated from rpc meshtrade.wallet.account.v1.AccountService.GetAccountByNumber
+     */
+    getAccountByNumber: {
+        methodKind: "unary";
+        input: typeof GetAccountByNumberRequestSchema;
+        output: typeof AccountSchema;
+    };
+    /**
+     *
+     * Lists all accounts within the authenticated group's hierarchical scope.
+     *
+     * Returns the complete set of accounts accessible to the executing context,
+     * including accounts owned by the group and all descendant groups.
+     *
+     * @generated from rpc meshtrade.wallet.account.v1.AccountService.ListAccounts
+     */
+    listAccounts: {
+        methodKind: "unary";
+        input: typeof ListAccountsRequestSchema;
+        output: typeof ListAccountsResponseSchema;
+    };
+    /**
+     *
+     * Searches accounts using flexible text criteria within the hierarchy.
+     *
+     * Performs case-insensitive substring matching on display names,
+     * returning accounts that match the search criteria.
+     *
+     * @generated from rpc meshtrade.wallet.account.v1.AccountService.SearchAccounts
+     */
+    searchAccounts: {
+        methodKind: "unary";
+        input: typeof SearchAccountsRequestSchema;
+        output: typeof SearchAccountsResponseSchema;
+    };
+}>;