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"}}, "list": {Method: "GET", Path: "/workspaces/{workspaceId}/accounts", BodyRef: "", ResponseRef: "Accounts", QueryParams: []HelpQueryParam{{Name: "accountTypes", Required: false}, {Name: "excludedAccountTypes", Required: false}, {Name: "statuses", Required: false}, {Name: "accountIds", Required: false}, {Name: "isDefiVault", Required: false}, {Name: "offset", Required: false}, {Name: "limit", Required: false}, {Name: "isTestnet", Required: false}}}, }, "activities": { "list": {Method: "GET", Path: "/workspaces/{workspaceId}/activities", BodyRef: "", ResponseRef: "Activities", QueryParams: []HelpQueryParam{{Name: "accountIds", Required: false}, {Name: "offset", Required: false}, {Name: "limit", Required: false}, {Name: "search", Required: false}, {Name: "userIds", Required: false}, {Name: "activityTypes", Required: false}, {Name: "excludedActivityTypes", Required: false}}}, }, "address-book": { "create": {Method: "POST", Path: "/workspaces/{workspaceId}/address-book-records", BodyRef: "CreateAddressBookRecord", ResponseRef: "AddressBookRecord"}, "delete": {Method: "DELETE", Path: "/workspaces/{workspaceId}/address-book-records/{recordId}", BodyRef: "", ResponseRef: "Unit", PathArgs: []string{"recordId"}}, "get": {Method: "GET", Path: "/workspaces/{workspaceId}/address-book-records/{recordId}", BodyRef: "", ResponseRef: "AddressBookRecord", PathArgs: []string{"recordId"}}, "list": {Method: "GET", Path: "/workspaces/{workspaceId}/address-book-records", BodyRef: "", ResponseRef: "AddressBookRecords", QueryParams: []HelpQueryParam{{Name: "recordIds", Required: false}, {Name: "networkIds", Required: false}, {Name: "addresses", Required: false}, {Name: "memo", Required: false}, {Name: "tag", Required: false}, {Name: "limit", Required: false}, {Name: "offset", Required: false}, {Name: "recordType", Required: false}, {Name: "recordTypes", Required: false}, {Name: "statuses", Required: false}}}, }, "assets": { "get": {Method: "GET", Path: "/dictionary/assets/{assetId}", BodyRef: "", ResponseRef: "Asset", PathArgs: []string{"assetId"}, QueryParams: []HelpQueryParam{{Name: "assetIds", Required: false}, {Name: "networkIds", Required: false}, {Name: "symbolIds", Required: false}, {Name: "contractAddress", Required: false}, {Name: "contractIssuer", Required: false}, {Name: "assetType", Required: false}, {Name: "search", Required: false}, {Name: "limit", Required: false}, {Name: "offset", Required: false}}}, "list": {Method: "GET", Path: "/dictionary/assets", BodyRef: "", ResponseRef: "Assets", QueryParams: []HelpQueryParam{{Name: "assetIds", Required: false}, {Name: "networkIds", Required: false}, {Name: "symbolIds", Required: false}, {Name: "contractAddress", Required: false}, {Name: "contractIssuer", Required: false}, {Name: "assetType", Required: false}, {Name: "search", Required: false}, {Name: "limit", Required: false}, {Name: "offset", Required: false}}}, "prices": {Method: "GET", Path: "/dictionary/asset-market-prices", BodyRef: "", ResponseRef: "AssetMarketPrices", QueryParams: []HelpQueryParam{{Name: "baseAssetIds", Required: false}}}, }, "balances": { "get": {Method: "GET", Path: "/workspaces/{workspaceId}/balances/{balanceId}", BodyRef: "", ResponseRef: "Balance", PathArgs: []string{"balanceId"}}, "list": {Method: "GET", Path: "/workspaces/{workspaceId}/balances", BodyRef: "", ResponseRef: "Balances", QueryParams: []HelpQueryParam{{Name: "accountId", Required: false}, {Name: "accountIds", Required: false}, {Name: "balanceIds", Required: false}, {Name: "assetId", Required: false}, {Name: "assetIds", Required: false}, {Name: "assetNotIn", Required: false}, {Name: "networkId", Required: false}, {Name: "networkIds", Required: false}, {Name: "accountTypes", Required: false}, {Name: "excludedAccountTypes", Required: false}, {Name: "updatedSince", Required: false}, {Name: "nonEmpty", Required: false}, {Name: "limit", Required: false}, {Name: "offset", Required: false}}}, }, "deposit-addresses": { "list": {Method: "GET", Path: "/workspaces/{workspaceId}/addresses", BodyRef: "", ResponseRef: "Addresses", QueryParams: []HelpQueryParam{{Name: "accountId", Required: false}, {Name: "addressIds", Required: false}, {Name: "externalId", Required: false}, {Name: "accountTypes", Required: false}, {Name: "networkId", Required: false}, {Name: "address", Required: false}, {Name: "statuses", Required: false}, {Name: "sortDirection", Required: false}, {Name: "limit", Required: false}, {Name: "offset", Required: false}}}, }, "intents": { "create": {Method: "POST", Path: "/workspaces/{workspaceId}/intents", BodyRef: "CreateIntent", ResponseRef: "Intent"}, "get": {Method: "GET", Path: "/workspaces/{workspaceId}/intents/{intentId}", BodyRef: "", ResponseRef: "Intent", PathArgs: []string{"intentId"}}, }, "members": { "list": {Method: "GET", Path: "/workspaces/{workspaceId}/members", BodyRef: "", ResponseRef: "WorkspaceMembers", QueryParams: []HelpQueryParam{{Name: "includePermissionGroups", Required: false}, {Name: "includeUsersProfiles", Required: false}, {Name: "includeEmails", Required: false}}, EmbedTokens: []string{"emails", "permission-groups", "users-profiles"}}, }, "networks": { "get": {Method: "GET", Path: "/dictionary/networks/{networkId}", BodyRef: "", ResponseRef: "Network", PathArgs: []string{"networkId"}}, "list": {Method: "GET", Path: "/dictionary/networks", BodyRef: "", ResponseRef: "Networks", QueryParams: []HelpQueryParam{{Name: "networkIds", Required: false}}}, }, "stakes": { "list": {Method: "GET", Path: "/workspaces/{workspaceId}/stakes", BodyRef: "", ResponseRef: "Stakes", QueryParams: []HelpQueryParam{{Name: "accountId", Required: false}, {Name: "assetId", Required: false}, {Name: "rewardPeriod", Required: false}}}, }, "symbols": { "get": {Method: "GET", Path: "/dictionary/symbols/{symbolId}", BodyRef: "", ResponseRef: "Symbol", PathArgs: []string{"symbolId"}, QueryParams: []HelpQueryParam{{Name: "symbolIds", Required: false}, {Name: "assetIds", Required: false}, {Name: "limit", Required: false}, {Name: "offset", Required: false}}}, "list": {Method: "GET", Path: "/dictionary/symbols", BodyRef: "", ResponseRef: "Symbols", QueryParams: []HelpQueryParam{{Name: "symbolIds", Required: false}, {Name: "assetIds", Required: false}, {Name: "limit", Required: false}, {Name: "offset", Required: false}}}, "prices": {Method: "GET", Path: "/dictionary/symbol-market-prices", BodyRef: "", ResponseRef: "SymbolMarketPrices", QueryParams: []HelpQueryParam{{Name: "baseSymbolIds", Required: false}, {Name: "baseAssetIds", Required: false}}}, }, "transaction-limits": { "get": {Method: "GET", Path: "/workspaces/{workspaceId}/transaction-limits/{limitId}", BodyRef: "", ResponseRef: "TransactionLimit", PathArgs: []string{"limitId"}}, "list": {Method: "GET", Path: "/workspaces/{workspaceId}/transaction-limits", BodyRef: "", ResponseRef: "TransactionLimits", QueryParams: []HelpQueryParam{{Name: "statuses", Required: false}, {Name: "fromAccountIds", Required: false}, {Name: "toAddressBookRecordIds", Required: false}, {Name: "toAccountIds", Required: false}, {Name: "appliesToUserIds", Required: false}, {Name: "appliesToGroupIds", Required: false}, {Name: "limit", Required: false}, {Name: "offset", Required: false}}}, }, "tx": { "accept-deposit-offer": {Method: "POST", Path: "/workspaces/{workspaceId}/transactions/{transactionId}/accept-deposit-offer", BodyRef: "OfferActions", ResponseRef: "Transaction", PathArgs: []string{"transactionId"}}, "approve": {Method: "POST", Path: "/workspaces/{workspaceId}/transactions/{transactionId}/approve", BodyRef: "ApproveTransaction", ResponseRef: "Transaction", PathArgs: []string{"transactionId"}}, "bulk-create": {Method: "POST", Path: "/workspaces/{workspaceId}/transactions/bulk-create", BodyRef: "CreateTransactions", ResponseRef: "Transactions"}, "cancel": {Method: "POST", Path: "/workspaces/{workspaceId}/transactions/{transactionId}/cancel", BodyRef: "CancelTransaction", ResponseRef: "Transaction", PathArgs: []string{"transactionId"}}, "create": {Method: "POST", Path: "/workspaces/{workspaceId}/transactions", BodyRef: "CreateTransaction", ResponseRef: "Transaction"}, "create-signing-request": {Method: "POST", Path: "/workspaces/{workspaceId}/transactions/{transactionId}/create-signing-request", BodyRef: "", ResponseRef: "Transaction", PathArgs: []string{"transactionId"}}, "decline": {Method: "POST", Path: "/workspaces/{workspaceId}/transactions/{transactionId}/decline", BodyRef: "CancelTransaction", ResponseRef: "Transaction", PathArgs: []string{"transactionId"}}, "dry-run": {Method: "POST", Path: "/workspaces/{workspaceId}/transactions/dry-run", BodyRef: "CreateTransaction", ResponseRef: "DryRunTransaction"}, "events": {Method: "GET", Path: "/workspaces/{workspaceId}/transactions/{transactionId}/events", BodyRef: "", ResponseRef: "TransactionEvents", PathArgs: []string{"transactionId"}}, "get": {Method: "GET", Path: "/workspaces/{workspaceId}/transactions/{transactionId}", BodyRef: "", ResponseRef: "Transaction", PathArgs: []string{"transactionId"}}, "list": {Method: "GET", Path: "/workspaces/{workspaceId}/transactions", BodyRef: "", ResponseRef: "Transactions", QueryParams: []HelpQueryParam{{Name: "transactionIds", Required: false}, {Name: "transactionTypes", Required: false}, {Name: "accountTypes", Required: false}, {Name: "accountId", Required: false}, {Name: "accountIds", Required: false}, {Name: "transactionStatuses", Required: false}, {Name: "transactionStatusNotIn", Required: false}, {Name: "assetIds", Required: false}, {Name: "blockchainTxId", Required: false}, {Name: "toAccountId", Required: false}, {Name: "toAddress", Required: false}, {Name: "isTerminated", Required: false}, {Name: "terminatedAtFrom", Required: false}, {Name: "terminatedAtTo", Required: false}, {Name: "createdAtFrom", Required: false}, {Name: "createdAtTo", Required: false}, {Name: "updatedAtFrom", Required: false}, {Name: "updatedAtTo", Required: false}, {Name: "canSignWithDeviceId", Required: false}, {Name: "sortBy", Required: false}, {Name: "sortDirection", Required: false}, {Name: "limit", Required: false}, {Name: "offset", Required: false}, {Name: "externalId", Required: false}, {Name: "includeEvents", Required: false}, {Name: "includeCurrentSigningRequest", Required: false}}, EmbedTokens: []string{"current-signing-request", "events"}}, "reject-outgoing-offer": {Method: "POST", Path: "/workspaces/{workspaceId}/transactions/{transactionId}/reject-outgoing-offer", BodyRef: "OfferActions", ResponseRef: "Transaction", PathArgs: []string{"transactionId"}}, }, "workspace": { "info": {Method: "GET", Path: "/workspaces/{workspaceId}", BodyRef: "", ResponseRef: "Workspace", QueryParams: []HelpQueryParam{{Name: "workspaceIds", Required: false}, {Name: "includeSettings", Required: false}, {Name: "limit", Required: false}, {Name: "offset", Required: false}}, EmbedTokens: []string{"settings"}}, }, }
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", "networkId", "origin", "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 ¶
ClientProvider builds a configured client on demand.
type HelpQueryParam ¶
type TxShortcut ¶
Click to show internal directories.
Click to hide internal directories.