generated

package
v0.3.10 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 30, 2026 License: MIT Imports: 7 Imported by: 0

Documentation

Overview

Code generated by cligen. DO NOT EDIT.

Code generated by cligen. DO NOT EDIT.

Code generated by cligen. DO NOT EDIT.

Index

Constants

This section is empty.

Variables

View Source
var HelpEntries = map[string]map[string]HelpEntry{
	"accounts": {
		"get":  {Method: "GET", Path: "/workspaces/{workspaceId}/accounts/{accountId}", BodyRef: "", ResponseRef: "Account", PathArgs: []string{"accountId"}, Permissions: []string{"View only", "Transaction Operator", "Full Access", "MPC Hot Signer"}},
		"list": {Method: "GET", Path: "/workspaces/{workspaceId}/accounts", BodyRef: "", ResponseRef: "Accounts", QueryParams: []HelpQueryParam{{Name: "accountTypes", Required: false, Type: "array", Description: "Filter by account types. [See details](/enums/AccountType)", Enum: []string{"vault"}}, {Name: "excludedAccountTypes", Required: false, Type: "array", Description: "Filter by excluded account types. [See details](/enums/AccountType)", Enum: []string{"vault"}}, {Name: "statuses", Required: false, Type: "array", Description: "Filter by account statuses. [See details](/enums/AccountStatus)", Enum: []string{"active", "archived", "shard-generating"}}, {Name: "accountIds", Required: false, Type: "string[]", Description: "Filter by account id"}, {Name: "isDefiVault", Required: false, Type: "boolean", Description: "Filter only DeFi vaults"}, {Name: "offset", Required: false, Type: "string", Format: "int64", Description: "Offset for pagination"}, {Name: "limit", Required: false, Type: "string", Format: "int64", Description: "Limit for pagination"}, {Name: "isTestnet", Required: false, Type: "boolean", Description: "Filter by testnet flag (true - testnet, false - mainnet, null - all)"}}, Permissions: []string{"View only", "Transaction Operator", "Full Access", "MPC Hot Signer"}},
	},
	"activities": {
		"list": {Method: "GET", Path: "/workspaces/{workspaceId}/activities", BodyRef: "", ResponseRef: "Activities", QueryParams: []HelpQueryParam{{Name: "accountIds", Required: false, Type: "string[]", Description: "Filter activities for specific IDs"}, {Name: "offset", Required: false, Type: "string", Format: "int64"}, {Name: "limit", Required: false, Type: "string", Format: "int64"}, {Name: "search", Required: false, Type: "string", Description: "Search string based on activity name and description"}, {Name: "userIds", Required: false, Type: "string[]", Description: "Filter activities by user IDs"}, {Name: "activityTypes", Required: false, Type: "array", Description: "Filter activities by activity types. [See details](/enums/ActivityType)", Enum: []string{"login", "new-device-login", "new-address-book-record", "update-address-book-record", "delete-address-book-record", "workspace-creation", "workspace-settings-approval-update", "workspace-name-change", "workspace-tag-change", "tag-relinked", "tag-auto-relinked", "tag-deactivated", "only-address-book-withdrawals-settings-update", "transaction-approval-settings-update", "workspace-members-approval-update", "address-book-settings-approval-update", "transaction-limits-approval-settings-update", "member-creation", "member-update", "service-member-creation", "transaction-limit-creation", "transaction-limit-update", "account-creation", "passkey-creation", "passkey-deletion", "2fa-change", "account-pins-reset", "shard-access-request-updated", "transaction-completed", "subscription-updated", "trial-prolongation-requested", "trial-prolongated", "ownership-takeover-request-created", "ownership-takeover-request-cancelled", "ownership-takeover-new-beneficiary-added", "ownership-takeover-beneficiary-left", "ownership-takeover-request-completed"}}, {Name: "excludedActivityTypes", Required: false, Type: "array", Description: "Exclude activities by activity types. [See details](/enums/ActivityType)", Enum: []string{"login", "new-device-login", "new-address-book-record", "update-address-book-record", "delete-address-book-record", "workspace-creation", "workspace-settings-approval-update", "workspace-name-change", "workspace-tag-change", "tag-relinked", "tag-auto-relinked", "tag-deactivated", "only-address-book-withdrawals-settings-update", "transaction-approval-settings-update", "workspace-members-approval-update", "address-book-settings-approval-update", "transaction-limits-approval-settings-update", "member-creation", "member-update", "service-member-creation", "transaction-limit-creation", "transaction-limit-update", "account-creation", "passkey-creation", "passkey-deletion", "2fa-change", "account-pins-reset", "shard-access-request-updated", "transaction-completed", "subscription-updated", "trial-prolongation-requested", "trial-prolongated", "ownership-takeover-request-created", "ownership-takeover-request-cancelled", "ownership-takeover-new-beneficiary-added", "ownership-takeover-beneficiary-left", "ownership-takeover-request-completed"}}}, Permissions: []string{"View only", "Transaction Operator", "Full Access"}},
	},
	"address-book": {
		"create": {Method: "POST", Path: "/workspaces/{workspaceId}/address-book-records", BodyRef: "CreateAddressBookRecord", ResponseRef: "AddressBookRecord", Permissions: []string{"Transaction Operator", "Full Access"}},
		"delete": {Method: "DELETE", Path: "/workspaces/{workspaceId}/address-book-records/{recordId}", BodyRef: "", ResponseRef: "Unit", PathArgs: []string{"recordId"}, Permissions: []string{"Transaction Operator", "Full Access"}},
		"get":    {Method: "GET", Path: "/workspaces/{workspaceId}/address-book-records/{recordId}", BodyRef: "", ResponseRef: "AddressBookRecord", PathArgs: []string{"recordId"}, Permissions: []string{"View only", "Transaction Operator", "Full Access"}},
		"list":   {Method: "GET", Path: "/workspaces/{workspaceId}/address-book-records", BodyRef: "", ResponseRef: "AddressBookRecords", QueryParams: []HelpQueryParam{{Name: "recordIds", Required: false, Type: "string[]", Description: "Filter by address book record IDs list"}, {Name: "networkIds", Required: false, Type: "string[]", Description: "Filter by network IDs"}, {Name: "addresses", Required: false, Type: "string[]", Description: "Filter by addresses"}, {Name: "memo", Required: false, Type: "string", Description: "Filter by memo"}, {Name: "tag", Required: false, Type: "string", Description: "Filter by tag (exact match, case-insensitive)"}, {Name: "limit", Required: false, Type: "string", Format: "int64", Description: "Limit for pagination"}, {Name: "offset", Required: false, Type: "string", Format: "int64", Description: "Offset for pagination"}, {Name: "recordType", Required: false, Type: "string", Description: "Filter by record type. [See details](/enums/RecordType)", Enum: []string{"address", "tag", "bank"}}, {Name: "recordTypes", Required: false, Type: "array", Description: "Filter by record types. [See details](/enums/RecordType)", Enum: []string{"address", "tag", "bank"}}, {Name: "statuses", Required: false, Type: "array", Description: "Filter by statuses. [See details](/enums/RecordStatus)", Enum: []string{"new", "active", "rejected", "deleted"}}}, Permissions: []string{"View only", "Transaction Operator", "Full Access"}},
	},
	"assets": {
		"get":    {Method: "GET", Path: "/dictionary/assets/{assetId}", BodyRef: "", ResponseRef: "Asset", PathArgs: []string{"assetId"}, QueryParams: []HelpQueryParam{{Name: "assetIds", Required: false, Type: "string[]", Description: "Filter results to only include these specific asset IDs"}, {Name: "networkIds", Required: false, Type: "string[]", Description: "Filter results to only include assets from these blockchain networks"}, {Name: "symbolIds", Required: false, Type: "string[]", Description: "Filter results to only include assets that represent these specific symbols"}, {Name: "contractAddress", Required: false, Type: "string", Description: "Filter results to only include assets that have this contract address"}, {Name: "contractIssuer", Required: false, Type: "string", Description: "Filter result to only include assets that have this contract issuer"}, {Name: "assetType", Required: false, Type: "string", Description: "Filter by what kind of asset. [See details](/enums/AssetType)", Enum: []string{"blockchain", "exchange", "fiat", "nft"}}, {Name: "search", Required: false, Type: "string", Description: "Full-text search across symbol, name, and contract address. Minimum 2 characters."}, {Name: "limit", Required: false, Type: "string", Format: "int64"}, {Name: "offset", Required: false, Type: "string", Format: "int64"}}, Permissions: []string{"View only", "Transaction Operator", "Full Access"}},
		"list":   {Method: "GET", Path: "/dictionary/assets", BodyRef: "", ResponseRef: "Assets", QueryParams: []HelpQueryParam{{Name: "assetIds", Required: false, Type: "string[]", Description: "Filter results to only include these specific asset IDs"}, {Name: "networkIds", Required: false, Type: "string[]", Description: "Filter results to only include assets from these blockchain networks"}, {Name: "symbolIds", Required: false, Type: "string[]", Description: "Filter results to only include assets that represent these specific symbols"}, {Name: "contractAddress", Required: false, Type: "string", Description: "Filter results to only include assets that have this contract address"}, {Name: "contractIssuer", Required: false, Type: "string", Description: "Filter result to only include assets that have this contract issuer"}, {Name: "assetType", Required: false, Type: "string", Description: "Filter by what kind of asset. [See details](/enums/AssetType)", Enum: []string{"blockchain", "exchange", "fiat", "nft"}}, {Name: "search", Required: false, Type: "string", Description: "Full-text search across symbol, name, and contract address. Minimum 2 characters."}, {Name: "limit", Required: false, Type: "string", Format: "int64"}, {Name: "offset", Required: false, Type: "string", Format: "int64"}}, Permissions: []string{"View only", "Transaction Operator", "Full Access"}},
		"prices": {Method: "GET", Path: "/dictionary/asset-market-prices", BodyRef: "", ResponseRef: "AssetMarketPrices", QueryParams: []HelpQueryParam{{Name: "baseAssetIds", Required: false, Type: "string[]", Description: "The asset IDs you want to get market prices for"}}, Permissions: []string{"View only", "Transaction Operator", "Full Access"}},
	},
	"balances": {
		"get":  {Method: "GET", Path: "/workspaces/{workspaceId}/balances/{balanceId}", BodyRef: "", ResponseRef: "Balance", PathArgs: []string{"balanceId"}, Permissions: []string{"View only", "Transaction Operator", "Full Access"}},
		"list": {Method: "GET", Path: "/workspaces/{workspaceId}/balances", BodyRef: "", ResponseRef: "Balances", QueryParams: []HelpQueryParam{{Name: "accountId", Required: false, Type: "string", Description: "Filter by account ID"}, {Name: "accountIds", Required: false, Type: "string[]", Description: "Filter by account ids"}, {Name: "balanceIds", Required: false, Type: "string[]", Description: "Filter by balance ids"}, {Name: "assetId", Required: false, Type: "string", Description: "Filter balances by assetId"}, {Name: "assetIds", Required: false, Type: "string[]", Description: "Filter balances by assetIds list"}, {Name: "assetNotIn", Required: false, Type: "string[]", Description: "Filter balances by assetNotIn"}, {Name: "networkId", Required: false, Type: "string", Description: "Filter balances by networkId"}, {Name: "networkIds", Required: false, Type: "string[]", Description: "Filter balances by networkIds list"}, {Name: "accountTypes", Required: false, Type: "array", Description: "Filter balances by account types. [See details](/enums/AccountType)", Enum: []string{"vault"}}, {Name: "excludedAccountTypes", Required: false, Type: "array", Description: "Exclude balances by account types. [See details](/enums/AccountType)", Enum: []string{"vault"}}, {Name: "updatedSince", Required: false, Type: "string", Format: "date-time-millis", Description: "Filter balances updated since timestamp"}, {Name: "nonEmpty", Required: false, Type: "boolean", Description: "Filter only balances with non-zero balance"}, {Name: "limit", Required: false, Type: "string", Format: "int64", Description: "Limit for pagination"}, {Name: "offset", Required: false, Type: "string", Format: "int64", Description: "Offset for pagination"}}, Permissions: []string{"View only", "Transaction Operator", "Full Access"}},
	},
	"deposit-addresses": {
		"list": {Method: "GET", Path: "/workspaces/{workspaceId}/addresses", BodyRef: "", ResponseRef: "Addresses", QueryParams: []HelpQueryParam{{Name: "accountId", Required: false, Type: "string", Description: "Filter addresses by account id"}, {Name: "addressIds", Required: false, Type: "string[]", Description: "List of comma-separated address IDs"}, {Name: "externalId", Required: false, Type: "string", Description: "External Id"}, {Name: "accountTypes", Required: false, Type: "array", Description: "Account Types to filter. [See details](/enums/AccountType)", Enum: []string{"vault"}}, {Name: "networkId", Required: false, Type: "string", Description: "Network ID to filter"}, {Name: "address", Required: false, Type: "string", Description: "Address string, case insensitive"}, {Name: "statuses", Required: false, Type: "array", Description: "Statuses to filter. [See details](/enums/AddressStatus)", Enum: []string{"new", "pending", "address-activation-required", "address-creation-required", "approval-pending", "enabled", "disabled", "error", "account-archived"}}, {Name: "sortDirection", Required: false, Type: "string", Description: "[See details](/enums/SortingDirection)", Enum: []string{"ASC", "DESC"}}, {Name: "limit", Required: false, Type: "string", Format: "int64", Description: "Limit"}, {Name: "offset", Required: false, Type: "string", Format: "int64", Description: "Offset"}}, Permissions: []string{"View only", "Transaction Operator", "Full Access"}},
	},
	"intents": {
		"create": {Method: "POST", Path: "/workspaces/{workspaceId}/intents", BodyRef: "CreateIntent", ResponseRef: "Intent", Permissions: []string{"Transaction Operator", "Full Access"}},
		"get":    {Method: "GET", Path: "/workspaces/{workspaceId}/intents/{intentId}", BodyRef: "", ResponseRef: "Intent", PathArgs: []string{"intentId"}, Permissions: []string{"View only", "Transaction Operator", "Full Access"}},
	},
	"members": {
		"list": {Method: "GET", Path: "/workspaces/{workspaceId}/members", BodyRef: "", ResponseRef: "WorkspaceMembers", QueryParams: []HelpQueryParam{{Name: "includePermissionGroups", Required: false, Type: "boolean", Description: "Embed data about members' permission groups"}, {Name: "includeUsersProfiles", Required: false, Type: "boolean", Description: "Embed data about members' user information"}, {Name: "includeEmails", Required: false, Type: "boolean", Description: "Embed data about members' email addresses"}}, EmbedTokens: []string{"emails", "permission-groups", "users-profiles"}, Permissions: []string{"View only", "Transaction Operator", "Full Access"}},
	},
	"networks": {
		"get":  {Method: "GET", Path: "/dictionary/networks/{networkId}", BodyRef: "", ResponseRef: "Network", PathArgs: []string{"networkId"}, Permissions: []string{"View only", "Transaction Operator", "Full Access"}},
		"list": {Method: "GET", Path: "/dictionary/networks", BodyRef: "", ResponseRef: "Networks", QueryParams: []HelpQueryParam{{Name: "networkIds", Required: false, Type: "string[]", Description: "Filter results to only include these specific network IDs"}}, Permissions: []string{"View only", "Transaction Operator", "Full Access"}},
	},
	"stakes": {
		"list": {Method: "GET", Path: "/workspaces/{workspaceId}/stakes", BodyRef: "", ResponseRef: "Stakes", QueryParams: []HelpQueryParam{{Name: "accountId", Required: false, Type: "string", Description: "Return stakes only for specific account"}, {Name: "assetId", Required: false, Type: "string", Description: "Return stakes only for specific assetId"}, {Name: "rewardPeriod", Required: false, Type: "string", Description: "Reward period"}}, Permissions: []string{"View only", "Transaction Operator", "Full Access"}},
	},
	"symbols": {
		"get":    {Method: "GET", Path: "/dictionary/symbols/{symbolId}", BodyRef: "", ResponseRef: "Symbol", PathArgs: []string{"symbolId"}, QueryParams: []HelpQueryParam{{Name: "symbolIds", Required: false, Type: "string[]", Description: "Filter results to only include these specific symbol IDs"}, {Name: "assetIds", Required: false, Type: "string[]", Description: "Filter results to only include symbols that are used by these specific asset IDs. Useful when you want to know which symbols are available for certain assets."}, {Name: "limit", Required: false, Type: "string", Format: "int64"}, {Name: "offset", Required: false, Type: "string", Format: "int64"}}, Permissions: []string{"View only", "Transaction Operator", "Full Access"}},
		"list":   {Method: "GET", Path: "/dictionary/symbols", BodyRef: "", ResponseRef: "Symbols", QueryParams: []HelpQueryParam{{Name: "symbolIds", Required: false, Type: "string[]", Description: "Filter results to only include these specific symbol IDs"}, {Name: "assetIds", Required: false, Type: "string[]", Description: "Filter results to only include symbols that are used by these specific asset IDs. Useful when you want to know which symbols are available for certain assets."}, {Name: "limit", Required: false, Type: "string", Format: "int64"}, {Name: "offset", Required: false, Type: "string", Format: "int64"}}, Permissions: []string{"View only", "Transaction Operator", "Full Access"}},
		"prices": {Method: "GET", Path: "/dictionary/symbol-market-prices", BodyRef: "", ResponseRef: "SymbolMarketPrices", QueryParams: []HelpQueryParam{{Name: "baseSymbolIds", Required: false, Type: "string[]", Description: "The symbol IDs you want to get market prices for"}, {Name: "baseAssetIds", Required: false, Type: "string[]", Description: "The asset IDs you want to get market prices for"}}, Permissions: []string{"View only", "Transaction Operator", "Full Access"}},
	},
	"transaction-limits": {
		"get":  {Method: "GET", Path: "/workspaces/{workspaceId}/transaction-limits/{limitId}", BodyRef: "", ResponseRef: "TransactionLimit", PathArgs: []string{"limitId"}, Permissions: []string{"View only", "Transaction Operator", "Full Access"}},
		"list": {Method: "GET", Path: "/workspaces/{workspaceId}/transaction-limits", BodyRef: "", ResponseRef: "TransactionLimits", QueryParams: []HelpQueryParam{{Name: "statuses", Required: false, Type: "array", Description: "[See details](/enums/TransactionLimitStatus)", Enum: []string{"new", "active", "deactivated", "declined"}}, {Name: "fromAccountIds", Required: false, Type: "string[]"}, {Name: "toAddressBookRecordIds", Required: false, Type: "string[]"}, {Name: "toAccountIds", Required: false, Type: "string[]"}, {Name: "appliesToUserIds", Required: false, Type: "string[]"}, {Name: "appliesToGroupIds", Required: false, Type: "string[]"}, {Name: "limit", Required: false, Type: "string", Format: "int64"}, {Name: "offset", Required: false, Type: "string", Format: "int64"}}, Permissions: []string{"View only", "Transaction Operator", "Full Access"}},
	},
	"tx": {
		"accept-deposit-offer":   {Method: "POST", Path: "/workspaces/{workspaceId}/transactions/{transactionId}/accept-deposit-offer", BodyRef: "OfferActions", ResponseRef: "Transaction", PathArgs: []string{"transactionId"}, Permissions: []string{"Transaction Operator", "Full Access"}},
		"approve":                {Method: "POST", Path: "/workspaces/{workspaceId}/transactions/{transactionId}/approve", BodyRef: "ApproveTransaction", ResponseRef: "Transaction", PathArgs: []string{"transactionId"}, Permissions: []string{"Transaction Operator", "Full Access"}},
		"bulk-create":            {Method: "POST", Path: "/workspaces/{workspaceId}/transactions/bulk-create", BodyRef: "CreateTransactions", ResponseRef: "Transactions", Permissions: []string{"Transaction Operator", "Full Access"}},
		"cancel":                 {Method: "POST", Path: "/workspaces/{workspaceId}/transactions/{transactionId}/cancel", BodyRef: "CancelTransaction", ResponseRef: "Transaction", PathArgs: []string{"transactionId"}, Permissions: []string{"Transaction Operator", "Full Access"}},
		"create":                 {Method: "POST", Path: "/workspaces/{workspaceId}/transactions", BodyRef: "CreateTransaction", ResponseRef: "Transaction", Permissions: []string{"Transaction Operator", "Full Access"}},
		"create-signing-request": {Method: "POST", Path: "/workspaces/{workspaceId}/transactions/{transactionId}/create-signing-request", BodyRef: "", ResponseRef: "Transaction", PathArgs: []string{"transactionId"}, Permissions: []string{"Full Access", "MPC Hot Signer"}},
		"decline":                {Method: "POST", Path: "/workspaces/{workspaceId}/transactions/{transactionId}/decline", BodyRef: "CancelTransaction", ResponseRef: "Transaction", PathArgs: []string{"transactionId"}, Permissions: []string{"Transaction Operator", "Full Access"}},
		"dry-run":                {Method: "POST", Path: "/workspaces/{workspaceId}/transactions/dry-run", BodyRef: "CreateTransaction", ResponseRef: "DryRunTransaction", Permissions: []string{"Transaction Operator", "Full Access"}},
		"events":                 {Method: "GET", Path: "/workspaces/{workspaceId}/transactions/{transactionId}/events", BodyRef: "", ResponseRef: "TransactionEvents", PathArgs: []string{"transactionId"}, Permissions: []string{"View only", "Transaction Operator", "Full Access"}},
		"get":                    {Method: "GET", Path: "/workspaces/{workspaceId}/transactions/{transactionId}", BodyRef: "", ResponseRef: "Transaction", PathArgs: []string{"transactionId"}, Permissions: []string{"View only", "Transaction Operator", "Full Access", "MPC Hot Signer"}},
		"list":                   {Method: "GET", Path: "/workspaces/{workspaceId}/transactions", BodyRef: "", ResponseRef: "Transactions", QueryParams: []HelpQueryParam{{Name: "transactionId", Required: false, Type: "string", Description: "Transaction ID"}, {Name: "transactionIds", Required: false, Type: "string[]", Description: "Comma-separated transaction ids"}, {Name: "transactionTypes", Required: false, Type: "array", Description: "Comma-separated transaction types. [See details](/enums/TransactionType)", Enum: []string{"deposit", "withdrawal", "multi-withdrawal", "negative-deposit", "auto-withdrawal", "allowance", "defi", "defi-message", "address-activation", "address-creation", "stake-delegation", "stake-undelegation", "stake-claim", "stake-withdrawal", "stake-take-reward", "stake-earn-reward", "swap-lifi", "intents", "loyalty-lock", "loyalty-unlock", "loyalty-collect-rewards", "canton-reward", "nft-deposit", "nft-withdrawal", "nft-allowance", "fiat-out", "fiat-in", "bridge"}}, {Name: "accountTypes", Required: false, Type: "array", Description: "Comma-separated account types. [See details](/enums/AccountType)", Enum: []string{"vault"}}, {Name: "accountId", Required: false, Type: "string"}, {Name: "accountIds", Required: false, Type: "string[]", Description: "Comma-separated account ids"}, {Name: "transactionStatuses", Required: false, Type: "array", Description: "Comma-separated transaction statuses. [See details](/enums/TransactionStatus)", Enum: []string{"new", "waiting-confirmations", "waiting-approval", "approved", "awaiting-security-policy", "completed", "partially-completed", "canceled", "expired", "signing-required", "signing", "signed", "broadcasted", "manual-resolving", "failed-on-blockchain", "removed-from-blockchain", "error", "awaiting-deposit", "awaiting-conversion", "awaiting-payout", "awaiting-defi-execution", "acceptance-required"}}, {Name: "transactionStatusNotIn", Required: false, Type: "array", Description: "Comma-separated transaction statuses to filter out. [See details](/enums/TransactionStatus)", Enum: []string{"new", "waiting-confirmations", "waiting-approval", "approved", "awaiting-security-policy", "completed", "partially-completed", "canceled", "expired", "signing-required", "signing", "signed", "broadcasted", "manual-resolving", "failed-on-blockchain", "removed-from-blockchain", "error", "awaiting-deposit", "awaiting-conversion", "awaiting-payout", "awaiting-defi-execution", "acceptance-required"}}, {Name: "assetIds", Required: false, Type: "string[]", Description: "Filter by Asset IDs"}, {Name: "blockchainTxId", Required: false, Type: "string", Description: "Blockchain transaction id to filter"}, {Name: "toAccountId", Required: false, Type: "string", Description: "Account ID to where the transaction was sent to"}, {Name: "toAddress", Required: false, Type: "string", Description: "Address to where the transaction was sent to"}, {Name: "isTerminated", Required: false, Type: "boolean", Description: "Filer on only terminated transactions or not"}, {Name: "terminatedAtFrom", Required: false, Type: "string", Format: "date-time-millis", Description: "Filter by terminated date since timestamp"}, {Name: "terminatedAtTo", Required: false, Type: "string", Format: "date-time-millis", Description: "Filter by terminated date until timestamp"}, {Name: "createdAtFrom", Required: false, Type: "string", Format: "date-time-millis", Description: "Filter by created date since timestamp"}, {Name: "createdAtTo", Required: false, Type: "string", Format: "date-time-millis", Description: "Filter by created date until timestamp"}, {Name: "updatedAtFrom", Required: false, Type: "string", Format: "date-time-millis", Description: "Filter by updated date since timestamp"}, {Name: "updatedAtTo", Required: false, Type: "string", Format: "date-time-millis", Description: "Filter by updated date until timestamp"}, {Name: "canSignWithDeviceId", Required: false, Type: "string", Description: "Filter by deviceId that can sign this transaction"}, {Name: "sortBy", Required: false, Type: "string", Description: "[See details](/enums/SortBy)", Enum: []string{"updated", "activity"}}, {Name: "sortDirection", Required: false, Type: "string", Description: "[See details](/enums/SortingDirection)", Enum: []string{"ASC", "DESC"}}, {Name: "limit", Required: false, Type: "string", Format: "int64", Description: "Limit for pagination"}, {Name: "offset", Required: false, Type: "string", Format: "int64", Description: "Offset for pagination"}, {Name: "externalId", Required: false, Type: "string", Description: "External Id"}, {Name: "includeEvents", Required: false, Type: "boolean", Description: "Include events in the response _embedded field"}, {Name: "includeCurrentSigningRequest", Required: false, Type: "boolean", Description: "Include current signing requests in the response _embedded field"}}, EmbedTokens: []string{"current-signing-request", "events"}, Permissions: []string{"View only", "Transaction Operator", "Full Access", "MPC Hot Signer"}},
		"reject-outgoing-offer":  {Method: "POST", Path: "/workspaces/{workspaceId}/transactions/{transactionId}/reject-outgoing-offer", BodyRef: "OfferActions", ResponseRef: "Transaction", PathArgs: []string{"transactionId"}, Permissions: []string{"Transaction Operator", "Full Access"}},
	},
	"workspace": {
		"info": {Method: "GET", Path: "/workspaces/{workspaceId}", BodyRef: "", ResponseRef: "Workspace", QueryParams: []HelpQueryParam{{Name: "workspaceIds", Required: false, Type: "string[]", Description: "List of comma-separated workspace ids"}, {Name: "includeSettings", Required: false, Type: "boolean", Description: "Include workspace settings"}, {Name: "limit", Required: false, Type: "string", Format: "int64"}, {Name: "offset", Required: false, Type: "string", Format: "int64"}}, EmbedTokens: []string{"settings"}, Permissions: []string{"View only", "Transaction Operator", "Full Access"}},
	},
}
View Source
var Spec []byte
View Source
var TxShortcuts = map[string]TxShortcut{
	"address-activation": {ParamsRef: "AddressActivationParams", Params: []string{"assetId"}, TopFields: []string{"accountId", "description", "expiresAt", "externalId"}},
	"address-creation":   {ParamsRef: "AddressCreationParams", Params: []string{"assetId"}, TopFields: []string{"accountId", "description", "expiresAt", "externalId"}},
	"allowance":          {ParamsRef: "AllowanceParams", Params: []string{"amount", "assetId", "feeLevel", "networkFees.feePerByte", "networkFees.gasLimit", "networkFees.gasPriceGwei", "networkFees.maxFeePerGas", "networkFees.maxPriorityFeePerGas", "toAddress", "unlimited"}, TopFields: []string{"accountId", "description", "expiresAt", "externalId"}},
	"bridge":             {ParamsRef: "BridgeParams", Params: []string{"amount", "feeLevel", "sourceAssetId"}, TopFields: []string{"accountId", "description", "expiresAt", "externalId"}},
	"defi":               {ParamsRef: "DefiParams", Params: []string{"data", "externalBroadcast", "feeLevel", "method", "networkId", "origin", "rawTransaction", "rawTransactions", "to", "value"}, TopFields: []string{"accountId", "description", "expiresAt", "externalId"}},
	"defi-message":       {ParamsRef: "DefiMessageParams", Params: []string{"message", "networkId", "origin", "version"}, TopFields: []string{"accountId", "description", "expiresAt", "externalId"}},
	"deposit":            {ParamsRef: "DepositParams", Params: []string{"amount", "assetId", "networkId"}, TopFields: []string{"accountId", "description", "expiresAt", "externalId"}},
	"fiat-in":            {ParamsRef: "FiatInParams", Params: []string{"amount", "assetId", "fiatAmount", "fiatAssetId"}, TopFields: []string{"accountId", "description", "expiresAt", "externalId"}},
	"fiat-out":           {ParamsRef: "FiatOutParams", Params: []string{"amount", "assetId", "feeLevel", "fiatAssetId", "networkId", "toAddressBookRecordId"}, TopFields: []string{"accountId", "description", "expiresAt", "externalId"}},
	"intents":            {ParamsRef: "IntentsParams", Params: []string{"feeLevel", "intentId"}, TopFields: []string{"accountId", "description", "expiresAt", "externalId"}},
	"stake-claim":        {ParamsRef: "StakeClaimParams", Params: []string{"amount", "assetId", "stakeId"}, TopFields: []string{"accountId", "description", "expiresAt", "externalId"}},
	"stake-delegation":   {ParamsRef: "StakeDelegationParams", Params: []string{"amount", "assetId", "poolId"}, TopFields: []string{"accountId", "description", "expiresAt", "externalId"}},
	"stake-undelegation": {ParamsRef: "StakeUnDelegationParams", Params: []string{"amount", "assetId", "stakeId"}, TopFields: []string{"accountId", "description", "expiresAt", "externalId"}},
	"stake-withdrawal":   {ParamsRef: "StakeWithdrawalParams", Params: []string{"amount", "assetId", "poolId"}, TopFields: []string{"accountId", "description", "expiresAt", "externalId"}},
	"withdrawal":         {ParamsRef: "WithdrawalParams", Params: []string{"amount", "assetId", "feeLevel", "includeFee", "memo", "networkFees.feePerByte", "networkFees.gasLimit", "networkFees.gasPriceGwei", "networkFees.maxFeePerGas", "networkFees.maxPriorityFeePerGas", "networkId", "symbol", "toAccountId", "toAddress", "toAddressBookRecordId", "toWorkspaceTag"}, TopFields: []string{"accountId", "description", "expiresAt", "externalId"}},
}

Functions

func Register

func Register(root *cobra.Command, provide ClientProvider)

Register attaches all generated subcommands to root.

Types

type ClientProvider

type ClientProvider func() (*client.Client, error)

ClientProvider builds a configured client on demand.

type HelpEntry

type HelpEntry struct {
	Method      string
	Path        string
	BodyRef     string
	ResponseRef string
	QueryParams []HelpQueryParam
	PathArgs    []string
	EmbedTokens []string // valid --embed values, derived from includeXxx query params
	Permissions []string // API key permissions allowed, e.g. ["View only", "Transaction Operator"] — used by `bron mcp --read-only`
}

type HelpQueryParam

type HelpQueryParam struct {
	Name        string
	Required    bool
	Type        string // OpenAPI type — "string" | "integer" | "boolean" | "number" | "array". "string[]" / "integer[]" for array of primitive.
	Format      string // OpenAPI format — "int64" | "date-time-millis" | "decimal" | ...
	Description string
	Enum        []string
}

type TxShortcut

type TxShortcut struct {
	ParamsRef string
	Params    []string
	TopFields []string
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL