getWallets
List the wallets visible to the caller's scope.
Status
Proposed target SDK behavior for implementation. It is not an available SDK or evidence of backend support.
Business action#
List wallets visible to the authenticated owner scope so a browser can render an authorized inventory or a backend can reconcile it.
Proposed call#
getWallets(
input: GetWalletsInput,
options?: CallOptions,
): Promise<WalletPage>
TypeScript uses ownerScope, pageCursor and limit when those optional fields are supplied. undefined omits a field; null is not an empty cursor.
async def get_wallets(
input: GetWalletsInput,
*,
options: CallOptions | None = None,
) -> WalletPage: ...
Python uses owner_scope, page_cursor and limit; optional values use UNSET, while a returned continuation cursor is either the documented string value or an explicitly declared nullable result.
GetWallets(
ctx context.Context,
input *GetWalletsInput,
) (*WalletPage, error)
Go uses OwnerScope, PageCursor and Limit with presence-aware optional fields. The result owns its wallet slice and continuation value; callers may mutate their copy without changing SDK state.
The input may contain only an authorized embedded-owner or server-service scope, optional control-mode filter and bounded page cursor/limit supported by the eventual backend. Exact limits remain an implementation-gate decision.
Result#
A bounded page of the same wallet projection used by getWallet, plus an opaque continuation token. Each wallet includes control mode, controlling owner/service identity, limits and effective-rights summaries.
Effects and failures#
Read-only. An empty successful page is different from unavailable, denied or malformed input. Omission from one page does not authorize deletion of application records. The SDK does not aggregate tenants or sort opaque continuation tokens.
Acceptance#
- Positive: every returned wallet is within the authorized scope and pagination preserves a stable backend-defined traversal.
- Negative: failure cannot become an empty inventory; no foreign wallet or authority metadata is disclosed; list processing remains bounded.
See getWallet.